ColorUtil (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.util.ColorUtil

```
public final class ColorUtil
extends Object
```
ColorUtil contains useful color table functions.

Field Summary

Fields
Modifier and Type	Field and Description
`static RealType`	`CLEAR` RealType for indicating nothing mapped to a color component.
`static int`	`COLOR_DETAIL` Resolution of color tables.
`static int`	`COMPOSITE_MODEL` Composite RGB color space model.
`static int`	`CONSTANT_ALPHA` Constant alpha value transparency model.
`static int`	`CURVED_ALPHA` Polynomial alpha curve transparency model.
`static int`	`HSV_MODEL` HSV color space model.
`protected static float[]`	`LINEAR` Linear color table component used in several presets.
`static float[][]`	`LUT_BLUE` Blue color look-up table.
`static float[][]`	`LUT_CYAN` Cyan color look-up table.
`static float[][]`	`LUT_FIRE` Fire color look-up table.
`static float[][]`	`LUT_GRAY` Grayscale color look-up table.
`static float[][]`	`LUT_GREEN` Green color look-up table.
`static float[][]`	`LUT_HSV` HSV color look-up table.
`static float[][]`	`LUT_ICE` Ice color look-up table.
`protected static int`	`LUT_LEN` Color table file length.
`static float[][]`	`LUT_MAGENTA` Magenta color look-up table.
`static float[][]`	`LUT_RED` Red color look-up table.
`static float[][]`	`LUT_RGB` RGB (pseudocolor) color look-up table.
`static float[][]`	`LUT_YELLOW` Yellow color look-up table.
`static int`	`MAX_POWER` Maximum alpha exponent for polynomial transparency curve.
`static int`	`RGB_MODEL` RGB color space model.
`static RealType`	`SOLID` RealType for indicating uniformly solid color component.
`protected static float[]`	`ZEROED` Zeroed out color table componented used in several presets.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static float[][]`	`adjustColorTable(float[][] table, float[] alpha, boolean doAlpha)` Ensures the color table is of the proper type (RGB or RGBA).
`static String`	`colorToHex(Color color)` Gets a hexidecimal representation for this color.
`static float[]`	`computeAlphaTable(int opacity, int model)` Computes alpha table component from the given transparency settings.
`static float[][][]`	`computeColorTables(ScalarMap[] maps, int brightness, int contrast, int model, RealType red, RealType green, RealType blue)` Computes color tables from the given color settings.
`static Color`	`hexToColor(String hex)` Gets the corresponding Color object for this hexidecimal string.
`static float[][]`	`loadColorTable(File file)` Loads the color table from the given file.
`static void`	`reAutoScale(DisplayImpl display, ScalarMap map)` Recomputes autoscaled color bounds for the given color map.
`static boolean`	`saveColorTable(float[][] table, File file)` Saves the given color table into the specified file.
`static void`	`setAlphaTable(ScalarMap[] maps, float[] alpha)` Assigns the given alpha channel to the specified mappings.
`static void`	`setColorMode(DisplayImpl display, int model)` Sets the given display's color mode to use either averaging or sums, depending on the specified color model.
`static void`	`setColorRange(DisplayImpl display, ScalarMap map, double lo, double hi, boolean fixed)` Assigns the given color range to the specified display and mapping.
`static void`	`setColorRanges(DisplayImpl display, ScalarMap[] maps, double[] lo, double[] hi, boolean[] fixed)` Assigns the given color ranges to the specified display and mappings.
`static void`	`setColorTables(ScalarMap[] maps, float[][][] tables)` Assigns the given color tables to the specified mappings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- COLOR_DETAIL
```
public static final int COLOR_DETAIL
```
  Resolution of color tables.
  
  See Also:
  
  Constant Field Values
- MAX_POWER
```
public static final int MAX_POWER
```
  Maximum alpha exponent for polynomial transparency curve.
  
  See Also:
  
  Constant Field Values
- ZEROED
```
protected static final float[] ZEROED
```
  Zeroed out color table componented used in several presets.
- LINEAR
```
protected static final float[] LINEAR
```
  Linear color table component used in several presets.
- LUT_GRAY
```
public static final float[][] LUT_GRAY
```
  Grayscale color look-up table.
- LUT_RED
```
public static final float[][] LUT_RED
```
  Red color look-up table.
- LUT_GREEN
```
public static final float[][] LUT_GREEN
```
  Green color look-up table.
- LUT_BLUE
```
public static final float[][] LUT_BLUE
```
  Blue color look-up table.
- LUT_CYAN
```
public static final float[][] LUT_CYAN
```
  Cyan color look-up table.
- LUT_MAGENTA
```
public static final float[][] LUT_MAGENTA
```
  Magenta color look-up table.
- LUT_YELLOW
```
public static final float[][] LUT_YELLOW
```
  Yellow color look-up table.
- LUT_HSV
```
public static final float[][] LUT_HSV
```
  HSV color look-up table.
- LUT_RGB
```
public static final float[][] LUT_RGB
```
  RGB (pseudocolor) color look-up table.
- LUT_FIRE
```
public static final float[][] LUT_FIRE
```
  Fire color look-up table.
- LUT_ICE
```
public static final float[][] LUT_ICE
```
  Ice color look-up table.
- RGB_MODEL
```
public static final int RGB_MODEL
```
  RGB color space model.
  
  See Also:
  
  Constant Field Values
- HSV_MODEL
```
public static final int HSV_MODEL
```
  HSV color space model.
  
  See Also:
  
  Constant Field Values
- COMPOSITE_MODEL
```
public static final int COMPOSITE_MODEL
```
  Composite RGB color space model.
  
  See Also:
  
  Constant Field Values
- CONSTANT_ALPHA
```
public static final int CONSTANT_ALPHA
```
  Constant alpha value transparency model.
  
  See Also:
  
  Constant Field Values
- CURVED_ALPHA
```
public static final int CURVED_ALPHA
```
  Polynomial alpha curve transparency model.
  
  See Also:
  
  Constant Field Values
- CLEAR
```
public static final RealType CLEAR
```
  RealType for indicating nothing mapped to a color component.
- SOLID
```
public static final RealType SOLID
```
  RealType for indicating uniformly solid color component.
- LUT_LEN
```
protected static final int LUT_LEN
```
  Color table file length.
  
  See Also:
  
  Constant Field Values

Method Detail

computeColorTables

public static float[][][] computeColorTables(ScalarMap[] maps,
                                             int brightness,
                                             int contrast,
                                             int model,
                                             RealType red,
                                             RealType green,
                                             RealType blue)

Computes color tables from the given color settings.

Parameters:: maps - ScalarMaps for which to generate color tables; brightness - Brightness value from 0 to 255.; contrast - Contrast value from 0 to 255.; model - Color space model: RGB_MODEL, HSV_MODEL or COMPOSITE_MODEL; red - RealType to map to red color component; green - RealType to map to green color component; blue - RealType to map to blue color component

computeAlphaTable
```
public static float[] computeAlphaTable(int opacity,
                                        int model)
```
Computes alpha table component from the given transparency settings.

Parameters:

opacity - Level of solidity, from 0 to COLOR_DETAIL

model - Transparency model: CONSTANT_ALPHA or CURVED_ALPHA

setColorRange

public static void setColorRange(DisplayImpl display,
                                 ScalarMap map,
                                 double lo,
                                 double hi,
                                 boolean fixed)

Assigns the given color range to the specified display and mapping.

setColorRanges

public static void setColorRanges(DisplayImpl display,
                                  ScalarMap[] maps,
                                  double[] lo,
                                  double[] hi,
                                  boolean[] fixed)

Assigns the given color ranges to the specified display and mappings.

reAutoScale

public static void reAutoScale(DisplayImpl display,
                               ScalarMap map)

Recomputes autoscaled color bounds for the given color map.

setColorTables

public static void setColorTables(ScalarMap[] maps,
                                  float[][][] tables)

Assigns the given color tables to the specified mappings.

setAlphaTable

public static void setAlphaTable(ScalarMap[] maps,
                                 float[] alpha)

Assigns the given alpha channel to the specified mappings.

adjustColorTable
```
public static float[][] adjustColorTable(float[][] table,
                                         float[] alpha,
                                         boolean doAlpha)
```
Ensures the color table is of the proper type (RGB or RGBA). If the alpha is not required but the table has an alpha channel, a new table is returned with the alpha channel stripped out. If alpha is required but the table does not have an alpha channel, a new table is returned with an alpha channel matching the provided one (or all 1s if the provided alpha channel is null or invalid).

setColorMode
```
public static void setColorMode(DisplayImpl display,
                                int model)
```
Sets the given display's color mode to use either averaging or sums, depending on the specified color model.

loadColorTable
```
public static float[][] loadColorTable(File file)
```
Loads the color table from the given file.

saveColorTable

public static boolean saveColorTable(float[][] table,
                                     File file)

Saves the given color table into the specified file.

Returns:: true if file was saved successfully

colorToHex
```
public static String colorToHex(Color color)
```
Gets a hexidecimal representation for this color.

hexToColor

public static Color hexToColor(String hex)
                        throws NumberFormatException

Gets the corresponding Color object for this hexidecimal string.

Throws:: NumberFormatException

Class ColorUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLOR_DETAIL

MAX_POWER

ZEROED

LINEAR

LUT_GRAY

LUT_RED

LUT_GREEN

LUT_BLUE

LUT_CYAN

LUT_MAGENTA

LUT_YELLOW

LUT_HSV

LUT_RGB

LUT_FIRE

LUT_ICE

RGB_MODEL

HSV_MODEL

COMPOSITE_MODEL

CONSTANT_ALPHA

CURVED_ALPHA

CLEAR

SOLID

LUT_LEN

Method Detail

computeColorTables

computeAlphaTable

setColorRange

setColorRanges

reAutoScale

setColorTables

setAlphaTable

adjustColorTable

setColorMode

loadColorTable

saveColorTable

colorToHex

hexToColor