icy.image.colormodel

Class IcyColorModel

java.lang.Object

java.awt.image.ColorModel

icy.image.colormodel.IcyColorModel

All Implemented Interfaces:

ChangeListener, IcyColorSpaceListener, ScalerListener, java.awt.Transparency, java.util.EventListener

Direct Known Subclasses:

ByteColorModel, DoubleColorModel, FloatColorModel, IntColorModel, LongColorModel, ShortColorModel, UByteColorModel, UIntColorModel, ULongColorModel, UShortColorModel

public abstract class IcyColorModel
extends java.awt.image.ColorModel
implements ScalerListener, IcyColorSpaceListener, ChangeListener

Author:

stephane

Field Summary

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(IcyColorModelListener listener) Add a listener
void	beginUpdate()
java.awt.image.ColorModel	coerceData(java.awt.image.WritableRaster raster, boolean isAlphaPremultiplied)
void	colorSpaceChanged(IcyColorSpaceEvent e)
void	copyBounds(IcyColorModel source) Deprecated. Use setBounds(IcyColorModel) instead.
void	copyColormap(java.awt.image.ColorModel source) Deprecated. Use setColorMaps(ColorModel) instead.
java.awt.image.SampleModel	createCompatibleSampleModel(int w, int h)
static java.awt.image.BandedSampleModel	createCompatibleSampleModel(int transferType, int w, int h, int numComponent)
java.awt.image.WritableRaster	createCompatibleWritableRaster(int w, int h)
static IcyColorModel	createInstance() Create default ColorModel : 4 components, unsigned byte data type
static IcyColorModel	createInstance(IcyColorModel colorModel, boolean copyColormap, boolean copyBounds) Creates a new ColorModel from a given icyColorModel
static IcyColorModel	createInstance(int numComponents, DataType dataType) Creates a new ColorModel with the given color component and image data type
static IcyColorModel	createInstance(int numComponents, int dataType, boolean signed) Deprecated. use createInstance(int, DataType) instead
java.awt.image.WritableRaster	createWritableRaster(java.lang.Object[] data, int w, int h) Create a writable raster from specified data and size.
static java.awt.image.WritableRaster	createWritableRaster(java.lang.Object data, int w, int h) Create a writable raster from specified data and size.
void	endUpdate()
boolean	equals(java.lang.Object obj) Tests if the specified Object is an instance of ColorModel and if it equals this ColorModel.
void	fireEvent(IcyColorModelEvent e) fire event
int	getAlpha(int pixel)
int	getAlpha(java.lang.Object pixel)
int	getBlue(int pixel)
int	getBlue(java.lang.Object pixel)
IcyColorMap	getColormap(int component) Deprecated. Use getColorMap(int) instead (different case).
IcyColorMap	getColorMap(int component) Return the toRGB colormap of specified RGB component
Scaler[]	getColormapScalers()
double[]	getComponentAbsBounds(int component) Get component absolute bounds (min and max values)
double	getComponentAbsMaxValue(int component) Get component absolute maximum value
double	getComponentAbsMinValue(int component) Get component absolute minimum value
int[]	getComponents(int pixel, int[] components, int offset)
abstract int[]	getComponents(java.lang.Object pixel, int[] components, int offset)
double[]	getComponentUserBounds(int component) Get component user bounds (min and max values)
double	getComponentUserMaxValue(int component) Get user component user maximum value
double	getComponentUserMinValue(int component) Get component user minimum value
int	getDataElement(float[] normComponents, int normOffset)
int	getDataElement(int[] components, int offset)
abstract java.lang.Object	getDataElements(float[] normComponents, int normOffset, java.lang.Object obj)
abstract java.lang.Object	getDataElements(int[] components, int offset, java.lang.Object obj)
java.lang.Object	getDataElements(int rgb, java.lang.Object pixel)
DataType	getDataType_() Return data type for this colormodel
int	getDataType() Deprecated. use getDataType_() instead
double[]	getDefaultComponentBounds() return default component bounds for this colormodel
int	getGreen(int pixel)
int	getGreen(java.lang.Object pixel)
IcyColorSpace	getIcyColorSpace()
float[]	getNormalizedComponents(int[] components, int offset, float[] normComponents, int normOffset)
abstract float[]	getNormalizedComponents(java.lang.Object pixel, float[] normComponents, int normOffset)
Scaler[]	getNormalScalers()
int	getNumComponents() Returns the number of components in this ColorModel.
int	getRed(int pixel)
int	getRed(java.lang.Object pixel)
abstract int	getRGB(java.lang.Object inData)
abstract int	getRGB(java.lang.Object pixel, LUT lut)
int[]	getUnnormalizedComponents(float[] normComponents, int normOffset, int[] components, int offset)
boolean	hasLinearColormaps() Return true if color maps associated to this IcyColorModel are all linear map.
boolean	isCompatible(IcyColorModel cm)
boolean	isCompatibleRaster(java.awt.image.Raster raster)
boolean	isCompatibleSampleModel(java.awt.image.SampleModel sm)
boolean	isFloatDataType() Return true if colorModel is float data type
boolean	isSignedDataType() Return true if colorModel data type is signed
boolean	isUpdating()
void	onChanged(CollapsibleEvent compare) process on colormodel change
void	removeListener(IcyColorModelListener listener) Remove a listener
void	scalerChanged(ScalerEvent e)
void	setBounds(IcyColorModel source) Set bounds from specified IcyColorModel
void	setColormap(int component, IcyColorMap map) Deprecated. Use setColorMap(int, IcyColorMap, boolean) instead.
void	setColorMap(int component, IcyColorMap map, boolean setAlpha) Set the toRGB colormap of specified component (actually copy the content).
void	setColormaps(java.awt.image.ColorModel source) Deprecated. Use setColorMaps(ColorModel) instead (different case).
void	setColorMaps(java.awt.image.ColorModel source) Set the toRGB colormaps from a compatible colorModel.
void	setColorSpace(IcyColorSpace colorSpace) Change the colorspace of the color model.
void	setComponentAbsBounds(int component, double[] bounds) Set component absolute bounds (min and max values)
void	setComponentAbsBounds(int component, double min, double max) Set component absolute bounds (min and max values)
void	setComponentAbsMaxValue(int component, double max) Set component absolute maximum value
void	setComponentAbsMinValue(int component, double min) Set component absolute minimum value
void	setComponentsAbsBounds(double[][] bounds) Set components absolute bounds (min and max values)
void	setComponentsUserBounds(double[][] bounds) Set components user bounds (min and max values)
void	setComponentUserBounds(int component, double[] bounds) Set component user bounds (min and max values)
void	setComponentUserBounds(int component, double min, double max) Set component user bounds (min and max values)
void	setComponentUserMaxValue(int component, double max) Set component user maximum value
void	setComponentUserMinValue(int component, double min) Set component user minimum value
java.lang.String	toString() Returns the String representation of the contents of this ColorModelobject.

Methods inherited from class java.awt.image.ColorModel

finalize, getAlphaRaster, getColorSpace, getComponentSize, getComponentSize, getNumColorComponents, getPixelSize, getRGB, getRGBdefault, getTransferType, getTransparency, hasAlpha, hashCode, isAlphaPremultiplied

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

createInstance

public static IcyColorModel createInstance(int numComponents,
                           DataType dataType)

Creates a new ColorModel with the given color component and image data type

Parameters:

numComponents - number of component

dataType - the type of image data (see DataType)

Returns:

a IcyColorModel object

createInstance

@Deprecated
public static IcyColorModel createInstance(int numComponents,
                                      int dataType,
                                      boolean signed)

Deprecated. use createInstance(int, DataType) instead

createInstance

public static IcyColorModel createInstance(IcyColorModel colorModel,
                           boolean copyColormap,
                           boolean copyBounds)

Creates a new ColorModel from a given icyColorModel

Parameters:

colorModel - icyColorModel

copyColormap - flag to indicate if we want to copy colormaps from the given icyColorModel

copyBounds - flag to indicate if we want to copy bounds from the given icyColorModel

Returns:

a IcyColorModel object

createInstance

public static IcyColorModel createInstance()

Create default ColorModel : 4 components, unsigned byte data type

createCompatibleSampleModel

public static java.awt.image.BandedSampleModel createCompatibleSampleModel(int transferType,
                                                           int w,
                                                           int h,
                                                           int numComponent)

createWritableRaster

public static java.awt.image.WritableRaster createWritableRaster(java.lang.Object data,
                                                 int w,
                                                 int h)

Create a writable raster from specified data and size.
The Object data is internally a 2D array [][]

createCompatibleSampleModel

public java.awt.image.SampleModel createCompatibleSampleModel(int w,
                                                     int h)

Overrides:

createCompatibleSampleModel in class java.awt.image.ColorModel

createCompatibleWritableRaster

public java.awt.image.WritableRaster createCompatibleWritableRaster(int w,
                                                           int h)

Overrides:

createCompatibleWritableRaster in class java.awt.image.ColorModel

createWritableRaster

public java.awt.image.WritableRaster createWritableRaster(java.lang.Object[] data,
                                                 int w,
                                                 int h)

Create a writable raster from specified data and size.

setBounds

public void setBounds(IcyColorModel source)

Set bounds from specified IcyColorModel

copyBounds

@Deprecated
public void copyBounds(IcyColorModel source)

Deprecated. Use setBounds(IcyColorModel) instead.

getColorMap

public IcyColorMap getColorMap(int component)

Return the toRGB colormap of specified RGB component

getColormap

@Deprecated
public IcyColorMap getColormap(int component)

Deprecated. Use getColorMap(int) instead (different case).

setColorMaps

public void setColorMaps(java.awt.image.ColorModel source)

Set the toRGB colormaps from a compatible colorModel.

Parameters:

source - source ColorModel to copy colormap from

setColormaps

@Deprecated
public void setColormaps(java.awt.image.ColorModel source)

Deprecated. Use setColorMaps(ColorModel) instead (different case).

copyColormap

@Deprecated
public void copyColormap(java.awt.image.ColorModel source)

Deprecated. Use setColorMaps(ColorModel) instead.

setColorMap

public void setColorMap(int component,
               IcyColorMap map,
               boolean setAlpha)

Set the toRGB colormap of specified component (actually copy the content).

Parameters:

component - component we want to set the colormap

map - source colormap to copy

setAlpha - also set the alpha information

setColormap

@Deprecated
public void setColormap(int component,
                          IcyColorMap map)

Deprecated. Use setColorMap(int, IcyColorMap, boolean) instead.

getAlpha

public int getAlpha(int pixel)

Specified by:

getAlpha in class java.awt.image.ColorModel

See Also:

ColorModel.getAlpha(int)

getBlue

public int getBlue(int pixel)

Specified by:

getBlue in class java.awt.image.ColorModel

See Also:

ColorModel.getBlue(int)

getGreen

public int getGreen(int pixel)

Specified by:

getGreen in class java.awt.image.ColorModel

See Also:

ColorModel.getGreen(int)

getRed

public int getRed(int pixel)

Specified by:

getRed in class java.awt.image.ColorModel

See Also:

ColorModel.getRed(int)

getRGB

public abstract int getRGB(java.lang.Object inData)

Overrides:

getRGB in class java.awt.image.ColorModel

getRGB

public abstract int getRGB(java.lang.Object pixel,
         LUT lut)

getBlue

public int getBlue(java.lang.Object pixel)

Overrides:

getBlue in class java.awt.image.ColorModel

getGreen

public int getGreen(java.lang.Object pixel)

Overrides:

getGreen in class java.awt.image.ColorModel

getRed

public int getRed(java.lang.Object pixel)

Overrides:

getRed in class java.awt.image.ColorModel

getAlpha

public int getAlpha(java.lang.Object pixel)

Overrides:

getAlpha in class java.awt.image.ColorModel

getComponents

public int[] getComponents(int pixel,
                  int[] components,
                  int offset)

Overrides:

getComponents in class java.awt.image.ColorModel

See Also:

ColorModel.getComponents(int, int[], int)

getComponents

public abstract int[] getComponents(java.lang.Object pixel,
                  int[] components,
                  int offset)

Overrides:

getComponents in class java.awt.image.ColorModel

See Also:

ColorModel.getComponents(Object, int[], int)

getNormalizedComponents

public abstract float[] getNormalizedComponents(java.lang.Object pixel,
                              float[] normComponents,
                              int normOffset)

Overrides:

getNormalizedComponents in class java.awt.image.ColorModel

See Also:

ColorModel.getNormalizedComponents(Object, float[], int)

getNormalizedComponents

public float[] getNormalizedComponents(int[] components,
                              int offset,
                              float[] normComponents,
                              int normOffset)

Overrides:

getNormalizedComponents in class java.awt.image.ColorModel

See Also:

ColorModel.getNormalizedComponents(int[], int, float[], int)

getUnnormalizedComponents

public int[] getUnnormalizedComponents(float[] normComponents,
                              int normOffset,
                              int[] components,
                              int offset)

Overrides:

getUnnormalizedComponents in class java.awt.image.ColorModel

See Also:

ColorModel.getUnnormalizedComponents(float[], int, int[], int)

getDataElement

public int getDataElement(int[] components,
                 int offset)

Overrides:

getDataElement in class java.awt.image.ColorModel

See Also:

ColorModel.getDataElement(int[], int)

getDataElement

public int getDataElement(float[] normComponents,
                 int normOffset)

Overrides:

getDataElement in class java.awt.image.ColorModel

See Also:

ColorModel.getDataElement(float[], int)

getDataElements

public abstract java.lang.Object getDataElements(int[] components,
                               int offset,
                               java.lang.Object obj)

Overrides:

getDataElements in class java.awt.image.ColorModel

See Also:

ColorModel.getDataElements(int[], int, Object)

getDataElements

public java.lang.Object getDataElements(int rgb,
                               java.lang.Object pixel)

Overrides:

getDataElements in class java.awt.image.ColorModel

See Also:

ColorModel.getDataElements(int, Object)

getDataElements

public abstract java.lang.Object getDataElements(float[] normComponents,
                               int normOffset,
                               java.lang.Object obj)

Overrides:

getDataElements in class java.awt.image.ColorModel

See Also:

ColorModel.getDataElements(float[], int, Object)

coerceData

public java.awt.image.ColorModel coerceData(java.awt.image.WritableRaster raster,
                                   boolean isAlphaPremultiplied)

Overrides:

coerceData in class java.awt.image.ColorModel

equals

public boolean equals(java.lang.Object obj)

Tests if the specified Object is an instance of ColorModel and if it equals this ColorModel.

Overrides:

equals in class java.awt.image.ColorModel

Parameters:

obj - the Object to test for equality

Returns:

true if the specified Object is an instance of ColorModel and equals this ColorModel; false otherwise.

isCompatible

public boolean isCompatible(IcyColorModel cm)

isCompatibleRaster

public boolean isCompatibleRaster(java.awt.image.Raster raster)

Overrides:

isCompatibleRaster in class java.awt.image.ColorModel

isCompatibleSampleModel

public boolean isCompatibleSampleModel(java.awt.image.SampleModel sm)

Overrides:

isCompatibleSampleModel in class java.awt.image.ColorModel

getIcyColorSpace

public IcyColorSpace getIcyColorSpace()

Returns:

the IcyColorSpace

setColorSpace

public void setColorSpace(IcyColorSpace colorSpace)

Change the colorspace of the color model.
You should never use this method directly (internal use only)

getNormalScalers

public Scaler[] getNormalScalers()

Returns:

the normalScalers

getColormapScalers

public Scaler[] getColormapScalers()

Returns:

the colormapScalers

getNumComponents

public int getNumComponents()

Returns the number of components in this ColorModel.
Note that alpha is embedded so we always have NumColorComponent = NumComponent

Overrides:

getNumComponents in class java.awt.image.ColorModel

Returns:

the number of components in this ColorModel

getDataType

@Deprecated
public int getDataType()

Deprecated. use getDataType_() instead

getDataType_

public DataType getDataType_()

Return data type for this colormodel

See Also:

DataType

getDefaultComponentBounds

public double[] getDefaultComponentBounds()

return default component bounds for this colormodel

getComponentAbsMinValue

public double getComponentAbsMinValue(int component)

Get component absolute minimum value

getComponentAbsMaxValue

public double getComponentAbsMaxValue(int component)

Get component absolute maximum value

getComponentAbsBounds

public double[] getComponentAbsBounds(int component)

Get component absolute bounds (min and max values)

getComponentUserMinValue

public double getComponentUserMinValue(int component)

Get component user minimum value

getComponentUserMaxValue

public double getComponentUserMaxValue(int component)

Get user component user maximum value

getComponentUserBounds

public double[] getComponentUserBounds(int component)

Get component user bounds (min and max values)

setComponentAbsMinValue

public void setComponentAbsMinValue(int component,
                           double min)

Set component absolute minimum value

setComponentAbsMaxValue

public void setComponentAbsMaxValue(int component,
                           double max)

Set component absolute maximum value

setComponentAbsBounds

public void setComponentAbsBounds(int component,
                         double[] bounds)

Set component absolute bounds (min and max values)

setComponentAbsBounds

public void setComponentAbsBounds(int component,
                         double min,
                         double max)

Set component absolute bounds (min and max values)

setComponentUserMinValue

public void setComponentUserMinValue(int component,
                            double min)

Set component user minimum value

setComponentUserMaxValue

public void setComponentUserMaxValue(int component,
                            double max)

Set component user maximum value

setComponentUserBounds

public void setComponentUserBounds(int component,
                          double[] bounds)

Set component user bounds (min and max values)

setComponentUserBounds

public void setComponentUserBounds(int component,
                          double min,
                          double max)

Set component user bounds (min and max values)

setComponentsAbsBounds

public void setComponentsAbsBounds(double[][] bounds)

Set components absolute bounds (min and max values)

setComponentsUserBounds

public void setComponentsUserBounds(double[][] bounds)

Set components user bounds (min and max values)

isFloatDataType

public boolean isFloatDataType()

Return true if colorModel is float data type

isSignedDataType

public boolean isSignedDataType()

Return true if colorModel data type is signed

hasLinearColormaps

public boolean hasLinearColormaps()

Return true if color maps associated to this IcyColorModel are all linear map.

See Also:

IcyColorMap.isLinear()

toString

public java.lang.String toString()

Returns the String representation of the contents of this ColorModelobject.

Overrides:

toString in class java.awt.image.ColorModel

Returns:

a String representing the contents of this ColorModel object.

addListener

public void addListener(IcyColorModelListener listener)

Add a listener

Parameters:

listener -

removeListener

public void removeListener(IcyColorModelListener listener)

Remove a listener

Parameters:

listener -

fireEvent

public void fireEvent(IcyColorModelEvent e)

fire event

Parameters:

e -

onChanged

public void onChanged(CollapsibleEvent compare)

process on colormodel change

Specified by:

onChanged in interface ChangeListener

scalerChanged

public void scalerChanged(ScalerEvent e)

Specified by:

scalerChanged in interface ScalerListener

colorSpaceChanged

public void colorSpaceChanged(IcyColorSpaceEvent e)

Specified by:

colorSpaceChanged in interface IcyColorSpaceListener

beginUpdate

public void beginUpdate()

endUpdate

public void endUpdate()

isUpdating

public boolean isUpdating()