ucar.unidata.util

Class ColorTable

java.lang.Object

ucar.unidata.util.ColorTable

All Implemented Interfaces:

NamedObject

public class ColorTable
extends java.lang.Object
implements NamedObject

Holds a name and a 2D float array that represents a color table

Author:

IDV development team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColorTable.Breakpoint A class to hold color table breakpoint information

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CATEGORY_ATD_RADAR the Atd-Radar category
static java.lang.String	CATEGORY_BASIC The "Basic" category
static java.lang.String	CATEGORY_MISC The Miscellaneous category
static java.lang.String	CATEGORY_RADAR The Radar category
static java.lang.String	CATEGORY_SATELLITE The Satellite category
static java.lang.String	CATEGORY_SOLID The solid category
static int	IDX_ALPHA Alpha index
static int	IDX_BLUE Blue index
static int	IDX_GREEN Green index
static int	IDX_RED Red index

Constructor Summary

Constructors

Constructor and Description
ColorTable() Default constructor
ColorTable(ColorTable otherTable) Copy constructor
ColorTable(java.lang.String name, java.lang.String category, float[][] table) Create a new ColorTable.
ColorTable(java.lang.String id, java.lang.String name, java.lang.String category, float[][] table) Create a new ColorTable.
ColorTable(java.lang.String id, java.lang.String name, java.lang.String category, float[][] table, boolean tableFlipped) Create a new ColorTable.

Method Summary

Modifier and Type	Method and Description
static float[][]	addAlpha(ColorTable colorTable) Wrapper around addAlpha(float[][]).
static float[][]	addAlpha(float[][] colorTable) Make a color-alpha table for VisAD displays mapped to Display.RGBA; the 4th entry at each level being alpha (1.0) for transparency.
static float[][]	changeTransparency(float[][] colorTable, float alpha) Revise a color-alpha table for VisAD displays mapped to Display.RGBA; the 4th entry at each level (alpha) is reset to input arg alpha
java.lang.String	dataToString() Output the table as a String.
boolean	equalsTable(ColorTable other) See if another color table is equivalent to this one
boolean	getActive() Get the active flag.
float[][]	getAlphaTable() Get the table with alpha.
java.util.ArrayList	getBreakpoints() Get the breakpoints for this table.
java.lang.String	getCategory() Get the table category.
java.util.ArrayList<java.awt.Color>	getColorList() Convert the colorTable into a list of Color-s
java.util.ArrayList<java.awt.Color>	getColorList(boolean includeAlpha) Convert the colorTable into a list of Color-s
float[][]	getColorTable() Get the color table pallette.
java.lang.String	getDescription() Get the table description
java.lang.String	getId() Get the ID of this table
java.lang.String	getName() Get the name of this table.
float[][]	getNonAlphaTable() Get the table without alpha values.
Range	getRange() Get the Range for this color table.
float[]	getScaleFactor() Get the ScaleFactor property.
float[][]	getTable() Get the color table palette Note: this is around for legacy purposes and we will move to a new setTableArray/getTableArray method
ColorTable	init(java.lang.String name, java.lang.String category, java.util.ArrayList colors, java.util.ArrayList scales, java.util.ArrayList breakpoints, Range r) Initialize a color table a new ColorTable.
ColorTable	init(java.lang.String name, java.lang.String category, java.util.ArrayList colors, java.util.ArrayList breakpoints, Range r) Initialize a color table a new ColorTable.
java.lang.String	print() Print the table info
static float[][]	removeAlpha(float[][] colorTable) Remove the alpha values
void	setActive(boolean a) Set the active flag.
void	setBreakpoints(java.util.ArrayList l) Set the breakpoints for this color table.
void	setCategory(java.lang.String category) Set the table category.
void	setDescription(java.lang.String description) Set the table description
void	setId(java.lang.String id) Set the id of this table
void	setName(java.lang.String name) Set the name of this table
void	setRange(Range r) Set the range for this table.
void	setScaleFactor(float[] value) Set the ScaleFactor property.
void	setTable(java.util.ArrayList colors) Set the table with a list of colors
void	setTable(float[][] table) Set the color table palette Note: this is around for legacy purposes and we will move to a new setTableArray/getTableArray method
void	setTableArray(float[][] table) Set the table array
void	setTransparency(float alpha) Set the transparency
java.lang.String	toString() Get a descriptive String for this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

IDX_RED

public static final int IDX_RED

Red index

See Also:

Constant Field Values

IDX_GREEN

public static final int IDX_GREEN

Green index

See Also:

Constant Field Values

IDX_BLUE

public static final int IDX_BLUE

Blue index

See Also:

Constant Field Values

IDX_ALPHA

public static final int IDX_ALPHA

Alpha index

See Also:

Constant Field Values

CATEGORY_BASIC

public static final java.lang.String CATEGORY_BASIC

The "Basic" category

See Also:

Constant Field Values

CATEGORY_MISC

public static final java.lang.String CATEGORY_MISC

The Miscellaneous category

See Also:

Constant Field Values

CATEGORY_SATELLITE

public static final java.lang.String CATEGORY_SATELLITE

The Satellite category

See Also:

Constant Field Values

CATEGORY_RADAR

public static final java.lang.String CATEGORY_RADAR

The Radar category

See Also:

Constant Field Values

CATEGORY_SOLID

public static final java.lang.String CATEGORY_SOLID

The solid category

See Also:

Constant Field Values

CATEGORY_ATD_RADAR

public static final java.lang.String CATEGORY_ATD_RADAR

the Atd-Radar category

See Also:

Constant Field Values

Constructor Detail

ColorTable

public ColorTable(ColorTable otherTable)

Copy constructor

Parameters:

otherTable - other table to copy

ColorTable

public ColorTable()

Default constructor

ColorTable

public ColorTable(java.lang.String name,
                  java.lang.String category,
                  float[][] table)

Create a new ColorTable.

Parameters:

name - name of the table

category - category of the table

table - table values

ColorTable

public ColorTable(java.lang.String id,
                  java.lang.String name,
                  java.lang.String category,
                  float[][] table)

Create a new ColorTable.

Parameters:

id - id of the table

name - name of the table

category - category of the table

table - table values

ColorTable

public ColorTable(java.lang.String id,
                  java.lang.String name,
                  java.lang.String category,
                  float[][] table,
                  boolean tableFlipped)

Create a new ColorTable.

Parameters:

id - id of the table

name - name of the table

category - category of the table

table - table values

tableFlipped - flipped flag

Method Detail

init

public ColorTable init(java.lang.String name,
                       java.lang.String category,
                       java.util.ArrayList colors,
                       java.util.ArrayList breakpoints,
                       Range r)

Initialize a color table a new ColorTable.

Parameters:

name - name of the table

category - category of the table

colors - table colors

breakpoints - breakpoints

r - Range of values

Returns:

filled in ColorTable

init

public ColorTable init(java.lang.String name,
                       java.lang.String category,
                       java.util.ArrayList colors,
                       java.util.ArrayList scales,
                       java.util.ArrayList breakpoints,
                       Range r)

Initialize a color table a new ColorTable.

Parameters:

name - name of the table

category - category of the table

colors - table colors

scales - scale factors

breakpoints - breakpoints

r - Range of values

Returns:

filled in ColorTable

equalsTable

public boolean equalsTable(ColorTable other)

See if another color table is equivalent to this one

Parameters:

other - other table to check

Returns:

true ifthey are equal.

setRange

public void setRange(Range r)

Set the range for this table.

Parameters:

r - range

getRange

public Range getRange()

Get the Range for this color table.

Returns:

the range

setActive

public void setActive(boolean a)

Set the active flag.

Parameters:

a - true for active

getActive

public boolean getActive()

Get the active flag.

Returns:

true if active

setBreakpoints

public void setBreakpoints(java.util.ArrayList l)

Set the breakpoints for this color table.

Parameters:

l - list of breakpoints

getBreakpoints

public java.util.ArrayList getBreakpoints()

Get the breakpoints for this table.

Returns:

the breakpoints

getNonAlphaTable

public float[][] getNonAlphaTable()

Get the table without alpha values.

Returns:

table with alpha removed.

getAlphaTable

public float[][] getAlphaTable()

Get the table with alpha.

Returns:

the alpha table

getColorTable

public float[][] getColorTable()

Get the color table pallette. This applies any scale factor.

Returns:

the table of values

setTable

public void setTable(float[][] table)

Set the color table palette Note: this is around for legacy purposes and we will move to a new setTableArray/getTableArray method

Parameters:

table - table of values

getTable

public float[][] getTable()

Get the color table palette Note: this is around for legacy purposes and we will move to a new setTableArray/getTableArray method

Returns:

get the color table as a float array

setTableArray

public void setTableArray(float[][] table)

Set the table array

Parameters:

table - the table as a float array

getName

public java.lang.String getName()

Get the name of this table.

Specified by:

getName in interface NamedObject

Returns:

the name of this table

setName

public void setName(java.lang.String name)

Set the name of this table

Specified by:

setName in interface NamedObject

Parameters:

name - the new name

getId

public java.lang.String getId()

Get the ID of this table

Returns:

the id

setId

public void setId(java.lang.String id)

Set the id of this table

Parameters:

id - the table id

getDescription

public java.lang.String getDescription()

Get the table description

Specified by:

getDescription in interface NamedObject

Returns:

the table description

setDescription

public void setDescription(java.lang.String description)

Set the table description

Parameters:

description - the table description

getCategory

public java.lang.String getCategory()

Get the table category.

Returns:

the table category

setCategory

public void setCategory(java.lang.String category)

Set the table category.

Parameters:

category - the new category

dataToString

public java.lang.String dataToString()

Output the table as a String.

Returns:

the table values as a string.

print

public java.lang.String print()

Print the table info

Returns:

the table info

toString

public java.lang.String toString()

Get a descriptive String for this object.

Overrides:

toString in class java.lang.Object

Returns:

a descriptive String for this object.

setTable

public void setTable(java.util.ArrayList colors)

Set the table with a list of colors

Parameters:

colors - list of colors

getColorList

public java.util.ArrayList<java.awt.Color> getColorList()

Convert the colorTable into a list of Color-s

Returns:

list of colors

getColorList

public java.util.ArrayList<java.awt.Color> getColorList(boolean includeAlpha)

Convert the colorTable into a list of Color-s

Parameters:

includeAlpha - true to use alpha

Returns:

list of colors

addAlpha

public static final float[][] addAlpha(ColorTable colorTable)

Wrapper around addAlpha(float[][]).

Parameters:

colorTable - color table to use

Returns:

color table values

removeAlpha

public static final float[][] removeAlpha(float[][] colorTable)

Remove the alpha values

Parameters:

colorTable - color table values

Returns:

color table values without alpha

addAlpha

public static final float[][] addAlpha(float[][] colorTable)

Make a color-alpha table for VisAD displays mapped to Display.RGBA; the 4th entry at each level being alpha (1.0) for transparency.

Parameters:

colorTable - a float [3][len], any usual VisAd color table

Returns:

float[4][len] the color table

setTransparency

public void setTransparency(float alpha)

Set the transparency

Parameters:

alpha - the alpha value

changeTransparency

public static final float[][] changeTransparency(float[][] colorTable,
                                                 float alpha)

Revise a color-alpha table for VisAD displays mapped to Display.RGBA; the 4th entry at each level (alpha) is reset to input arg alpha

Parameters:

colorTable - a float [4][len], a VisAd color-alpha table

alpha - the new alpha value

Returns:

float[4][len] the revised color table: same colors; new alpha

setScaleFactor

public void setScaleFactor(float[] value)

Set the ScaleFactor property.

Parameters:

value - The new value for ScaleFactor

getScaleFactor

public float[] getScaleFactor()

Get the ScaleFactor property.

Returns:

The ScaleFactor