org.geotoolkit.metadata.iso.content
Class DefaultBand

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultRangeDimension
                  DefaultBand

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Band, RangeDimension

@ThreadSafe
public class DefaultBand
extends DefaultRangeDimension
implements Band

Range of wavelengths in the electromagnetic spectrum.

Geotk extension
The Band interface defined by ISO 19115-2 is specific to measurements in electromagnetic spectrum. For the needs of Image I/O, an additional interface - SampleDimension - has been defined with a subset of the Band API but without the restriction to wavelengths.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultBand()
Constructs an initially empty band.

DefaultBand(Band source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultBand	castOrCopy(Band object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
BandDefinition	getBandBoundaryDefinition() Returns the designation of criterion for defining maximum and minimum wavelengths for a spectral band.
Integer	getBitsPerValue() Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
PolarizationOrientation	getDetectedPolarization() Polarization of the radiation detected.
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	getNominalSpatialResolution() Returns the smallest distance between which separate points can be distinguished, as specified in instrument design.
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.
TransferFunctionType	getTransferFunctionType() Returns type of transfer function to be used when scaling a physical value for a given element.
PolarizationOrientation	getTransmittedPolarization() Polarization of the radiation transmitted.
Unit<Length>	getUnits() Returns the units in which sensor wavelengths are expressed.
void	setBandBoundaryDefinition(BandDefinition newValue) Sets designation of criterion for defining maximum and minimum wavelengths for a spectral band.
void	setBitsPerValue(Integer newValue) Sets the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
void	setDetectedPolarization(PolarizationOrientation newValue) Sets the polarization of the radiation detected.
void	setMaxValue(Double newValue) Sets the longest wavelength that the sensor is capable of collecting within a designated band.
void	setMinValue(Double newValue) Sets the shortest wavelength that the sensor is capable of collecting within a designated band.
void	setNominalSpatialResolution(Double newValue) Sets the smallest distance between which separate points can be distinguished, as specified in instrument design.
void	setOffset(Double newValue) Sets the physical value corresponding to a cell value of zero.
void	setPeakResponse(Double newValue) Sets the wavelength at which the response is the highest.
void	setScaleFactor(Double newValue) Sets the scale factor which has been applied to the cell value.
void	setToneGradation(Integer newValue) Sets the number of discrete numerical values in the grid data.
void	setTransferFunctionType(TransferFunctionType newValue) Sets the type of transfer function to be used when scaling a physical value for a given element.
void	setTransmittedPolarization(PolarizationOrientation newValue) Sets the polarization of the radiation transmitted.
void	setUnits(Unit<Length> newValue) Sets the units in which sensor wavelengths are expressed.

Methods inherited from class DefaultRangeDimension

castOrCopy, getDescriptor, getSequenceIdentifier, setDescriptor, setSequenceIdentifier

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

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

Methods inherited from interface RangeDimension

getDescriptor, getSequenceIdentifier

Constructor Detail

DefaultBand

public DefaultBand()

Constructs an initially empty band.

DefaultBand

public DefaultBand(Band source)

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

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

Method Detail

castOrCopy

public static DefaultBand castOrCopy(Band object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

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

setMaxValue

public void setMaxValue(Double newValue)

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

Parameters:

newValue - The new longest wavelength.

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

setMinValue

public void setMinValue(Double newValue)

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

Parameters:

newValue - The new shortest wavelength.

getUnits

public Unit<Length> 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

setUnits

public void setUnits(Unit<Length> newValue)

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

Parameters:

newValue - The new units.

getPeakResponse

public Double getPeakResponse()

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

Specified by:

getPeakResponse in interface Band

setPeakResponse

public void setPeakResponse(Double newValue)

Sets the wavelength at which the response is the highest.

Parameters:

newValue - The new peak response.

getBitsPerValue

@ValueRange(minimum=1.0)
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

setBitsPerValue

public void setBitsPerValue(Integer newValue)

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

Parameters:

newValue - The new number of bits per value.

getToneGradation

@ValueRange(minimum=0.0)
public Integer getToneGradation()

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

Specified by:

getToneGradation in interface Band

setToneGradation

public void setToneGradation(Integer newValue)

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

Parameters:

newValue - The new tone gradation.

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

setScaleFactor

public void setScaleFactor(Double newValue)

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

Parameters:

newValue - The new scale factor.

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

setOffset

public void setOffset(Double newValue)

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

Parameters:

newValue - The new offset.

getBandBoundaryDefinition

public BandDefinition getBandBoundaryDefinition()

Returns the designation of criterion for defining maximum and minimum wavelengths for a spectral band. Returns null if unspecified.

Specified by:

getBandBoundaryDefinition in interface Band

Since:

3.03

setBandBoundaryDefinition

public void setBandBoundaryDefinition(BandDefinition newValue)

Sets designation of criterion for defining maximum and minimum wavelengths for a spectral band.

Parameters:

newValue - The new band definition.

Since:

3.03

getNominalSpatialResolution

@ValueRange(minimum=0.0,
            isMinIncluded=false)
public Double getNominalSpatialResolution()

Returns the smallest distance between which separate points can be distinguished, as specified in instrument design. Returns null if unspecified.

Specified by:

getNominalSpatialResolution in interface Band

Since:

3.03

setNominalSpatialResolution

public void setNominalSpatialResolution(Double newValue)

Sets the smallest distance between which separate points can be distinguished, as specified in instrument design.

Parameters:

newValue - The new nominal spatial resolution.

Since:

3.03

getTransferFunctionType

public TransferFunctionType getTransferFunctionType()

Returns type of transfer function to be used when scaling a physical value for a given element. Returns null if unspecified.

Specified by:

getTransferFunctionType in interface Band

Since:

3.03

setTransferFunctionType

public void setTransferFunctionType(TransferFunctionType newValue)

Sets the type of transfer function to be used when scaling a physical value for a given element.

Parameters:

newValue - The new transfer function value.

Since:

3.03

getTransmittedPolarization

public PolarizationOrientation getTransmittedPolarization()

Polarization of the radiation transmitted. Returns null if unspecified.

Specified by:

getTransmittedPolarization in interface Band

Since:

3.03

setTransmittedPolarization

public void setTransmittedPolarization(PolarizationOrientation newValue)

Sets the polarization of the radiation transmitted.

Parameters:

newValue - The new transmitted polarization.

Since:

3.03

getDetectedPolarization

public PolarizationOrientation getDetectedPolarization()

Polarization of the radiation detected. Returns null if unspecified.

Specified by:

getDetectedPolarization in interface Band

Since:

3.03

setDetectedPolarization

public void setDetectedPolarization(PolarizationOrientation newValue)

Sets the polarization of the radiation detected.

Parameters:

newValue - The new detected polarization.

Since:

3.03