Class DefaultBand
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- Band,- RangeDimension
Range of wavelengths in the electromagnetic spectrum.
 The following property is conditional (i.e. mandatory under some circumstances)
 in a well-formed metadata according ISO 19115:
 
 
MD_Band
   └─units…… Units of data in each dimension included in the resource.Limitations
- Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
- Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
       Serialization support is appropriate for short term storage or RMI between applications running the
       same version of Apache SIS. For long term storage, use XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty band.DefaultBand(Band object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultBandcastOrCopy(Band object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the designation of criterion for defining maximum and minimum wavelengths for a spectral band.Returns the longest wavelength that the sensor is capable of collecting within a designated band.Returns the shortest wavelength that the sensor is capable of collecting within a designated band.Returns units in which sensor wavelengths are expressed.Returns polarization of the radiation detected.Returns the smallest distance between which separate points can be distinguished, as specified in instrument design.Returns the wavelength at which the response is the highest.Returns the number of discrete numerical values in the grid data.Returns type of transfer function to be used when scaling a physical value for a given element.Returns the polarization of the radiation transmitted.Returns the units of data as a unit of length.voidsetBandBoundaryDefinition(BandDefinition newValue) Sets designation of criterion for defining maximum and minimum wavelengths for a spectral band.voidsetBoundMax(Double newValue) Sets the longest wavelength that the sensor is capable of collecting within a designated band.voidsetBoundMin(Double newValue) Sets the shortest wavelength that the sensor is capable of collecting within a designated band.voidsetBoundUnits(Unit<Length> newValue) Sets a new units in which sensor wavelengths are expressed.voidSets the polarization of the radiation detected.voidsetNominalSpatialResolution(Double newValue) Sets the smallest distance between which separate points can be distinguished, as specified in instrument design.voidsetPeakResponse(Double newValue) Sets the wavelength at which the response is the highest.voidsetToneGradation(Integer newValue) Sets the number of discrete numerical values in the grid data.voidsetTransferFunctionType(TransferFunctionType newValue) Sets the type of transfer function to be used when scaling a physical value for a given element.voidSets the polarization of the radiation transmitted.voidSets the units of data as a unit of length.Methods inherited from class DefaultSampleDimensiongetBitsPerValue, getMaxValue, getMeanValue, getMinValue, getNumberOfValues, getOffset, getOtherProperty, getOtherPropertyType, getRangeElementDescriptions, getScaleFactor, getStandardDeviation, setBitsPerValue, setMaxValue, setMeanValue, setMinValue, setNumberOfValues, setOffset, setOtherProperty, setOtherPropertyType, setRangeElementDescriptions, setScaleFactor, setStandardDeviationMethods inherited from class DefaultRangeDimensioncastOrCopy, getDescription, getDescriptor, getNames, getSequenceIdentifier, setDescription, setDescriptor, setNames, setSequenceIdentifierMethods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toStringMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface BandgetBitsPerValue, getMaxValue, getMinValue, getOffset, getScaleFactorMethods inherited from interface RangeDimensiongetDescriptor, getSequenceIdentifier
- 
Constructor Details- 
DefaultBandpublic DefaultBand()Constructs an initially empty band.
- 
DefaultBandConstructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.Note on properties validation: This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.- Parameters:
- object- the metadata to copy values from, or- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is null, then this method returnsnull.
- Otherwise if the given object is already an instance of
       DefaultBand, then it is returned unchanged.
- Otherwise a new DefaultBandinstance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
 - Parameters:
- object- the object to get as a SIS implementation, or- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getBoundMin@ValueRange(minimum=0.0) @UML(identifier="boundMin", obligation=OPTIONAL, specification=ISO_19115) public Double getBoundMin()Returns the shortest wavelength that the sensor is capable of collecting within a designated band. The units of measurement is given bygetBoundUnits().- Returns:
- Shortest wavelength that the sensor is capable of collecting within a designated band,
         or nullif unspecified.
- Since:
- 0.5
 
- 
setBoundMinSets the shortest wavelength that the sensor is capable of collecting within a designated band.- Parameters:
- newValue- the new shortest wavelength, or- null.
- Throws:
- IllegalArgumentException- if the given value is negative.
- Since:
- 0.5
 
- 
getBoundMax@ValueRange(minimum=0.0) @UML(identifier="boundMax", obligation=OPTIONAL, specification=ISO_19115) public Double getBoundMax()Returns the longest wavelength that the sensor is capable of collecting within a designated band. The units of measurement is given bygetUnits().- Returns:
- longest wavelength that the sensor is capable of collecting within a designated band,
         or nullif unspecified.
- Since:
- 0.5
 
- 
setBoundMaxSets the longest wavelength that the sensor is capable of collecting within a designated band.- Parameters:
- newValue- the new longest wavelength, or- null.
- Throws:
- IllegalArgumentException- if the given value is negative.
- Since:
- 0.5
 
- 
getBoundUnits@UML(identifier="boundUnits", obligation=OPTIONAL, specification=ISO_19115) public Unit<Length> getBoundUnits()Returns units in which sensor wavelengths are expressed.- Returns:
- units in which sensor wavelengths are expressed.
- Since:
- 0.5
- See Also:
 
- 
setBoundUnitsSets a new units in which sensor wavelengths are expressed.- Parameters:
- newValue- the new unit.
- Since:
- 0.5
 
- 
getBandBoundaryDefinitionReturns the designation of criterion for defining maximum and minimum wavelengths for a spectral band.- Specified by:
- getBandBoundaryDefinitionin interface- Band
- Returns:
- criterion for defining maximum and minimum wavelengths, or null.
 
- 
setBandBoundaryDefinitionSets designation of criterion for defining maximum and minimum wavelengths for a spectral band.- Parameters:
- newValue- the new band definition.
 
- 
getUnitsReturns the units of data as a unit of length.Upcoming API change — generalization
 As of ISO 19115:2014, the units of wavelength is ratherboundUnits. The restriction for units of length in thisunitsproperty may be relaxed in GeoAPI 4.0.- Specified by:
- getUnitsin interface- Band
- Overrides:
- getUnitsin class- DefaultSampleDimension
- Returns:
- The units of data.
 
- 
setUnitsSets the units of data as a unit of length.Upcoming precondition change — relaxation
 The current implementation requires the unit to be an instance ofUnit<Length>, otherwise aClassCastExceptionis thrown. This is because the value returned bygetUnits()was restricted by ISO 19115:2003 to units of length. However this restriction may be relaxed in GeoAPI 4.0.- Overrides:
- setUnitsin class- DefaultSampleDimension
- Parameters:
- newValue- The new units of data as an instance of- Unit<Length>.
 
- 
getPeakResponseReturns the wavelength at which the response is the highest. The units of measurement is given bygetBoundUnits().- Specified by:
- getPeakResponsein interface- Band
- Returns:
- wavelength at which the response is the highest, or nullif unspecified.
 
- 
setPeakResponseSets the wavelength at which the response is the highest.- Parameters:
- newValue- the new peak response, or- null.
- Throws:
- IllegalArgumentException- if the given value is negative.
 
- 
getToneGradationReturns the number of discrete numerical values in the grid data.- Specified by:
- getToneGradationin interface- Band
- Returns:
- number of discrete numerical values in the grid data, or nullif none.
 
- 
setToneGradationSets the number of discrete numerical values in the grid data.- Parameters:
- newValue- the new tone gradation.
 
- 
getNominalSpatialResolutionReturns the smallest distance between which separate points can be distinguished, as specified in instrument design.- Specified by:
- getNominalSpatialResolutionin interface- Band
- Overrides:
- getNominalSpatialResolutionin class- DefaultSampleDimension
- Returns:
- smallest distance between which separate points can be distinguished, or null.
 
- 
setNominalSpatialResolutionSets the smallest distance between which separate points can be distinguished, as specified in instrument design.- Overrides:
- setNominalSpatialResolutionin class- DefaultSampleDimension
- Parameters:
- newValue- the new nominal spatial resolution.
 
- 
getTransferFunctionTypeReturns type of transfer function to be used when scaling a physical value for a given element.- Specified by:
- getTransferFunctionTypein interface- Band
- Overrides:
- getTransferFunctionTypein class- DefaultSampleDimension
- Returns:
- type of transfer function, or null.
 
- 
setTransferFunctionTypeSets the type of transfer function to be used when scaling a physical value for a given element.- Overrides:
- setTransferFunctionTypein class- DefaultSampleDimension
- Parameters:
- newValue- the new transfer function value.
 
- 
getTransmittedPolarizationReturns the polarization of the radiation transmitted.Upcoming API change
 This method may be renamedgetTransmittedPolarizationand its return type replaced byPolarisationOrientation("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.- Specified by:
- getTransmittedPolarizationin interface- Band
- Returns:
- polarization of the radiation transmitted, or null.
 
- 
setTransmittedPolarizationSets the polarization of the radiation transmitted.Upcoming API change
 This method may be renamedsetTransmittedPolarizationand its argument type replaced byPolarisationOrientation("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.- Parameters:
- newValue- the new transmitted polarization.
 
- 
getDetectedPolarizationReturns polarization of the radiation detected.Upcoming API change
 This method may be renamedgetDetectedPolarizationand its return type replaced byPolarisationOrientation("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.- Specified by:
- getDetectedPolarizationin interface- Band
- Returns:
- polarization of the radiation detected, or null.
 
- 
setDetectedPolarizationSets the polarization of the radiation detected.Upcoming API change
 This method may be renamedsetDetectedPolarizationand its argument type replaced byPolarisationOrientation("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.- Parameters:
- newValue- the new detected polarization.
 
 
-