Class DefaultImageDescription

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractContentInformation

DefaultCoverageDescription

DefaultImageDescription

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Content­Information, Coverage­Description, Image­Description

public class DefaultImageDescription
extends DefaultCoverageDescription
implements ImageDescription

Information about an image's suitability for use. The following property is mandatory in a well-formed metadata according ISO 19115:

MD_Image­Description └─attribute­Description…… Description of the attribute described by the measurement value.

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­Image­Description()	Constructs an initially empty image description.
Default­Image­Description(Image­Description object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Image­Description	cast­Or­Copy(Image­Description object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Double	get­Cloud­Cover­Percentage()	Returns the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
Integer	get­Compression­Generation­Quantity()	Returns the count of the number of lossy compression cycles performed on the image.
Double	get­Illumination­Azimuth­Angle()	Returns the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.
Double	get­Illumination­Elevation­Angle()	Returns the illumination elevation measured in degrees clockwise from the target plane at intersection of the optical line of sight with the Earth's surface.
Identifier	get­Image­Quality­Code()	Returns a code in producer’s codespace that specifies the image quality.
Imaging­Condition	get­Imaging­Condition()	Returns the conditions which affected the image.
Boolean	get­Triangulation­Indicator()	Returns the indication of whether or not triangulation has been performed upon the image.
Boolean	is­Camera­Calibration­Information­Available()	Returns the indication of whether or not constants are available which allow for camera calibration corrections.
Boolean	is­Film­Distortion­Information­Available()	Returns the indication of whether or not Calibration Reseau information is available.
Boolean	is­Lens­Distortion­Information­Available()	Returns the indication of whether or not lens aberration correction information is available.
Boolean	is­Radiometric­Calibration­Data­Available()	Returns the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.
void	set­Camera­Calibration­Information­Available(Boolean new­Value)	Sets the indication of whether or not constants are available which allow for camera calibration corrections.
void	set­Cloud­Cover­Percentage(Double new­Value)	Sets the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
void	set­Compression­Generation­Quantity(Integer new­Value)	Sets the count of the number the number of lossy compression cycles performed on the image.
void	set­Film­Distortion­Information­Available(Boolean new­Value)	Sets the indication of whether or not Calibration Reseau information is available.
void	set­Illumination­Azimuth­Angle(Double new­Value)	Sets the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.
void	set­Illumination­Elevation­Angle(Double new­Value)	Sets the illumination elevation measured in degrees clockwise from the target plane at intersection of the optical line of sight with the Earth's surface.
void	set­Image­Quality­Code(Identifier new­Value)	Sets a code in producer’s codespace that specifies the image quality.
void	set­Imaging­Condition(Imaging­Condition new­Value)	Sets the conditions that affected the image.
void	set­Lens­Distortion­Information­Available(Boolean new­Value)	Sets the indication of whether or not lens aberration correction information is available.
void	set­Radiometric­Calibration­Data­Available(Boolean new­Value)	Sets the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.
void	set­Triangulation­Indicator(Boolean new­Value)	Sets the indication of whether or not triangulation has been performed upon the image.

Methods inherited from class DefaultCoverageDescription

cast­Or­Copy, get­Attribute­Description, get­Attribute­Groups, get­Content­Type, get­Dimensions, get­Processing­Level­Code, get­Range­Element­Descriptions, set­Attribute­Description, set­Attribute­Groups, set­Content­Type, set­Dimensions, set­Processing­Level­Code, set­Range­Element­Descriptions

Modifier and Type	Method	Description
static Default­Coverage­Description	cast­Or­Copy(Coverage­Description object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Record­Type	get­Attribute­Description()	Returns the description of the attribute described by the measurement value.
Collection<Default­Attribute­Group>	get­Attribute­Groups()	Returns information on attribute groups of the resource.
Coverage­Content­Type	get­Content­Type()	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.get­Content­Types().
final Collection<Range­Dimension>	get­Dimensions()	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.get­Attributes().
Identifier	get­Processing­Level­Code()	Returns an identifier for the level of processing that has been applied to the resource, or null if none.
Collection<Range­Element­Description>	get­Range­Element­Descriptions()	Provides the description of the specific range elements of a coverage.
void	set­Attribute­Description(Record­Type new­Value)	Sets the description of the attribute described by the measurement value.
void	set­Attribute­Groups(Collection<? extends Default­Attribute­Group> new­Values)	Sets information on attribute groups of the resource.
void	set­Content­Type(Coverage­Content­Type new­Value)	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.set­Content­Types(Collection).
void	set­Dimensions(Collection<? extends Range­Dimension> new­Values)	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.set­Attributes(Collection).
void	set­Processing­Level­Code(Identifier new­Value)	Sets the identifier for the level of processing that has been applied to the resource.
void	set­Range­Element­Descriptions(Collection<? extends Range­Element­Description> new­Values)	Sets the description of the specific range elements of a coverage.

Methods inherited from class AbstractContentInformation

cast­Or­Copy

Modifier and Type	Method	Description
static Abstract­Content­Information	cast­Or­Copy(Content­Information object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.

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 ImageDescription

get­Processing­Level­Code

Modifier and Type	Method	Description
Identifier	get­Processing­Level­Code()	Image distributor's code that identifies the level of radiometric and geometric processing that has been applied.

Constructor Details

DefaultImageDescription

public DefaultImageDescription()

Constructs an initially empty image description.

DefaultImageDescription

public DefaultImageDescription(ImageDescription 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 a value is out of range). 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(Image­Description)

Method Details

castOrCopy

public static DefaultImageDescription castOrCopy(ImageDescription 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­Image­Description, then it is returned unchanged.
• Otherwise a new Default­Image­Description 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.

getIlluminationElevationAngle

@ValueRange(minimum=-90.0,
            maximum=90.0)
public Double getIlluminationElevationAngle()

Returns the illumination elevation measured in degrees clockwise from the target plane at intersection of the optical line of sight with the Earth's surface. For images from a scanning device, refer to the centre pixel of the image.

The horizon is at 0°, straight up has an elevation of 90°.

Specified by:

get­Illumination­Elevation­Angle in interface Image­Description

Returns:

a value between -90° and +90°, or null if unspecified.

setIlluminationElevationAngle

public void setIlluminationElevationAngle(Double newValue)

Sets the illumination elevation measured in degrees clockwise from the target plane at intersection of the optical line of sight with the Earth's surface. For images from a scanning device, refer to the centre pixel of the image.

Parameters:

new­Value - the new illumination elevation angle, or null.

Throws:

Illegal­Argument­Exception - if the given value is out of range.

getIlluminationAzimuthAngle

@ValueRange(minimum=0.0,
            maximum=360.0)
public Double getIlluminationAzimuthAngle()

Returns the illumination azimuth measured in degrees clockwise from true north at the time the image is taken. For images from a scanning device, refer to the centre pixel of the image.

Specified by:

get­Illumination­Azimuth­Angle in interface Image­Description

Returns:

a value between 0° and 360°, or null if unspecified.

setIlluminationAzimuthAngle

public void setIlluminationAzimuthAngle(Double newValue)

Sets the illumination azimuth measured in degrees clockwise from true north at the time the image is taken. For images from a scanning device, refer to the centre pixel of the image.

Parameters:

new­Value - the new illumination azimuth angle, or null.

Throws:

Illegal­Argument­Exception - if the given value is out of range.

getImagingCondition

public ImagingCondition getImagingCondition()

Returns the conditions which affected the image.

Specified by:

get­Imaging­Condition in interface Image­Description

Returns:

conditions which affected the image, or null if unspecified.

setImagingCondition

public void setImagingCondition(ImagingCondition newValue)

Sets the conditions that affected the image.

Parameters:

new­Value - the new imaging condition.

getImageQualityCode

public Identifier getImageQualityCode()

Returns a code in producer’s codespace that specifies the image quality.

Specified by:

get­Image­Quality­Code in interface Image­Description

Returns:

the image quality, or null if unspecified.

setImageQualityCode

public void setImageQualityCode(Identifier newValue)

Sets a code in producer’s codespace that specifies the image quality.

Parameters:

new­Value - the new image quality code.

getCloudCoverPercentage

@ValueRange(minimum=0.0,
            maximum=100.0)
public Double getCloudCoverPercentage()

Returns the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.

Specified by:

get­Cloud­Cover­Percentage in interface Image­Description

Returns:

a value between 0 and 100, or null if unspecified.

setCloudCoverPercentage

public void setCloudCoverPercentage(Double newValue)

Sets the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.

Parameters:

new­Value - the new cloud cover percentage, or null.

Throws:

Illegal­Argument­Exception - if the given value is out of range.

getCompressionGenerationQuantity

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

Returns the count of the number of lossy compression cycles performed on the image.

Specified by:

get­Compression­Generation­Quantity in interface Image­Description

Returns:

the number of lossy compression cycles performed on the image, or null if unspecified.

setCompressionGenerationQuantity

public void setCompressionGenerationQuantity(Integer newValue)

Sets the count of the number the number of lossy compression cycles performed on the image.

Parameters:

new­Value - the new compression generation quantity.

Throws:

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

getTriangulationIndicator

public Boolean getTriangulationIndicator()

Returns the indication of whether or not triangulation has been performed upon the image.

Specified by:

get­Triangulation­Indicator in interface Image­Description

Returns:

whether or not triangulation has been performed upon the image, or null if unspecified.

setTriangulationIndicator

public void setTriangulationIndicator(Boolean newValue)

Sets the indication of whether or not triangulation has been performed upon the image.

Parameters:

new­Value - the new triangulation indicator.

isRadiometricCalibrationDataAvailable

public Boolean isRadiometricCalibrationDataAvailable()

Returns the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.

Specified by:

is­Radiometric­Calibration­Data­Available in interface Image­Description

Returns:

whether or not the radiometric calibration information is available, or null if unspecified.

setRadiometricCalibrationDataAvailable

public void setRadiometricCalibrationDataAvailable(Boolean newValue)

Sets the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.

Parameters:

new­Value - true if radiometric calibration data are available.

isCameraCalibrationInformationAvailable

public Boolean isCameraCalibrationInformationAvailable()

Returns the indication of whether or not constants are available which allow for camera calibration corrections.

Specified by:

is­Camera­Calibration­Information­Available in interface Image­Description

Returns:

whether or not constants are available for camera calibration corrections, or null if unspecified.

setCameraCalibrationInformationAvailable

public void setCameraCalibrationInformationAvailable(Boolean newValue)

Sets the indication of whether or not constants are available which allow for camera calibration corrections.

Parameters:

new­Value - true if camera calibration information are available.

isFilmDistortionInformationAvailable

public Boolean isFilmDistortionInformationAvailable()

Returns the indication of whether or not Calibration Reseau information is available.

Specified by:

is­Film­Distortion­Information­Available in interface Image­Description

Returns:

whether or not Calibration Reseau information is available, or null if unspecified.

setFilmDistortionInformationAvailable

public void setFilmDistortionInformationAvailable(Boolean newValue)

Sets the indication of whether or not Calibration Reseau information is available.

Parameters:

new­Value - true if film distortion information are available.

isLensDistortionInformationAvailable

public Boolean isLensDistortionInformationAvailable()

Returns the indication of whether or not lens aberration correction information is available.

Specified by:

is­Lens­Distortion­Information­Available in interface Image­Description

Returns:

whether or not lens aberration correction information is available, or null if unspecified.

setLensDistortionInformationAvailable

public void setLensDistortionInformationAvailable(Boolean newValue)

Sets the indication of whether or not lens aberration correction information is available.

Parameters:

new­Value - true if lens distortion information are available.