com.luciad.imaging

LuciadLightspeedClass TLcdBandColorSemanticsBuilder

java.lang.Object

com.luciad.imaging.TLcdBandColorSemanticsBuilder

public class TLcdBandColorSemanticsBuilder
extends Object

Builder for creating ALcdBandColorSemantics instances. This builder can create a list of color semantics for all bands at once, or create one color semantic for a single band. When creating semantics for all bands via buildSemantics() only the configured ColorModel is used during the construction of the semantics. Other configured properties will be ignored, thus only the ColorModel needs to be set in this case.

When creating semantics for a single band via buildSingleBandSemantic() and a ColorModel has been set, than only the ColorModel and the component index are used during the construction of the semantics. If no ColorModel is set, at least the following properties must be set for all ALcdBandColorSemantics.Type except for ALcdBandColorSemantics.Type.ALPHA and ALcdBandColorSemantics.Type.PALETTE_INDEX:

• ALcdBandColorSemantics.Type
• ALcdBandSemantics.DataType
• ColorSpace
• The number of significant bits.
• The component index >= 0

For band type equal to ALcdBandColorSemantics.Type.ALPHA at least the following properties must be configured:

• ALcdBandColorSemantics.Type
• ALcdBandSemantics.DataType
• The number of significant bits.

For band type equal to ALcdBandColorSemantics.Type.PALETTE_INDEX at least the following properties must be configured:

• ALcdBandColorSemantics.Type
• ALcdBandSemantics.DataType
• The palette.

Example usages: Create semantics for all color bands based on a ColorModel:

   List semantics = TLcdBandColorSemanticsBuilder
     .newBuilder()
     .colorModel(cm)
     .buildSemantics();
 

Create semantic for a single RED color band using a ColorModel:

   ALcdBandColorSemantics s = TLcdBandColorSemanticsBuilder
     .newBuilder()
     .colorModel(cm)
     .componentIndex(0)
     .buildSingleBandSemantic();
 

Create semantic for a single RED color band without using a ColorModel:

 ALcdBandColorSemantics s = TLcdBandColorSemanticsBuilder
   .newBuilder()
   .type(ALcdBandColorSemantics.Type.RED)
   .dataType(ALcdBandSemantics.DataType.UNSIGNED_INT)
   .colorSpace(ColorModel.getRGBdefault().getColorSpace())
   .significantBits(16)
   .componentIndex(0)
   .buildSingleBandSemantic();
 

Since:

2015.0

Method Summary

Modifier and Type	Method and Description
TLcdBandColorSemanticsBuilder	all(ALcdBandSemantics aSemantics) Sets all parameters on the builder based on the given semantics.
TLcdBandColorSemanticsBuilder	alphaPremultiplied(boolean aAlphaPremultiplied) Set alpha pre-multiplication.
List<ALcdBandSemantics>	buildSemantics() Build semantics for all bands based on the color model.
ALcdBandColorSemantics	buildSingleBandSemantic() Build semantic for a single band.
TLcdBandColorSemanticsBuilder	colorModel(ColorModel aColorModel) Set the ColorModel on which to base the semantics.
TLcdBandColorSemanticsBuilder	colorSpace(ColorSpace aColorSpace) Set the color space, can be null.
TLcdBandColorSemanticsBuilder	componentIndex(int aComponentIndex) Set the component index.
TLcdBandColorSemanticsBuilder	dataType(ALcdBandSemantics.DataType aDataType) Set the data type.
static TLcdBandColorSemanticsBuilder	newBuilder() Create a band color semantics builder.
TLcdBandColorSemanticsBuilder	noDataValue(Number aNoDataValue) Set the 'no data' value.
TLcdBandColorSemanticsBuilder	normalized(boolean aNormalized) Set if the band is normalized.
TLcdBandColorSemanticsBuilder	normalizedRangeMaxValue(Number aNormalizedRangeMaxValue) Set the maximum value of the normalized range.
TLcdBandColorSemanticsBuilder	normalizedRangeMinValue(Number aNormalizedRangeMinValue) Set the minimum value of the normalized range.
TLcdBandColorSemanticsBuilder	palette(IndexColorModel aPalette) Set the palette, can be null.
TLcdBandColorSemanticsBuilder	significantBits(int aNumSignificantBits) Set the number of significant bits.
TLcdBandColorSemanticsBuilder	type(ALcdBandColorSemantics.Type aType) Set the type of the band.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static TLcdBandColorSemanticsBuilder newBuilder()

Create a band color semantics builder.

Returns:

a new builder instance

buildSingleBandSemantic

public ALcdBandColorSemantics buildSingleBandSemantic()

Build semantic for a single band. If a color model is set on this builder all other parameters, except the color model and component index, will be ignored.

Returns:

the color semantics for a single band

Throws:

IllegalArgumentException - when a combination of parameters set on this builder is invalid

buildSemantics

public List<ALcdBandSemantics> buildSemantics()

Build semantics for all bands based on the color model. To create the semantics the color model must be set on this builder.

Returns:

the list of color semantics

Throws:

IllegalArgumentException - when no valid color model is set

colorModel

public TLcdBandColorSemanticsBuilder colorModel(ColorModel aColorModel)

Set the ColorModel on which to base the semantics.

The following ColorModel's are supported:

• PackedColorModel
• ComponentColorModel
• IndexColorModel

In addition the color space type of the color model must be one of the following:

• ColorSpace.TYPE_GRAY
• ColorSpace.TYPE_RGB

Parameters:

aColorModel - the color model

Returns:

this builder

componentIndex

public TLcdBandColorSemanticsBuilder componentIndex(int aComponentIndex)

Set the component index.

For a alpha or palette index band the component index is -1. For other ALcdBandColorSemantics.Type the component index must be >= 0 and smaller than the number of bands in the ColorSpace.

The default value is -1.

Parameters:

aComponentIndex - the component index

Returns:

this builder

See Also:

ALcdBandColorSemantics.getComponentIndex()

type

public TLcdBandColorSemanticsBuilder type(ALcdBandColorSemantics.Type aType)

Set the type of the band.

Parameters:

aType - the type

Returns:

this builder

See Also:

ALcdBandColorSemantics.getType()

colorSpace

public TLcdBandColorSemanticsBuilder colorSpace(ColorSpace aColorSpace)

Set the color space, can be null.

Default is null.

Parameters:

aColorSpace - the color space or null

Returns:

this builder

See Also:

ALcdBandColorSemantics.getColorSpace()

alphaPremultiplied

public TLcdBandColorSemanticsBuilder alphaPremultiplied(boolean aAlphaPremultiplied)

Set alpha pre-multiplication.

Default is false.

Parameters:

aAlphaPremultiplied - true if alpha is pre-multiplied

Returns:

this builder

See Also:

ALcdBandColorSemantics.isAlphaPremultiplied()

palette

public TLcdBandColorSemanticsBuilder palette(IndexColorModel aPalette)

Set the palette, can be null.

This is only applicable for indexed bands.

Default is null.

Parameters:

aPalette - the palette or null

Returns:

this builder

See Also:

ALcdBandColorSemantics.getPalette()

dataType

public TLcdBandColorSemanticsBuilder dataType(ALcdBandSemantics.DataType aDataType)

Set the data type.

Parameters:

aDataType - the data type

Returns:

this builder

See Also:

ALcdBandSemantics.getDataType()

significantBits

public TLcdBandColorSemanticsBuilder significantBits(int aNumSignificantBits)

Set the number of significant bits.

Parameters:

aNumSignificantBits - the number of significant bits

Returns:

this builder

See Also:

ALcdBandSemantics.getNumSignificantBits()

noDataValue

public TLcdBandColorSemanticsBuilder noDataValue(Number aNoDataValue)

Set the 'no data' value.

Parameters:

aNoDataValue - the 'no data' value

Returns:

this builder

See Also:

ALcdBandSemantics.getNoDataValue()

normalized

public TLcdBandColorSemanticsBuilder normalized(boolean aNormalized)

Set if the band is normalized.

Typically this is false except for bands of type ALcdBandColorSemantics.Type.PALETTE_INDEX or bands with a floating point data type.

The default is false.

Parameters:

aNormalized - true if the band is normalized

Returns:

this builder

See Also:

ALcdBandSemantics.isNormalized()

normalizedRangeMinValue

public TLcdBandColorSemanticsBuilder normalizedRangeMinValue(Number aNormalizedRangeMinValue)

Set the minimum value of the normalized range.

Typically this should be the values from the color space. This is 0.0 in most cases.

By default the normalized range is based on the data type if the band is normalized or otherwise on the color space.

Parameters:

aNormalizedRangeMinValue - the minimum value of the normalized range

Returns:

this builder

See Also:

ALcdBandSemantics.getNormalizedRangeMinValue()

normalizedRangeMaxValue

public TLcdBandColorSemanticsBuilder normalizedRangeMaxValue(Number aNormalizedRangeMaxValue)

Set the maximum value of the normalized range.

Typically this should be the values from the color space. This is 1.0 in most cases.

By default the normalized range is based on the data type if the band is normalized or otherwise on the color space.

Parameters:

aNormalizedRangeMaxValue - the maximum value of the normalized range

Returns:

this builder

See Also:

ALcdBandSemantics.getNormalizedRangeMaxValue()

all

public TLcdBandColorSemanticsBuilder all(ALcdBandSemantics aSemantics)

Sets all parameters on the builder based on the given semantics.

This is useful for example to create a new semantics that has almost all properties equal to another semantics.

Parameters:

aSemantics - the semantics to copy

Returns:

this