public class DefaultBand extends DefaultSampleDimension implements Band
MD_Band
└─units……
Units of data in each dimension included in the resource.Limitations:
XML
instead.Defined in the sis-metadata
module
identifiers
Constructor and Description |
---|
DefaultBand()
Constructs an initially empty band.
|
DefaultBand(Band object)
Constructs a new instance initialized with the values from the specified metadata object.
|
Modifier and Type | Method and Description |
---|---|
static DefaultBand |
castOrCopy(Band object)
Returns a SIS metadata implementation with the values of 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.
|
Double |
getBoundMax()
Returns the longest wavelength that the sensor is capable of collecting within a designated band.
|
Double |
getBoundMin()
Returns the shortest wavelength that the sensor is capable of collecting within a designated band.
|
Unit<Length> |
getBoundUnits()
Returns units in which sensor wavelengths are expressed.
|
PolarizationOrientation |
getDetectedPolarization()
Returns polarization of the radiation detected.
|
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()
Returns the polarization of the radiation transmitted.
|
Unit<Length> |
getUnits()
Returns the units of data as a unit of length.
|
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 |
setBoundMax(Double newValue)
Sets the longest wavelength that the sensor is capable of collecting within a designated band.
|
void |
setBoundMin(Double newValue)
Sets the shortest wavelength that the sensor is capable of collecting within a designated band.
|
void |
setBoundUnits(Unit<Length> newValue)
Sets a new units in which sensor wavelengths are expressed.
|
void |
setDetectedPolarization(PolarizationOrientation newValue)
Sets the polarization of the radiation detected.
|
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<?> newValue)
Sets the units of data as a unit of length.
|
getMaxValue, getMeanValue, getMinValue, getNumberOfValues, getOtherProperty, getOtherPropertyType, getStandardDeviation, setMaxValue, setMeanValue, setMinValue, setNumberOfValues, setOtherProperty, setOtherPropertyType, setStandardDeviation
castOrCopy, getDescription, getDescriptor, getNames, getSequenceIdentifier, setDescription, setDescriptor, setNames, setSequenceIdentifier
freeze, getIdentifierMap, getIdentifiers, getStandard
checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, isModifiable, nonNullCollection, nonNullList, nonNullSet, singleton, unmodifiable, writeCollection, writeList, writeSet
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
getMaxValue, getMinValue
getDescriptor, getSequenceIdentifier
public DefaultBand()
public DefaultBand(Band object)
object
- the metadata to copy values from, or null
if none.castOrCopy(Band)
public static DefaultBand castOrCopy(Band object)
null
, then this method returns null
.DefaultBand
, then it is returned unchanged.DefaultBand
instance is created using the
copy constructor
and returned. Note that this is a shallow copy operation, since the other
metadata contained in the given object are not recursively copied.object
- the object to get as a SIS implementation, or null
if none.null
if the argument was null.@ValueRange(minimum=0.0) @UML(identifier="boundMin", obligation=OPTIONAL, specification=ISO_19115) public Double getBoundMin()
getBoundUnits()
.null
if unspecified.public void setBoundMin(Double newValue)
newValue
- the new shortest wavelength, or null
.IllegalArgumentException
- if the given value is negative.@ValueRange(minimum=0.0) @UML(identifier="boundMax", obligation=OPTIONAL, specification=ISO_19115) public Double getBoundMax()
getUnits()
.null
if unspecified.public void setBoundMax(Double newValue)
newValue
- the new longest wavelength, or null
.IllegalArgumentException
- if the given value is negative.@UML(identifier="boundUnits", obligation=OPTIONAL, specification=ISO_19115) public Unit<Length> getBoundUnits()
Units.NANOMETRE
public void setBoundUnits(Unit<Length> newValue)
newValue
- the new unit.public BandDefinition getBandBoundaryDefinition()
getBandBoundaryDefinition
in interface Band
null
.public void setBandBoundaryDefinition(BandDefinition newValue)
newValue
- the new band definition.public Unit<Length> getUnits()
boundUnits
.
The restriction for units of length in this units
property may be relaxed in GeoAPI 4.0.
getUnits
in interface Band
getUnits
in class DefaultSampleDimension
public void setUnits(Unit<?> newValue)
Unit<Length>
,
otherwise a ClassCastException
is thrown. This is because the value returned by
getUnits()
was restricted by ISO 19115:2003 to units of length.
However this restriction may be relaxed in GeoAPI 4.0.
setUnits
in class DefaultSampleDimension
newValue
- The new units of data as an instance of Unit<Length>
.@ValueRange(minimum=0.0) public Double getPeakResponse()
getBoundUnits()
.getPeakResponse
in interface Band
null
if unspecified.public void setPeakResponse(Double newValue)
newValue
- the new peak response, or null
.IllegalArgumentException
- if the given value is negative.@ValueRange(minimum=1.0) public Integer getBitsPerValue()
getBitsPerValue
in interface Band
getBitsPerValue
in class DefaultSampleDimension
null
if none.public void setBitsPerValue(Integer newValue)
setBitsPerValue
in class DefaultSampleDimension
newValue
- the new maximum number of significant bits.@ValueRange(minimum=0.0) public Integer getToneGradation()
getToneGradation
in interface Band
null
if none.public void setToneGradation(Integer newValue)
newValue
- the new tone gradation.public Double getScaleFactor()
getScaleFactor
in interface Band
getScaleFactor
in class DefaultSampleDimension
null
if none.public void setScaleFactor(Double newValue)
setScaleFactor
in class DefaultSampleDimension
newValue
- the new scale factor which has been applied to the cell value.public Double getOffset()
getOffset
in interface Band
getOffset
in class DefaultSampleDimension
null
if none.public void setOffset(Double newValue)
setOffset
in class DefaultSampleDimension
newValue
- the new physical value corresponding to a cell value of zero.@ValueRange(minimum=0.0, isMinIncluded=false) public Double getNominalSpatialResolution()
getNominalSpatialResolution
in interface Band
getNominalSpatialResolution
in class DefaultSampleDimension
null
.public void setNominalSpatialResolution(Double newValue)
setNominalSpatialResolution
in class DefaultSampleDimension
newValue
- the new nominal spatial resolution.public TransferFunctionType getTransferFunctionType()
getTransferFunctionType
in interface Band
getTransferFunctionType
in class DefaultSampleDimension
null
.public void setTransferFunctionType(TransferFunctionType newValue)
setTransferFunctionType
in class DefaultSampleDimension
newValue
- the new transfer function value.public PolarizationOrientation getTransmittedPolarization()
getTransmittedPolarization
in interface Band
null
.public void setTransmittedPolarization(PolarizationOrientation newValue)
newValue
- the new transmitted polarization.public PolarizationOrientation getDetectedPolarization()
getDetectedPolarization
in interface Band
null
.public void setDetectedPolarization(PolarizationOrientation newValue)
newValue
- the new detected polarization.Copyright © 2010–2017 The Apache Software Foundation. All rights reserved.