Package org.apache.sis.coverage

Class ConvertedCategory

java.lang.Object

org.apache.sis.coverage.Category

org.apache.sis.coverage.ConvertedCategory

All Implemented Interfaces:

Serializable

final class ConvertedCategory
extends Category

A category of "real values" range. Sample values in this category are equal to real values. By definition, the getTransferFunction() method for this class returns the identity transform, or an empty optional if this category is a qualitative one.

Since:

1.0

Version:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID	Serial number for inter-operability with different versions.

Fields inherited from class org.apache.sis.coverage.Category

COMPARATOR, converse, name, range, toConverse

Constructor Summary

Constructors

Constructor	Description
ConvertedCategory(Category original, org.opengis.referencing.operation.MathTransform1D toSamples, boolean isQuantitative, javax.measure.Unit<?> units)	Creates a category storing the inverse of the "sample to real values" transfer function.

Method Summary

Modifier and Type	Method	Description
(package private) Category	converted()	Returns this since the values represented by ConvertedCategory are already converted.
Category	forConvertedValues(boolean converted)	Returns a category that describes real values or sample values, depending if converted is true or false respectively.
Optional<org.opengis.referencing.operation.MathTransform1D>	getTransferFunction()	Returns the transfer function from sample values to real values in units of measurement.

Methods inherited from class org.apache.sis.coverage.Category

compare, equals, getMeasurementRange, getName, getRangeLabel, getSampleRange, hashCode, identity, isConvertedQualitative, isQuantitative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

Serial number for inter-operability with different versions.

See Also:

• Constant Field Values

Constructor Details

ConvertedCategory

ConvertedCategory(Category original,
 org.opengis.referencing.operation.MathTransform1D toSamples,
 boolean isQuantitative,
 javax.measure.Unit<?> units)
           throws org.opengis.referencing.operation.TransformException

Creates a category storing the inverse of the "sample to real values" transfer function. The Category.toConverse of this category will convert real value in specified units to the sample (packed) value.

Parameters:

original - the category storing the conversion from sample to real value.

toSamples - the "real to sample values" conversion, as the inverse of original.transferFunction. For qualitative category, this function is a constant mapping NaN to the original sample value.

isQuantitative - true if we are construction a quantitative category, or false for qualitative.

units - the units of measurement, or null if not applicable. This is the source units before conversion by toSamples.

Throws:

org.opengis.referencing.operation.TransformException

Method Details

converted

Category converted()

Returns this since the values represented by ConvertedCategory are already converted.

Overrides:

converted in class Category

See Also:

• Category.forConvertedValues(boolean)

forConvertedValues

public Category forConvertedValues(boolean converted)

Returns a category that describes real values or sample values, depending if converted is true or false respectively.

Overrides:

forConvertedValues in class Category

Parameters:

converted - true for a category describing converted values, or false for a category describing packed values.

Returns:

a category describing converted or packed values, depending on converted argument value. May be this but never null.

See Also:

• Category.getMeasurementRange()
• SampleDimension.forConvertedValues(boolean)

getTransferFunction

public Optional<org.opengis.referencing.operation.MathTransform1D> getTransferFunction()

Returns the transfer function from sample values to real values in units of measurement. The function is absent if this category is not a quantitative category.

Overrides:

getTransferFunction in class Category

Returns:

the transfer function from sample values to real values.

See Also:

• SampleDimension.getTransferFunction()