org.geotoolkit.metadata.iso.content
Class DefaultImageDescription

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractContentInformation
                  DefaultCoverageDescription
                      DefaultImageDescription

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, ContentInformation, CoverageDescription, ImageDescription

@ThreadSafe
public class DefaultImageDescription
extends DefaultCoverageDescription
implements ImageDescription

Information about an image's suitability for use.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultImageDescription()
Constructs an initially empty image description.

DefaultImageDescription(ImageDescription source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultImageDescription	castOrCopy(ImageDescription object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Double	getCloudCoverPercentage() Returns the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
Integer	getCompressionGenerationQuantity() Returns the count of the number of lossy compression cycles performed on the image.
Double	getIlluminationAzimuthAngle() Returns the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.
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.
Identifier	getImageQualityCode() Returns the identifier that specifies the image quality.
ImagingCondition	getImagingCondition() Returns the conditions affected the image.
Identifier	getProcessingLevelCode() Returns the image distributor's code that identifies the level of radiometric and geometric processing that has been applied.
Boolean	getTriangulationIndicator() Returns the indication of whether or not triangulation has been performed upon the image.
Boolean	isCameraCalibrationInformationAvailable() Returns the indication of whether or not constants are available which allow for camera calibration corrections.
Boolean	isFilmDistortionInformationAvailable() Returns the indication of whether or not Calibration Reseau information is available.
Boolean	isLensDistortionInformationAvailable() Returns the indication of whether or not lens aberration correction information is available.
Boolean	isRadiometricCalibrationDataAvailable() Returns the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.
void	setCameraCalibrationInformationAvailable(Boolean newValue) Sets the indication of whether or not constants are available which allow for camera calibration corrections.
void	setCloudCoverPercentage(Double newValue) Sets the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
void	setCompressionGenerationQuantity(Integer newValue) Sets the count of the number the number of lossy compression cycles performed on the image.
void	setFilmDistortionInformationAvailable(Boolean newValue) Sets the indication of whether or not Calibration Reseau information is available.
void	setIlluminationAzimuthAngle(Double newValue) Sets the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.
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.
void	setImageQualityCode(Identifier newValue) Sets the identifier that specifies the image quality.
void	setImagingCondition(ImagingCondition newValue) Sets the conditions affected the image.
void	setLensDistortionInformationAvailable(Boolean newValue) Sets the indication of whether or not lens aberration correction information is available.
void	setProcessingLevelCode(Identifier newValue) Sets the image distributor's code that identifies the level of radiometric and geometric processing that has been applied.
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.
void	setTriangulationIndicator(Boolean newValue) Sets the indication of whether or not triangulation has been performed upon the image.

Methods inherited from class DefaultCoverageDescription

castOrCopy, getAttributeDescription, getContentType, getDimensions, getRangeElementDescriptions, setAttributeDescription, setContentType, setDimensions, setRangeElementDescriptions

Methods inherited from class AbstractContentInformation

castOrCopy

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CoverageDescription

getAttributeDescription, getContentType, getDimensions, getRangeElementDescriptions

Constructor Detail

DefaultImageDescription

public DefaultImageDescription()

Constructs an initially empty image description.

DefaultImageDescription

public DefaultImageDescription(ImageDescription source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

Method Detail

castOrCopy

public static DefaultImageDescription castOrCopy(ImageDescription object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

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

Since:

3.18

getIlluminationElevationAngle

@ValueRange(minimum=0.0,
            maximum=180.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:

getIlluminationElevationAngle in interface ImageDescription

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:

newValue - The new illumination elevation angle.

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:

getIlluminationAzimuthAngle in interface ImageDescription

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:

newValue - The new illumination azimuth angle.

getImagingCondition

public ImagingCondition getImagingCondition()

Returns the conditions affected the image.

Specified by:

getImagingCondition in interface ImageDescription

setImagingCondition

public void setImagingCondition(ImagingCondition newValue)

Sets the conditions affected the image.

Parameters:

newValue - The new imaging condition.

getImageQualityCode

public Identifier getImageQualityCode()

Returns the identifier that specifies the image quality.

Specified by:

getImageQualityCode in interface ImageDescription

setImageQualityCode

public void setImageQualityCode(Identifier newValue)

Sets the identifier that specifies the image quality.

Parameters:

newValue - 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:

getCloudCoverPercentage in interface ImageDescription

setCloudCoverPercentage

public void setCloudCoverPercentage(Double newValue)

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

Parameters:

newValue - The new cloud cover percentage.

getProcessingLevelCode

public Identifier getProcessingLevelCode()

Returns the image distributor's code that identifies the level of radiometric and geometric processing that has been applied.

Specified by:

getProcessingLevelCode in interface ImageDescription

setProcessingLevelCode

public void setProcessingLevelCode(Identifier newValue)

Sets the image distributor's code that identifies the level of radiometric and geometric processing that has been applied.

Parameters:

newValue - The new processing level code.

getCompressionGenerationQuantity

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

Returns the count of the number of lossy compression cycles performed on the image. Returns null if the information is not provided.

Specified by:

getCompressionGenerationQuantity in interface ImageDescription

setCompressionGenerationQuantity

public void setCompressionGenerationQuantity(Integer newValue)

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

Parameters:

newValue - The new compression generation quantity.

getTriangulationIndicator

public Boolean getTriangulationIndicator()

Returns the indication of whether or not triangulation has been performed upon the image. Returns null if the information is not provided.

Specified by:

getTriangulationIndicator in interface ImageDescription

setTriangulationIndicator

public void setTriangulationIndicator(Boolean newValue)

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

Parameters:

newValue - 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:

isRadiometricCalibrationDataAvailable in interface ImageDescription

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:

newValue - 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:

isCameraCalibrationInformationAvailable in interface ImageDescription

setCameraCalibrationInformationAvailable

public void setCameraCalibrationInformationAvailable(Boolean newValue)

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

Parameters:

newValue - 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:

isFilmDistortionInformationAvailable in interface ImageDescription

setFilmDistortionInformationAvailable

public void setFilmDistortionInformationAvailable(Boolean newValue)

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

Parameters:

newValue - 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:

isLensDistortionInformationAvailable in interface ImageDescription

setLensDistortionInformationAvailable

public void setLensDistortionInformationAvailable(Boolean newValue)

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

Parameters:

newValue - true if lens distortion information are available.