com.luciad.imaging

LuciadLightspeedClass TLcdBandMeasurementSemanticsBuilder

java.lang.Object

com.luciad.imaging.TLcdBandMeasurementSemanticsBuilder

public class TLcdBandMeasurementSemanticsBuilder
extends Object

Builder for creating ALcdBandMeasurementSemantics instances. To build a new instance the unit of measure and the data type must be set on this builder. Other properties are optional, they will get a default value based on the unit of measure and data type that were set.

Example usage:

To create semantics representing unsigned short values in metres:

   ALcdBandMeasurementSemantics semantics = TLcdBandMeasurementSemanticsBuilder
   .newBuilder()
   .unitOfMeasure(
     TLcdUnitOfMeasureFactory.deriveUnitOfMeasure(
       TLcdAltitudeUnit.METRE,
       TLcdISO19103MeasureTypeCodeExtension.TERRAIN_HEIGHT
     )
   )
   .dataType(ALcdBandSemantics.DataType.UNSIGNED_SHORT)
   .build();
 

Since:

2015.0

Method Summary

Modifier and Type	Method and Description
TLcdBandMeasurementSemanticsBuilder	all(ALcdBandSemantics aSemantics) Sets all parameters on the builder based on the given semantics.
ALcdBandMeasurementSemantics	build() Builds a semantics for an image measurement band with the currently defined properties.
TLcdBandMeasurementSemanticsBuilder	dataType(ALcdBandSemantics.DataType aDataType) Set the data type.
TLcdBandMeasurementSemanticsBuilder	maxValue(Number aMaxValue) Set the maximum allowed value, can be null.
TLcdBandMeasurementSemanticsBuilder	minValue(Number aMinValue) Set the minimum allowed value, can be null.
static TLcdBandMeasurementSemanticsBuilder	newBuilder() Create a new measurement semantics builder.
TLcdBandMeasurementSemanticsBuilder	noDataValue(Number aNoDataValue) Set the 'no data' value, can be null.
TLcdBandMeasurementSemanticsBuilder	normalized(boolean aNormalized) Set if the band is normalized.
TLcdBandMeasurementSemanticsBuilder	normalizedRangeMaxValue(Number aNormalizedRangeMaxValue) Set the maximum value of the normalized range.
TLcdBandMeasurementSemanticsBuilder	normalizedRangeMinValue(Number aNormalizedRangeMinValue) Set the minimum value of the normalized range.
TLcdBandMeasurementSemanticsBuilder	significantBits(int aNumSignificantBits) Set the number of significant bits.
TLcdBandMeasurementSemanticsBuilder	unitOfMeasure(ILcdISO19103UnitOfMeasure aUnitOfMeasure) Set the unit-of-measure.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static TLcdBandMeasurementSemanticsBuilder newBuilder()

Create a new measurement semantics builder.

Returns:

a new builder instance

build

public ALcdBandMeasurementSemantics build()

Builds a semantics for an image measurement band with the currently defined properties.

Returns:

the band measurement semantics

unitOfMeasure

public TLcdBandMeasurementSemanticsBuilder unitOfMeasure(ILcdISO19103UnitOfMeasure aUnitOfMeasure)

Set the unit-of-measure.

You can obtain instance using TLcdUnitOfMeasureFactory or by using the constants defined on implementations of ILcdISO19103UnitOfMeasure. For terrain height you should use a unit with measure type TLcdISO19103MeasureTypeCodeExtension.TERRAIN_HEIGHT. For example for terrain height in meters this would become:

   builder.unitOfMeasure(
     TLcdUnitOfMeasureFactory.deriveUnitOfMeasure(
       TLcdAltitudeUnit.METRE,
       TLcdISO19103MeasureTypeCodeExtension.TERRAIN_HEIGHT
     )
   );
 

Parameters:

aUnitOfMeasure - the unit-of-measure

Returns:

this builder

See Also:

ALcdBandMeasurementSemantics.getUnitOfMeasure(), TLcdUnitOfMeasureFactory

dataType

public TLcdBandMeasurementSemanticsBuilder dataType(ALcdBandSemantics.DataType aDataType)

Set the data type.

Parameters:

aDataType - the data type

Returns:

this builder

See Also:

ALcdBandSemantics.getDataType()

significantBits

public TLcdBandMeasurementSemanticsBuilder significantBits(int aNumSignificantBits)

Set the number of significant bits.

By default the size in bits of the data type.

Parameters:

aNumSignificantBits - the number of significant bits

Returns:

this builder

See Also:

ALcdBandSemantics.getNumSignificantBits()

noDataValue

public TLcdBandMeasurementSemanticsBuilder noDataValue(Number aNoDataValue)

Set the 'no data' value, can be null.

Parameters:

aNoDataValue - the 'no data' value

Returns:

this builder

See Also:

ALcdBandSemantics.getNoDataValue()

minValue

public TLcdBandMeasurementSemanticsBuilder minValue(Number aMinValue)

Set the minimum allowed value, can be null.

Parameters:

aMinValue - the minimum allowed value

Returns:

this builder

See Also:

ALcdBandSemantics.getMinValue()

maxValue

public TLcdBandMeasurementSemanticsBuilder maxValue(Number aMaxValue)

Set the maximum allowed value, can be null.

Parameters:

aMaxValue - the maximum allowed value

Returns:

this builder

See Also:

ALcdBandSemantics.getMaxValue()

normalized

public TLcdBandMeasurementSemanticsBuilder normalized(boolean aNormalized)

Set if the band is normalized.

The default is true.

Parameters:

aNormalized - true if the band is normalized

Returns:

this builder

See Also:

ALcdBandSemantics.isNormalized()

normalizedRangeMinValue

public TLcdBandMeasurementSemanticsBuilder normalizedRangeMinValue(Number aNormalizedRangeMinValue)

Set the minimum value of the normalized range.

By default the minimum value of the data type.

Parameters:

aNormalizedRangeMinValue - the minimum value of the normalized range

Returns:

this builder

See Also:

ALcdBandSemantics.getNormalizedRangeMinValue()

normalizedRangeMaxValue

public TLcdBandMeasurementSemanticsBuilder normalizedRangeMaxValue(Number aNormalizedRangeMaxValue)

Set the maximum value of the normalized range.

By default the maximum value of the data type.

Parameters:

aNormalizedRangeMaxValue - the maximum value of the normalized range

Returns:

this builder

See Also:

ALcdBandSemantics.getNormalizedRangeMaxValue()

all

public TLcdBandMeasurementSemanticsBuilder 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