public class DefaultBand extends DefaultRangeDimension implements Band
Band
interface defined by ISO 19115-2 is specific to measurements in
electromagnetic spectrum. For the needs of Image I/O, an additional interface -
org.apache.sis.image.io.metadata.SampleDimension
- has been defined with
a subset of the Band
API but without the restriction to wavelengths.Defined in the sis-metadata
module
identifiers, LOGGER
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.
|
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.
|
castOrCopy, getDescriptor, getSequenceIdentifier, setDescriptor, setSequenceIdentifier
getIdentifierMap, getIdentifiers, getStandard
checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, singleton, unmodifiable, writeCollection, writeList, writeSet
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
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.public Double getMaxValue()
getUnits()
.getMaxValue
in interface Band
null
if unspecified.public void setMaxValue(Double newValue)
newValue
- The new longest wavelength.public Double getMinValue()
getUnits()
.getMinValue
in interface Band
null
if unspecified.public void setMinValue(Double newValue)
newValue
- The new shortest wavelength.public Unit<Length> getUnits()
public void setUnits(Unit<Length> newValue)
newValue
- The new units.public Double getPeakResponse()
getUnits()
.getPeakResponse
in interface Band
null
if unspecified.public void setPeakResponse(Double newValue)
newValue
- The new peak response.@ValueRange(minimum=1.0) public Integer getBitsPerValue()
getBitsPerValue
in interface Band
null
.public void setBitsPerValue(Integer newValue)
newValue
- The new number of bits per value.@ValueRange(minimum=0.0) public Integer getToneGradation()
getToneGradation
in interface Band
null
.public void setToneGradation(Integer newValue)
newValue
- The new tone gradation.public Double getScaleFactor()
getScaleFactor
in interface Band
null
.public void setScaleFactor(Double newValue)
newValue
- The new scale factor.public Double getOffset()
public void setOffset(Double newValue)
newValue
- The new offset.public BandDefinition getBandBoundaryDefinition()
getBandBoundaryDefinition
in interface Band
null
.public void setBandBoundaryDefinition(BandDefinition newValue)
newValue
- The new band definition.@ValueRange(minimum=0.0, isMinIncluded=false) public Double getNominalSpatialResolution()
getNominalSpatialResolution
in interface Band
null
.public void setNominalSpatialResolution(Double newValue)
newValue
- The new nominal spatial resolution.public TransferFunctionType getTransferFunctionType()
getTransferFunctionType
in interface Band
null
.public void setTransferFunctionType(TransferFunctionType newValue)
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–2014 The Apache Software Foundation. All rights reserved.