org.geotools.metadata.iso.content

Class BandImpl

Object

AbstractMetadata

ModifiableMetadata

MetadataEntity

RangeDimensionImpl

BandImpl

All Implemented Interfaces:

Serializable, Cloneable, Band, RangeDimension

public class BandImpl
extends RangeDimensionImpl
implements Band

Range of wavelengths in the electromagnetic spectrum.

Since:

2.1

Author:

Martin Desruisseaux (IRD), Touraïvane

See Also:

Serialized Form

Field Summary

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

Constructors

Constructor and Description
BandImpl() Constructs an initially empty band.
BandImpl(Band source) Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

Modifier and Type	Method and Description
Integer	getBitsPerValue() Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
Double	getMaxValue() Returns the longest wavelength that the sensor is capable of collecting within a designated band.
Double	getMinValue() Returns the shortest wavelength that the sensor is capable of collecting within a designated band.
Double	getOffset() Returns the physical value corresponding to a cell value of zero.
Double	getPeakResponse() Returns the wavelength at which the response is the highest.
Double	getScaleFactor() Returns the scale factor which has been applied to the cell value.
Integer	getToneGradation() Returns the number of discrete numerical values in the grid data.
Unit	getUnits() Returns the units in which sensor wavelengths are expressed.
void	setBitsPerValue(Integer newValue) Set the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
void	setMaxValue(Double newValue) Set the longest wavelength that the sensor is capable of collecting within a designated band.
void	setMinValue(Double newValue) Set the shortest wavelength that the sensor is capable of collecting within a designated band.
void	setOffset(Double newValue) Set the physical value corresponding to a cell value of zero.
void	setPeakResponse(Double newValue) Set the wavelength at which the response is the highest.
void	setScaleFactor(Double newValue) Set the scale factor which has been applied to the cell value.
void	setToneGradation(Integer newValue) Set the number of discrete numerical values in the grid data.
void	setUnits(Unit newValue) Set the units in which sensor wavelengths are expressed.

Methods inherited from class RangeDimensionImpl

getDescriptor, getSequenceIdentifier, setDescriptor, setSequenceIdentifier

Methods inherited from class MetadataEntity

ensureNonNull, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, copyCollection, copyList, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, equals, getInterface, hashCode, toString

Methods inherited from class Object

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

Methods inherited from interface RangeDimension

getDescriptor, getSequenceIdentifier

Constructor Detail

BandImpl

public BandImpl()

Constructs an initially empty band.

BandImpl

public BandImpl(Band source)

Constructs a metadata entity initialized with the values from the specified metadata.

Since:

2.4

Method Detail

getMaxValue

public Double getMaxValue()

Returns the longest wavelength that the sensor is capable of collecting within a designated band. Returns null if unspecified.

Specified by:

getMaxValue in interface Band

Returns:

Longest wavelength that the sensor is capable of collecting within a designated band, or null.

setMaxValue

public void setMaxValue(Double newValue)

Set the longest wavelength that the sensor is capable of collecting within a designated band. Returns null if unspecified.

getMinValue

public Double getMinValue()

Returns the shortest wavelength that the sensor is capable of collecting within a designated band.

Specified by:

getMinValue in interface Band

Returns:

Shortest wavelength that the sensor is capable of collecting within a designated band, or null.

setMinValue

public void setMinValue(Double newValue)

Set the shortest wavelength that the sensor is capable of collecting within a designated band.

getUnits

public Unit getUnits()

Returns the units in which sensor wavelengths are expressed. Should be non-null if min value or max value are provided.

Specified by:

getUnits in interface Band

Returns:

Units in which sensor wavelengths are expressed, or null.

setUnits

public void setUnits(Unit newValue)

Set the units in which sensor wavelengths are expressed. Should be non-null if min value or max value are provided.

getPeakResponse

public Double getPeakResponse()

Returns the wavelength at which the response is the highest. Returns null if unspecified.

Specified by:

getPeakResponse in interface Band

Returns:

Wavelength at which the response is the highest, or null.

setPeakResponse

public void setPeakResponse(Double newValue)

Set the wavelength at which the response is the highest.

getBitsPerValue

public Integer getBitsPerValue()

Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel. Returns null if unspecified.

Specified by:

getBitsPerValue in interface Band

Returns:

Maximum number of significant bits in the uncompressed representation, or null.

setBitsPerValue

public void setBitsPerValue(Integer newValue)

Set the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.

getToneGradation

public Integer getToneGradation()

Returns the number of discrete numerical values in the grid data. Returns null if unspecified.

Specified by:

getToneGradation in interface Band

Returns:

Number of discrete numerical values in the grid data, or null.

setToneGradation

public void setToneGradation(Integer newValue)

Set the number of discrete numerical values in the grid data.

getScaleFactor

public Double getScaleFactor()

Returns the scale factor which has been applied to the cell value. Returns null if unspecified.

Specified by:

getScaleFactor in interface Band

Returns:

Scale factor which has been applied to the cell value, or null.

setScaleFactor

public void setScaleFactor(Double newValue)

Set the scale factor which has been applied to the cell value.

getOffset

public Double getOffset()

Returns the physical value corresponding to a cell value of zero. Returns null if unspecified.

Specified by:

getOffset in interface Band

Returns:

The physical value corresponding to a cell value of zero, or null.

setOffset

public void setOffset(Double newValue)

Set the physical value corresponding to a cell value of zero.