icy.image.colormap

Class IcyColorMapComponent

java.lang.Object

icy.image.colormap.IcyColorMapComponent

All Implemented Interfaces:

XMLPersistent

Direct Known Subclasses:

IcyColorMapBand

public class IcyColorMapComponent
extends java.lang.Object
implements XMLPersistent

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IcyColorMapComponent.ControlPoint

Field Summary

Fields

Modifier and Type	Field and Description
short[]	map we use short to store byte to avoid "sign problem"
float[]	mapf normalized maps

Constructor Summary

Constructors

Constructor and Description
IcyColorMapComponent(IcyColorMap colorMap)
IcyColorMapComponent(IcyColorMap colorMap, short initValue)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	asByteArray() Returns colormap content as an array of byte (length = IcyColorMap.SIZE).
void	beginUpdate()
void	controlPointAdded(IcyColorMapComponent.ControlPoint controlPoint) Called when a control point has been added
void	controlPointChanged(IcyColorMapComponent.ControlPoint controlPoint) Called when a control point has been modified
void	controlPointRemoved(IcyColorMapComponent.ControlPoint controlPoint) Called when a control point has been removed
void	controlPointsChanged() called when the controller modified Control Point list
void	copyFrom(byte[] src) Copy data from specified byte array
void	copyFrom(IcyColorMapComponent source) Copy data from specified source colormap band
void	copyFrom(short[] src, int shift) Copy data from specified short array.
void	endUpdate()
boolean	equals(java.lang.Object obj)
IcyColorMapComponent.ControlPoint	getControlPoint(int index) get the control point
int	getControlPointCount()
java.util.ArrayList<IcyColorMapComponent.ControlPoint>	getControlPoints()
IcyColorMapComponent.ControlPoint	getControlPointWithIndex(int index, boolean create) get the control point at specified index (return null if not found)
short	getIntensity(int index) Deprecated. Use getValue(int) instead.
short	getValue(int index) Return value for specified index
boolean	hasControlPointWithIndex(int index) Return true if there is a control point at specified index
int	hashCode()
boolean	isAllOne() Return true is the color map band is all set to one.
boolean	isAllSame() Return true is the color map band is all set to a fixed value.
boolean	isAllZero() Return true is the color map band is all set to zero.
boolean	isLinear() Return true is the color map band is a linear one.
boolean	isRawData() returns true when the LUT is specified by raw data (for example GIF files), false when the LUT is specified by control points.
boolean	isUpdating()
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
void	mapDataChanged() called when the controller directly modified the map (int) data
void	mapFDataChanged() called when the controller directly modified the map (float) data
void	onControlPointsChanged() common process on Control Point list change
void	onMapDataChanged() common process on map (int) data change
void	onMapFDataChanged() common process on map (float) data change
void	removeAllControlPoint() Remove all control point
void	removeControlPoint(IcyColorMapComponent.ControlPoint controlPoint) Remove the specified control point
boolean	saveToXML(org.w3c.dom.Node node) SAVE
IcyColorMapComponent.ControlPoint	setControlPoint(int index, float value) Set a control point to specified index and value (normalized)
IcyColorMapComponent.ControlPoint	setControlPoint(int index, int value) Set a control point to specified index and value
void	setNormalizedValue(int index, float value) Set direct intensity (normalized) value to specified index
void	setValue(int index, int value) Set direct intensity value to specified index

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

map

public final short[] map

we use short to store byte to avoid "sign problem"

mapf

public final float[] mapf

normalized maps

Constructor Detail

IcyColorMapComponent

public IcyColorMapComponent(IcyColorMap colorMap,
                    short initValue)

IcyColorMapComponent

public IcyColorMapComponent(IcyColorMap colorMap)

Method Detail

getControlPointCount

public int getControlPointCount()

getControlPoints

public java.util.ArrayList<IcyColorMapComponent.ControlPoint> getControlPoints()

getControlPoint

public IcyColorMapComponent.ControlPoint getControlPoint(int index)

get the control point

getControlPointWithIndex

public IcyColorMapComponent.ControlPoint getControlPointWithIndex(int index,
                                                         boolean create)

get the control point at specified index (return null if not found)

hasControlPointWithIndex

public boolean hasControlPointWithIndex(int index)

Return true if there is a control point at specified index

setControlPoint

public IcyColorMapComponent.ControlPoint setControlPoint(int index,
                                                float value)

Set a control point to specified index and value (normalized)

setControlPoint

public IcyColorMapComponent.ControlPoint setControlPoint(int index,
                                                int value)

Set a control point to specified index and value

removeControlPoint

public void removeControlPoint(IcyColorMapComponent.ControlPoint controlPoint)

Remove the specified control point

Parameters:

controlPoint -

removeAllControlPoint

public void removeAllControlPoint()

Remove all control point

copyFrom

public void copyFrom(IcyColorMapComponent source)

Copy data from specified source colormap band

copyFrom

public void copyFrom(byte[] src)

Copy data from specified byte array

copyFrom

public void copyFrom(short[] src,
            int shift)

Copy data from specified short array.

Parameters:

src - data short array

shift - shift factor if value need to be shifted (8 if data are short formatted)

asByteArray

public byte[] asByteArray()

Returns colormap content as an array of byte (length = IcyColorMap.SIZE).

getValue

public short getValue(int index)

Return value for specified index

getIntensity

@Deprecated
public short getIntensity(int index)

Deprecated. Use getValue(int) instead.

setValue

public void setValue(int index,
            int value)

Set direct intensity value to specified index

setNormalizedValue

public void setNormalizedValue(int index,
                      float value)

Set direct intensity (normalized) value to specified index

isAllSame

public boolean isAllSame()

Return true is the color map band is all set to a fixed value.

isAllZero

public boolean isAllZero()

Return true is the color map band is all set to zero.

isAllOne

public boolean isAllOne()

Return true is the color map band is all set to one.

isLinear

public boolean isLinear()

Return true is the color map band is a linear one.
Linear map are used to display plain gray or plain color image.
Non linear map means you may have an indexed color image or you want to enhance contrast/color in display.

controlPointChanged

public void controlPointChanged(IcyColorMapComponent.ControlPoint controlPoint)

Called when a control point has been modified

Parameters:

controlPoint - modified control point

controlPointAdded

public void controlPointAdded(IcyColorMapComponent.ControlPoint controlPoint)

Called when a control point has been added

Parameters:

controlPoint - added control point

controlPointRemoved

public void controlPointRemoved(IcyColorMapComponent.ControlPoint controlPoint)

Called when a control point has been removed

Parameters:

controlPoint - removed control point

onControlPointsChanged

public void onControlPointsChanged()

common process on Control Point list change

onMapDataChanged

public void onMapDataChanged()

common process on map (int) data change

onMapFDataChanged

public void onMapFDataChanged()

common process on map (float) data change

controlPointsChanged

public void controlPointsChanged()

called when the controller modified Control Point list

mapDataChanged

public void mapDataChanged()

called when the controller directly modified the map (int) data

mapFDataChanged

public void mapFDataChanged()

called when the controller directly modified the map (float) data

beginUpdate

public void beginUpdate()

endUpdate

public void endUpdate()

isUpdating

public boolean isUpdating()

isRawData

public boolean isRawData()

returns true when the LUT is specified by raw data (for example GIF files), false when the LUT is specified by control points.

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

LOAD

Specified by:

loadFromXML in interface XMLPersistent

saveToXML

public boolean saveToXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

SAVE

Specified by:

saveToXML in interface XMLPersistent

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object