Package org.eclipse.imagen.media.classifier

Class LinearColorMap

Object

AbstractCollection<E>

AbstractList<LinearColorMapElement>

LinearColorMap

All Implemented Interfaces:

Iterable<LinearColorMapElement>, Collection<LinearColorMapElement>, List<LinearColorMapElement>, ColorMapTransform<LinearColorMapElement>, Domain1D<LinearColorMapElement>, PiecewiseTransform1D<LinearColorMapElement>

public final class LinearColorMap
extends AbstractList<LinearColorMapElement>
implements ColorMapTransform<LinearColorMapElement>

ColorMapTransform implementation defining a linear colormap transformation

Author:

Simone Giannecchini, GeoSolutions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LinearColorMap.LinearColorMapType

Constructor Summary

Constructors

Constructor	Description
LinearColorMap(CharSequence name, LinearColorMapElement[] standardElements)	Constructor which creates a LinearColorMap without a NoDataCategory.
LinearColorMap(CharSequence name, LinearColorMapElement[] standardElements, Color defColor)
LinearColorMap(CharSequence name, LinearColorMapElement[] standardElements, LinearColorMapElement[] preFilteringElements, Color defaultColor)
LinearColorMap(String string, LinearColorMapElement[] linearColorMapElements, LinearColorMapElement[] linearColorMapElements2)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
LinearColorMapElement	findDomainElement(double sample)	Returns the DomainElement1D of the specified sample value.
LinearColorMapElement	get(int index)
Range	getApproximateDomainRange()	Returns the range of values in this Domain1D.
IndexColorModel	getColorModel()	Returns a color model for this category list.
double	getDefaultValue()	The default value which will be returned when asked to transform a value outside the valid domain elements.
LinearColorMapElement[]	getDomainElements()
String	getName()	Returns the name of this object.
SampleModel	getSampleModel(int width, int height)	Creates a SampleModel compatible with the underlying ColorModel having the specified width and height.
int	getSourceDimensions()
int	getTargetDimensions()
boolean	hasDefaultValue()	Indicates whether or not this PiecewiseTransform1D has a default value which will be returned when asked to transform a value outside the valid domain elements.
boolean	hasGaps()	Tell us if there is a gap in this Domain1D which means a range where no DomainElement1D is defined.
int	hashCode()
int	size()
double	transform(double value)	Transforms the specified value.
Position	transform(Position ptSrc, Position ptDst)

Methods inherited from class AbstractList

add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, set, subList

Methods inherited from class AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

add, add, addAll, addAll, clear, contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray

Constructor Details

LinearColorMap

public LinearColorMap(CharSequence name,
 LinearColorMapElement[] standardElements)

Constructor which creates a LinearColorMap without a NoDataCategory. Keep in mind that if the list has gaps, if you try to transform a value that falls into a gap you'll get a nice TransformException!

Parameters:

categories - the array of a categories to use for this LinearColorMap.

LinearColorMap

public LinearColorMap(CharSequence name,
 LinearColorMapElement[] standardElements,
 Color defColor)

LinearColorMap

public LinearColorMap(CharSequence name,
 LinearColorMapElement[] standardElements,
 LinearColorMapElement[] preFilteringElements,
 Color defaultColor)

LinearColorMap

public LinearColorMap(String string,
 LinearColorMapElement[] linearColorMapElements,
 LinearColorMapElement[] linearColorMapElements2)

Method Details

getColorModel

public IndexColorModel getColorModel()

Returns a color model for this category list. This method builds up the color model from each category's colors (as returned by #getColors ).

Specified by:

getColorModel in interface ColorMapTransform<LinearColorMapElement>

Parameters:

visibleBand - The band to be made visible (usually 0). All other bands, if any will be ignored.

numBands - The number of bands for the color model (usually 1). The returned color model will renderer only the visibleBand and ignore the others, but the existence of all numBands will be at least tolerated. Supplemental bands, even invisible, are useful for processing with Java Advanced Imaging.

Returns:

The requested color model, suitable for RenderedImage objects with values in the #getRange range.

getSampleModel

public SampleModel getSampleModel(int width,
 int height)

Creates a SampleModel compatible with the underlying ColorModel having the specified width and height.

Specified by:

getSampleModel in interface ColorMapTransform<LinearColorMapElement>

Parameters:

width - represents the width for the final SampleModel

height - represents the height for the final SampleModel

Returns:

get

public LinearColorMapElement get(int index)

Specified by:

get in interface List<LinearColorMapElement>

Specified by:

get in class AbstractList<LinearColorMapElement>

size

public int size()

Specified by:

size in interface Collection<LinearColorMapElement>

Specified by:

size in interface List<LinearColorMapElement>

Specified by:

size in class AbstractCollection<LinearColorMapElement>

getDefaultValue

public double getDefaultValue()

Description copied from interface: PiecewiseTransform1D

The default value which will be returned when asked to transform a value outside the valid domain elements.

In case PiecewiseTransform1D.hasDefaultValue() return false this value has no meaning.

Specified by:

getDefaultValue in interface PiecewiseTransform1D<LinearColorMapElement>

Returns:

The default value which will be returned when asked to transform a value outside the valid domain elements.

hasDefaultValue

public boolean hasDefaultValue()

Description copied from interface: PiecewiseTransform1D

Indicates whether or not this PiecewiseTransform1D has a default value which will be returned when asked to transform a value outside the valid domain elements.

Specified by:

hasDefaultValue in interface PiecewiseTransform1D<LinearColorMapElement>

Returns:

a boolean to indicate whether or not this PiecewiseTransform1D has a default value.

getApproximateDomainRange

public Range getApproximateDomainRange()

Description copied from interface: Domain1D

Returns the range of values in this Domain1D. This is the union of the range of values of every Domain1D.

Specified by:

getApproximateDomainRange in interface Domain1D<LinearColorMapElement>

Returns:

The range of values.

findDomainElement

public LinearColorMapElement findDomainElement(double sample)

Description copied from interface: Domain1D

Returns the DomainElement1D of the specified sample value. If no DomainElement1D fits, then this method returns null.

Specified by:

findDomainElement in interface Domain1D<LinearColorMapElement>

Parameters:

sample - The value.

Returns:

The domain element of the supplied value, or null.

getDomainElements

public LinearColorMapElement[] getDomainElements()

getName

public String getName()

Description copied from interface: Domain1D

Returns the name of this object. The default implementation returns the name of what seems to be the "main" domain element (i.e. the domain element with the widest range of values).

Specified by:

getName in interface Domain1D<LinearColorMapElement>

Returns:

hasGaps

public boolean hasGaps()

Description copied from interface: Domain1D

Tell us if there is a gap in this Domain1D which means a range where no DomainElement1D is defined.

Specified by:

hasGaps in interface Domain1D<LinearColorMapElement>

Returns:

true in case a gap exists, false otherwise.

transform

public double transform(double value)
                 throws TransformationException

Description copied from interface: PiecewiseTransform1D

Transforms the specified value.

Specified by:

transform in interface PiecewiseTransform1D<LinearColorMapElement>

Parameters:

value - The value to transform.

Returns:

the transformed value.

Throws:

TransformationException - if the value can't be transformed.

getSourceDimensions

public int getSourceDimensions()

getTargetDimensions

public int getTargetDimensions()

transform

public Position transform(Position ptSrc,
 Position ptDst)
                   throws TransformationException

Throws:

TransformationException

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<LinearColorMapElement>

Specified by:

equals in interface List<LinearColorMapElement>

Overrides:

equals in class AbstractList<LinearColorMapElement>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<LinearColorMapElement>

Specified by:

hashCode in interface List<LinearColorMapElement>

Overrides:

hashCode in class AbstractList<LinearColorMapElement>