ImageDescriptionImpl (Geotools modules 28-SNAPSHOT API)

Object
- AbstractMetadata
- - ModifiableMetadata
  - - MetadataEntity
    - - ContentInformationImpl
      - CoverageDescriptionImpl
        
        ImageDescriptionImpl

All Implemented Interfaces:

Serializable, Cloneable, ContentInformation, CoverageDescription, ImageDescription
```
public class ImageDescriptionImpl
extends CoverageDescriptionImpl
implements ImageDescription
```
Information about an image's suitability for use.

Since:

2.1

Author:

Martin Desruisseaux (IRD), Touraïvane

See Also:

Serialized Form

Field Summary
- Fields inherited from class AbstractMetadata
  LOGGER

Constructor Summary

Constructors
Constructor and Description
`ImageDescriptionImpl()` Constructs an initially empty image description.
`ImageDescriptionImpl(ImageDescription source)` Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 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 Earths surface.
`Identifier`	`getImageQualityCode()` Returns the specifies the image quality.
`ImagingCondition`	`getImagingCondition()` Returns the conditions affected the image.
`Identifier`	`getProcessingLevelCode()` Returns the image distributors 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 theiIndication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.
`void`	`setCameraCalibrationInformationAvailable(Boolean newValue)` Set the indication of whether or not constants are available which allow for camera calibration corrections.
`void`	`setCloudCoverPercentage(Double newValue)` Set the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
`void`	`setCompressionGenerationQuantity(Integer newValue)` Set the count of the number the number of lossy compression cycles performed on the image.
`void`	`setFilmDistortionInformationAvailable(Boolean newValue)` Set the indication of whether or not Calibration Reseau information is available.
`void`	`setIlluminationAzimuthAngle(Double newValue)` Set the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.
`void`	`setIlluminationElevationAngle(Double newValue)` Set the illumination elevation measured in degrees clockwise from the target plane at intersection of the optical line of sight with the Earths surface.
`void`	`setImageQualityCode(Identifier newValue)` Set the specifies the image quality.
`void`	`setImagingCondition(ImagingCondition newValue)` Set the conditions affected the image.
`void`	`setLensDistortionInformationAvailable(Boolean newValue)` Set the indication of whether or not lens aberration correction information is available.
`void`	`setProcessingLevelCode(Identifier newValue)` Set the image distributors code that identifies the level of radiometric and geometric processing that has been applied.
`void`	`setRadiometricCalibrationDataAvailable(Boolean newValue)` Set the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.
`void`	`setTriangulationIndicator(Boolean newValue)` Set the indication of whether or not triangulation has been performed upon the image.

Methods inherited from class CoverageDescriptionImpl
getAttributeDescription, getContentType, getDimensions, setAttributeDescription, setContentType, setDimensions

Methods inherited from class MetadataEntity
ensureNonNull, getStandard

Methods inherited from class ModifiableMetadata
checkWritePermission, clone, copyCollection, copyList, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, unmodifiable

Methods inherited from class AbstractMetadata
asMap, asTree, equals, getInterface, hashCode, toString

Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CoverageDescription
getAttributeDescription, getContentType, getDimensions

- Constructor Detail
  - ImageDescriptionImpl
```
public ImageDescriptionImpl()
```
    Constructs an initially empty image description.
  - ImageDescriptionImpl
```
public ImageDescriptionImpl(ImageDescription source)
```
    Constructs a metadata entity initialized with the values from the specified metadata.
    
    Since:
    
    2.4
- Method Detail
  - getIlluminationElevationAngle
```
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 Earths surface. For images from a scanning device, refer to the centre pixel of the image.
    
    Specified by:
    
    getIlluminationElevationAngle in interface ImageDescription
    
    Returns:
    
    A value between -90° and +90°, or null if unspecified.
  - setIlluminationElevationAngle
```
public void setIlluminationElevationAngle(Double newValue)
```
    Set the illumination elevation measured in degrees clockwise from the target plane at intersection of the optical line of sight with the Earths surface. For images from a scanning device, refer to the centre pixel of the image.
  - getIlluminationAzimuthAngle
```
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
    
    Returns:
    
    A value between 0° and 360°, or null if unspecified.
  - setIlluminationAzimuthAngle
```
public void setIlluminationAzimuthAngle(Double newValue)
```
    Set 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.
  - getImagingCondition
```
public ImagingCondition getImagingCondition()
```
    Returns the conditions affected the image.
    
    Specified by:
    
    getImagingCondition in interface ImageDescription
    
    Returns:
    
    Conditions affected the image, or null if unknown.
  - setImagingCondition
```
public void setImagingCondition(ImagingCondition newValue)
```
    Set the conditions affected the image.
  - getImageQualityCode
```
public Identifier getImageQualityCode()
```
    Returns the specifies the image quality.
    
    Specified by:
    
    getImageQualityCode in interface ImageDescription
    
    Returns:
    
    The image quality, or null if unknown.
  - setImageQualityCode
```
public void setImageQualityCode(Identifier newValue)
```
    Set the specifies the image quality.
  - getCloudCoverPercentage
```
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
    
    Returns:
    
    A value between 0 and 100, or null if unknown.
  - setCloudCoverPercentage
```
public void setCloudCoverPercentage(Double newValue)
```
    Set the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
  - getProcessingLevelCode
```
public Identifier getProcessingLevelCode()
```
    Returns the image distributors code that identifies the level of radiometric and geometric processing that has been applied.
    
    Specified by:
    
    getProcessingLevelCode in interface ImageDescription
    
    Returns:
    
    The level of radiometric and geometric processing that has been applied, or null if unknown.
  - setProcessingLevelCode
```
public void setProcessingLevelCode(Identifier newValue)
```
    Set the image distributors code that identifies the level of radiometric and geometric processing that has been applied.
  - getCompressionGenerationQuantity
```
public Integer getCompressionGenerationQuantity()
```
    Returns the count of the number the number of lossy compression cycles performed on the image. Returns null if the information is not provided.
    
    Specified by:
    
    getCompressionGenerationQuantity in interface ImageDescription
    
    Returns:
    
    The number the number of lossy compression cycles performed on the image, or null if unknown.
  - setCompressionGenerationQuantity
```
public void setCompressionGenerationQuantity(Integer newValue)
```
    Set the count of the number the number of lossy compression cycles performed on the image.
  - 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
    
    Returns:
    
    Whether or not triangulation has been performed upon the image, or null if unknown.
  - setTriangulationIndicator
```
public void setTriangulationIndicator(Boolean newValue)
```
    Set the indication of whether or not triangulation has been performed upon the image.
  - isRadiometricCalibrationDataAvailable
```
public Boolean isRadiometricCalibrationDataAvailable()
```
    Returns theiIndication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.
    
    Specified by:
    
    isRadiometricCalibrationDataAvailable in interface ImageDescription
    
    Returns:
    
    Whether or not the radiometric calibration information is available, or null if unknown.
  - setRadiometricCalibrationDataAvailable
```
public void setRadiometricCalibrationDataAvailable(Boolean newValue)
```
    Set the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is 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
    
    Returns:
    
    Whether or not constants are available for camera calibration corrections, or null if unknown.
  - setCameraCalibrationInformationAvailable
```
public void setCameraCalibrationInformationAvailable(Boolean newValue)
```
    Set the indication of whether or not constants are available which allow for camera calibration corrections.
  - isFilmDistortionInformationAvailable
```
public Boolean isFilmDistortionInformationAvailable()
```
    Returns the indication of whether or not Calibration Reseau information is available.
    
    Specified by:
    
    isFilmDistortionInformationAvailable in interface ImageDescription
    
    Returns:
    
    Whether or not Calibration Reseau information is available, or null if unknown.
  - setFilmDistortionInformationAvailable
```
public void setFilmDistortionInformationAvailable(Boolean newValue)
```
    Set the indication of whether or not Calibration Reseau information is available.
  - isLensDistortionInformationAvailable
```
public Boolean isLensDistortionInformationAvailable()
```
    Returns the indication of whether or not lens aberration correction information is available.
    
    Specified by:
    
    isLensDistortionInformationAvailable in interface ImageDescription
    
    Returns:
    
    Whether or not lens aberration correction information is available, or null if unknown.
  - setLensDistortionInformationAvailable
```
public void setLensDistortionInformationAvailable(Boolean newValue)
```
    Set the indication of whether or not lens aberration correction information is available.

Class ImageDescriptionImpl

Field Summary

Fields inherited from class AbstractMetadata

Constructor Summary

Method Summary

Methods inherited from class CoverageDescriptionImpl

Methods inherited from class MetadataEntity

Methods inherited from class ModifiableMetadata

Methods inherited from class AbstractMetadata

Methods inherited from class Object

Methods inherited from interface CoverageDescription

Constructor Detail

ImageDescriptionImpl

ImageDescriptionImpl

Method Detail

getIlluminationElevationAngle

setIlluminationElevationAngle

getIlluminationAzimuthAngle

setIlluminationAzimuthAngle

getImagingCondition

setImagingCondition

getImageQualityCode

setImageQualityCode

getCloudCoverPercentage

setCloudCoverPercentage

getProcessingLevelCode

setProcessingLevelCode

getCompressionGenerationQuantity

setCompressionGenerationQuantity

getTriangulationIndicator

setTriangulationIndicator

isRadiometricCalibrationDataAvailable

setRadiometricCalibrationDataAvailable

isCameraCalibrationInformationAvailable

setCameraCalibrationInformationAvailable

isFilmDistortionInformationAvailable

setFilmDistortionInformationAvailable

isLensDistortionInformationAvailable

setLensDistortionInformationAvailable