# Uses of Class
org.apache.sis.coverage.SampleDimension.Builder

Packages that use SampleDimension.Builder
Package
Description
org.apache.sis.coverage
Functions that associates positions within a bounded space (its domain) to values (its range).
org.apache.sis.coverage.grid
A coverage backed by a regular grid.
org.apache.sis.storage.modifier
A plugin mechanism for modifying some aspects of the resources read by data stores.

- ## Uses of SampleDimension.Builder in org.apache.sis.coverage

  Methods in org.apache.sis.coverage that return SampleDimension.Builder
  Modifier and Type
  Method
  Description
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, boolean sample)`
  Adds a qualitative category for samples of the given boolean value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, byte sample)`
  Adds a qualitative category for samples of the given tiny (8 bits) integer value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, double sample)`
  Adds a qualitative category for samples of the given double precision floating-point value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, float sample)`
  Adds a qualitative category for samples of the given floating-point value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, int sample)`
  Adds a qualitative category for samples of the given integer value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, short sample)`
  Adds a qualitative category for samples of the given short (16 bits) integer value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, Number minimum, Number maximum)`
  Adds a qualitative category for samples in the given range of values.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQualitative(CharSequence name, NumberRange<?> samples)`
  Adds a qualitative category for all samples in the specified range of values.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQuantitative(CharSequence name, double minimum, double maximum, Unit<?> units)`
  Adds a quantitative category for values ranging from `minimum` to `maximum` inclusive in the given units of measurement.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQuantitative(CharSequence name, float minimum, float maximum, Unit<?> units)`
  Adds a quantitative category for values ranging from `minimum` to `maximum` inclusive in the given units of measurement.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQuantitative(CharSequence name, int lower, int upper, double scale, double offset, Unit<?> units)`
  Adds a quantitative category for sample values ranging from `lower` inclusive to `upper` exclusive.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQuantitative(CharSequence name, NumberRange<?> samples, NumberRange<?> converted)`
  Constructs a quantitative category mapping samples to real values in the specified range.
  `SampleDimension.Builder`
  SampleDimension.Builder.`addQuantitative(CharSequence name, NumberRange<?> samples, MathTransform1D toUnits, Unit<?> units)`
  Constructs a quantitative category for all samples in the specified range of values.
  `SampleDimension.Builder`
  SampleDimension.Builder.`mapQualitative(CharSequence name, Number sample, float converted)`
  Adds a qualitative category for the given sample value mapped to the specified converted NaN value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`mapQualitative(CharSequence name, NumberRange<?> samples, float converted)`
  Adds a qualitative category for the given samples values mapped to the specified converted NaN value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`setBackground(CharSequence name, Number sample)`
  Adds a qualitative category and marks that category as the background value.
  `SampleDimension.Builder`
  SampleDimension.Builder.`setBackground(Number sample)`
  Sets the background value without creating a category (typically for RGB images).
  `SampleDimension.Builder`
  SampleDimension.Builder.`setName(int band)`
  Sets an identification of the sample dimension as a band number.
  `SampleDimension.Builder`
  SampleDimension.Builder.`setName(CharSequence name)`
  Sets an identification of the sample dimension as a character sequence.
  `SampleDimension.Builder`
  SampleDimension.Builder.`setName(GenericName name)`
  Sets an identification of the sample dimension.

- ## Uses of SampleDimension.Builder in org.apache.sis.coverage.grid

  Method parameters in org.apache.sis.coverage.grid with type arguments of type SampleDimension.Builder
  Modifier and Type
  Method
  Description
  `GridCoverage`
  GridCoverageProcessor.`convert(GridCoverage source, MathTransform1D[] converters, Function<SampleDimension.Builder, SampleDimension> sampleDimensionModifier)`
  Returns a coverage with sample values converted by the given functions.

- ## Uses of SampleDimension.Builder in org.apache.sis.storage.modifier

  Methods in org.apache.sis.storage.modifier with parameters of type SampleDimension.Builder
  Modifier and Type
  Method
  Description
  `default SampleDimension`
  CoverageModifier.`customize(CoverageModifier.BandSource source, SampleDimension.Builder dimension)`
  Invoked when a sample dimension is created in a coverage.