Class CoverageModifier.BandSource

Object

CoverageModifier.Source

BandSource

Enclosing interface:

Coverage­Modifier

public static class CoverageModifier.BandSource
extends CoverageModifier.Source

Information about which sample dimension (band) is subject to modification. Bands are identified by their index, starting at 0 and incremented sequentially.

Since:

1.5

Constructor Summary

Constructors

Constructor	Description
Band­Source(Data­Store store, int coverage­Index, int band­Index, int num­Bands, Data­Type data­Type)	Creates a new source for the specified band.

Method Summary

Modifier and Type	Method	Description
int	get­Band­Index()	Returns the index of the band for which to create sample dimension.
int	get­Num­Bands()	Returns the number of sample dimensions (bands) in the coverage.
Optional<Number­Range<?>>	get­Sample­Range()	Return the minimum and maximum values declared in the coverage metadata, if known.

Methods inherited from class CoverageModifier.Source

get­Coverage­Index, get­Data­Store, get­Data­Type, to­String

Modifier and Type	Method	Description
Optional­Int	get­Coverage­Index()	Returns the index of the coverage for which to modify the description.
Data­Store	get­Data­Store()	Return the data store for which to modify a file, coverage (image) or sample dimension (band) description.
Optional<Data­Type>	get­Data­Type()	Returns the type in which the coverage (raster) data are stored.
String	to­String()	Returns a string representation for debugging purposes.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Constructor Details

BandSource

public BandSource(DataStore store,
 int coverageIndex,
 int bandIndex,
 int numBands,
 DataType dataType)

Creates a new source for the specified band.

Parameters:

store - the data store which contains the band to modify.

coverage­Index - index of the coverage for which to create a sample dimension.

band­Index - index of the band for which to create a sample dimension.

num­Bands - number of bands.

data­Type - type of raster data, or null if unknown.

Method Details

getBandIndex

public int getBandIndex()

Returns the index of the band for which to create sample dimension. The numbers start at 0.

Returns:

the index of the band for which to create sample dimension.

getNumBands

public int getNumBands()

Returns the number of sample dimensions (bands) in the coverage.

Returns:

the number of bands.

getSampleRange

public Optional<NumberRange<?>> getSampleRange()

Return the minimum and maximum values declared in the coverage metadata, if known. This range may contain the background value.

Returns:

the minimum and maximum values declared in the coverage.