Class DefaultBand

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultRangeDimension

DefaultSampleDimension

DefaultBand

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Band, Range­Dimension

public class DefaultBand
extends DefaultSampleDimension
implements Band

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 XML instead.

Since:

0.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Band()	Constructs an initially empty band.
Default­Band(Band object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Band	cast­Or­Copy(Band object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Band­Definition	get­Band­Boundary­Definition()	Returns the designation of criterion for defining maximum and minimum wavelengths for a spectral band.
Double	get­Bound­Max()	Returns the longest wavelength that the sensor is capable of collecting within a designated band.
Double	get­Bound­Min()	Returns the shortest wavelength that the sensor is capable of collecting within a designated band.
Unit<Length>	get­Bound­Units()	Returns units in which sensor wavelengths are expressed.
Polarization­Orientation	get­Detected­Polarization()	Returns polarization of the radiation detected.
Double	get­Nominal­Spatial­Resolution()	Returns the smallest distance between which separate points can be distinguished, as specified in instrument design.
Double	get­Peak­Response()	Returns the wavelength at which the response is the highest.
Integer	get­Tone­Gradation()	Returns the number of discrete numerical values in the grid data.
Transfer­Function­Type	get­Transfer­Function­Type()	Returns type of transfer function to be used when scaling a physical value for a given element.
Polarization­Orientation	get­Transmitted­Polarization()	Returns the polarization of the radiation transmitted.
Unit<Length>	get­Units()	Returns the units of data as a unit of length.
void	set­Band­Boundary­Definition(Band­Definition new­Value)	Sets designation of criterion for defining maximum and minimum wavelengths for a spectral band.
void	set­Bound­Max(Double new­Value)	Sets the longest wavelength that the sensor is capable of collecting within a designated band.
void	set­Bound­Min(Double new­Value)	Sets the shortest wavelength that the sensor is capable of collecting within a designated band.
void	set­Bound­Units(Unit<Length> new­Value)	Sets a new units in which sensor wavelengths are expressed.
void	set­Detected­Polarization(Polarization­Orientation new­Value)	Sets the polarization of the radiation detected.
void	set­Nominal­Spatial­Resolution(Double new­Value)	Sets the smallest distance between which separate points can be distinguished, as specified in instrument design.
void	set­Peak­Response(Double new­Value)	Sets the wavelength at which the response is the highest.
void	set­Tone­Gradation(Integer new­Value)	Sets the number of discrete numerical values in the grid data.
void	set­Transfer­Function­Type(Transfer­Function­Type new­Value)	Sets the type of transfer function to be used when scaling a physical value for a given element.
void	set­Transmitted­Polarization(Polarization­Orientation new­Value)	Sets the polarization of the radiation transmitted.
void	set­Units(Unit<?> new­Value)	Sets the units of data as a unit of length.

Methods inherited from class DefaultSampleDimension

get­Bits­Per­Value, get­Max­Value, get­Mean­Value, get­Min­Value, get­Number­Of­Values, get­Offset, get­Other­Property, get­Other­Property­Type, get­Range­Element­Descriptions, get­Scale­Factor, get­Standard­Deviation, set­Bits­Per­Value, set­Max­Value, set­Mean­Value, set­Min­Value, set­Number­Of­Values, set­Offset, set­Other­Property, set­Other­Property­Type, set­Range­Element­Descriptions, set­Scale­Factor, set­Standard­Deviation

Modifier and Type	Method	Description
Integer	get­Bits­Per­Value()	Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
Double	get­Max­Value()	Returns the maximum value of data values in each dimension included in the resource.
Double	get­Mean­Value()	Returns the mean value of data values in each dimension included in the resource.
Double	get­Min­Value()	Returns the minimum value of data values in each dimension included in the resource.
Integer	get­Number­Of­Values()	Returns the number of values used in a thematic classification resource.
Double	get­Offset()	Returns the physical value corresponding to a cell value of zero.
Record	get­Other­Property()	Returns instance of other/attributeType that defines attributes not explicitly included in Coverage­Content­Type, or null if none.
Record­Type	get­Other­Property­Type()	Returns type of other attribute description.
Collection<Range­Element­Description>	get­Range­Element­Descriptions()	Provides the description and values of the specific range elements of a sample dimension.
Double	get­Scale­Factor()	Returns the scale factor which has been applied to the cell value.
Double	get­Standard­Deviation()	Returns the standard deviation of data values in each dimension included in the resource.
void	set­Bits­Per­Value(Integer new­Value)	Sets the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
void	set­Max­Value(Double new­Value)	Sets the maximum value of data values in each dimension included in the resource.
void	set­Mean­Value(Double new­Value)	Sets the mean value of data values in each dimension included in the resource.
void	set­Min­Value(Double new­Value)	Sets the minimum value of data values in each dimension included in the resource.
void	set­Number­Of­Values(Integer new­Value)	Sets the number of values used in a thematic classification resource.
void	set­Offset(Double new­Value)	Sets the physical value corresponding to a cell value of zero.
void	set­Other­Property(Record new­Value)	Sets a new instance of other/attributeType that defines attributes not explicitly included in Coverage­Content­Type.
void	set­Other­Property­Type(Record­Type new­Value)	Sets a new type of other attribute description.
void	set­Range­Element­Descriptions(Collection<? extends Range­Element­Description> new­Values)	Sets the description and values of the specific range elements of a sample dimension.
void	set­Scale­Factor(Double new­Value)	Sets the scale factor which has been applied to the cell value.
void	set­Standard­Deviation(Double new­Value)	Sets the standard deviation of data values in each dimension included in the resource.

Methods inherited from class DefaultRangeDimension

cast­Or­Copy, get­Description, get­Descriptor, get­Names, get­Sequence­Identifier, set­Description, set­Descriptor, set­Names, set­Sequence­Identifier

Modifier and Type	Method	Description
static Default­Range­Dimension	cast­Or­Copy(Range­Dimension object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Description()	Returns the description of the attribute.
International­String	get­Descriptor()	Deprecated. As of ISO 19115:2014, renamed Default­Range­Dimension.get­Description().
Collection<Identifier>	get­Names()	Returns the identifiers for each attribute included in the resource.
Member­Name	get­Sequence­Identifier()	Returns a unique name or number that identifies attributes included in the coverage.
void	set­Description(International­String new­Value)	Sets the description of the attribute.
void	set­Descriptor(International­String new­Value)	Deprecated. As of ISO 19115:2014, renamed Default­Range­Dimension.set­Description(International­String).
void	set­Names(Collection<? extends Identifier> new­Values)	Sets the identifiers for each attribute included in the resource.
void	set­Sequence­Identifier(Member­Name new­Value)	Sets the name or number that uniquely identifies instances of bands of wavelengths on which a sensor operates.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface Band

get­Bits­Per­Value, get­Max­Value, get­Min­Value, get­Offset, get­Scale­Factor

Modifier and Type	Method	Description
Integer	get­Bits­Per­Value()	Maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
Double	get­Max­Value()	Longest wavelength that the sensor is capable of collecting within a designated band.
Double	get­Min­Value()	Shortest wavelength that the sensor is capable of collecting within a designated band.
Double	get­Offset()	The physical value corresponding to a cell value of zero.
Double	get­Scale­Factor()	Scale factor which has been applied to the cell value.

Constructor Details

DefaultBand

public DefaultBand()

Constructs an initially empty band.

DefaultBand

public DefaultBand(Band object)

Constructs 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 null if none.

See Also:

• cast­Or­Copy(Band)

Method Details

castOrCopy

public static DefaultBand castOrCopy(Band object)

Returns 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 returns null.
• Otherwise if the given object is already an instance of Default­Band, then it is returned unchanged.
• Otherwise a new Default­Band instance 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 null if none.

Returns:

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

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 by get­Bound­Units().

Returns:

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

Since:

0.5

setBoundMin

public void setBoundMin(Double newValue)

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

Parameters:

new­Value - the new shortest wavelength, or null.

Throws:

Illegal­Argument­Exception - 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 by get­Units().

Returns:

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

Since:

0.5

setBoundMax

public void setBoundMax(Double newValue)

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

Parameters:

new­Value - the new longest wavelength, or null.

Throws:

Illegal­Argument­Exception - 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:

• Units.NANOMETRE

setBoundUnits

public void setBoundUnits(Unit<Length> newValue)

Sets a new units in which sensor wavelengths are expressed.

Parameters:

new­Value - the new unit.

Since:

0.5

getBandBoundaryDefinition

public BandDefinition getBandBoundaryDefinition()

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

Specified by:

get­Band­Boundary­Definition in interface Band

Returns:

criterion for defining maximum and minimum wavelengths, or null.

setBandBoundaryDefinition

public void setBandBoundaryDefinition(BandDefinition newValue)

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

Parameters:

new­Value - the new band definition.

getUnits

public Unit<Length> getUnits()

Returns the units of data as a unit of length.

Upcoming API change — generalization
As of ISO 19115:2014, the units of wavelength is rather bound­Units. The restriction for units of length in this units property may be relaxed in GeoAPI 4.0.

Specified by:

get­Units in interface Band

Overrides:

get­Units in class Default­Sample­Dimension

Returns:

The units of data.

setUnits

public void setUnits(Unit<?> newValue)

Sets the units of data as a unit of length.

Upcoming precondition change — relaxation
The current implementation requires the unit to be an instance of Unit<Length>, otherwise a Class­Cast­Exception is thrown. This is because the value returned by get­Units() was restricted by ISO 19115:2003 to units of length. However this restriction may be relaxed in GeoAPI 4.0.

Overrides:

set­Units in class Default­Sample­Dimension

Parameters:

new­Value - The new units of data as an instance of Unit<Length>.

getPeakResponse

@ValueRange(minimum=0.0)
public Double getPeakResponse()

Returns the wavelength at which the response is the highest. The units of measurement is given by get­Bound­Units().

Specified by:

get­Peak­Response in interface Band

Returns:

wavelength at which the response is the highest, or null if unspecified.

setPeakResponse

public void setPeakResponse(Double newValue)

Sets the wavelength at which the response is the highest.

Parameters:

new­Value - the new peak response, or null.

Throws:

Illegal­Argument­Exception - if the given value is negative.

getToneGradation

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

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

Specified by:

get­Tone­Gradation in interface Band

Returns:

number of discrete numerical values in the grid data, or null if none.

setToneGradation

public void setToneGradation(Integer newValue)

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

Parameters:

new­Value - the new tone gradation.

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.

Specified by:

get­Nominal­Spatial­Resolution in interface Band

Overrides:

get­Nominal­Spatial­Resolution in class Default­Sample­Dimension

Returns:

smallest distance between which separate points can be distinguished, or null.

setNominalSpatialResolution

public void setNominalSpatialResolution(Double newValue)

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

Overrides:

set­Nominal­Spatial­Resolution in class Default­Sample­Dimension

Parameters:

new­Value - the new nominal spatial resolution.

getTransferFunctionType

public TransferFunctionType getTransferFunctionType()

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

Specified by:

get­Transfer­Function­Type in interface Band

Overrides:

get­Transfer­Function­Type in class Default­Sample­Dimension

Returns:

type of transfer function, or null.

setTransferFunctionType

public void setTransferFunctionType(TransferFunctionType newValue)

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

Overrides:

set­Transfer­Function­Type in class Default­Sample­Dimension

Parameters:

new­Value - the new transfer function value.

getTransmittedPolarization

public PolarizationOrientation getTransmittedPolarization()

Returns the polarization of the radiation transmitted.

Upcoming API change
This method may be renamed get­Transmitted­Polarization and its return type replaced by Polarisation­Orientation ("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.

Specified by:

get­Transmitted­Polarization in interface Band

Returns:

polarization of the radiation transmitted, or null.

setTransmittedPolarization

public void setTransmittedPolarization(PolarizationOrientation newValue)

Sets the polarization of the radiation transmitted.

Upcoming API change
This method may be renamed set­Transmitted­Polarization and its argument type replaced by Polarisation­Orientation ("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.

Parameters:

new­Value - the new transmitted polarization.

getDetectedPolarization

public PolarizationOrientation getDetectedPolarization()

Returns polarization of the radiation detected.

Upcoming API change
This method may be renamed get­Detected­Polarization and its return type replaced by Polarisation­Orientation ("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.

Specified by:

get­Detected­Polarization in interface Band

Returns:

polarization of the radiation detected, or null.

setDetectedPolarization

public void setDetectedPolarization(PolarizationOrientation newValue)

Sets the polarization of the radiation detected.

Upcoming API change
This method may be renamed set­Detected­Polarization and its argument type replaced by Polarisation­Orientation ("z" letter replaced by "s" letter) in GeoAPI 4.0 for compliance with ISO 19115-2:2019.

Parameters:

new­Value - the new detected polarization.