Class DefaultImageDescription
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractContentInformation
DefaultCoverageDescription
DefaultImageDescription
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- ContentInformation,- CoverageDescription,- ImageDescription
Information about an image's suitability for use.
 The following property is mandatory in a well-formed metadata according ISO 19115:
 
 
MD_ImageDescription
   └─attributeDescription…… 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 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 image description.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultImageDescriptioncastOrCopy(ImageDescription object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.Returns the count of the number of lossy compression cycles performed on the image.Returns the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.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.Returns a code in producer’s codespace that specifies the image quality.Returns the conditions which affected the image.Returns the indication of whether or not triangulation has been performed upon the image.Returns the indication of whether or not constants are available which allow for camera calibration corrections.Returns the indication of whether or not Calibration Reseau information is available.Returns the indication of whether or not lens aberration correction information is available.Returns the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.voidSets the indication of whether or not constants are available which allow for camera calibration corrections.voidsetCloudCoverPercentage(Double newValue) Sets the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.voidsetCompressionGenerationQuantity(Integer newValue) Sets the count of the number the number of lossy compression cycles performed on the image.voidsetFilmDistortionInformationAvailable(Boolean newValue) Sets the indication of whether or not Calibration Reseau information is available.voidsetIlluminationAzimuthAngle(Double newValue) Sets the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.voidsetIlluminationElevationAngle(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.voidsetImageQualityCode(Identifier newValue) Sets a code in producer’s codespace that specifies the image quality.voidsetImagingCondition(ImagingCondition newValue) Sets the conditions that affected the image.voidsetLensDistortionInformationAvailable(Boolean newValue) Sets the indication of whether or not lens aberration correction information is available.voidSets the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.voidsetTriangulationIndicator(Boolean newValue) Sets the indication of whether or not triangulation has been performed upon the image.Methods inherited from class DefaultCoverageDescriptioncastOrCopy, getAttributeDescription, getAttributeGroups, getContentType, getDimensions, getProcessingLevelCode, getRangeElementDescriptions, setAttributeDescription, setAttributeGroups, setContentType, setDimensions, setProcessingLevelCode, setRangeElementDescriptionsMethods inherited from class AbstractContentInformationcastOrCopyMethods 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 CoverageDescriptiongetAttributeDescription, getContentType, getDimensions, getRangeElementDescriptionsMethods inherited from interface ImageDescriptiongetProcessingLevelCode
- 
Constructor Details- 
DefaultImageDescriptionpublic DefaultImageDescription()Constructs an initially empty image description.
- 
DefaultImageDescriptionConstructs 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- 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
       DefaultImageDescription, then it is returned unchanged.
- Otherwise a new DefaultImageDescriptioninstance 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 
- 
getIlluminationElevationAngleReturns 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:
- getIlluminationElevationAnglein interface- ImageDescription
- Returns:
- a value between -90° and +90°, or nullif unspecified.
 
- 
setIlluminationElevationAngleSets 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, or- null.
- Throws:
- IllegalArgumentException- if the given value is out of range.
 
- 
getIlluminationAzimuthAngleReturns 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:
- getIlluminationAzimuthAnglein interface- ImageDescription
- Returns:
- a value between 0° and 360°, or nullif unspecified.
 
- 
setIlluminationAzimuthAngleSets 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, or- null.
- Throws:
- IllegalArgumentException- if the given value is out of range.
 
- 
getImagingConditionReturns the conditions which affected the image.- Specified by:
- getImagingConditionin interface- ImageDescription
- Returns:
- conditions which affected the image, or nullif unspecified.
 
- 
setImagingConditionSets the conditions that affected the image.- Parameters:
- newValue- the new imaging condition.
 
- 
getImageQualityCodeReturns a code in producer’s codespace that specifies the image quality.- Specified by:
- getImageQualityCodein interface- ImageDescription
- Returns:
- the image quality, or nullif unspecified.
 
- 
setImageQualityCodeSets a code in producer’s codespace that specifies the image quality.- Parameters:
- newValue- the new image quality code.
 
- 
getCloudCoverPercentageReturns the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.- Specified by:
- getCloudCoverPercentagein interface- ImageDescription
- Returns:
- a value between 0 and 100, or nullif unspecified.
 
- 
setCloudCoverPercentageSets the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.- Parameters:
- newValue- the new cloud cover percentage, or- null.
- Throws:
- IllegalArgumentException- if the given value is out of range.
 
- 
getCompressionGenerationQuantityReturns the count of the number of lossy compression cycles performed on the image.- Specified by:
- getCompressionGenerationQuantityin interface- ImageDescription
- Returns:
- the number of lossy compression cycles performed on the image, or nullif unspecified.
 
- 
setCompressionGenerationQuantitySets the count of the number the number of lossy compression cycles performed on the image.- Parameters:
- newValue- the new compression generation quantity.
- Throws:
- IllegalArgumentException- if the given value is negative.
 
- 
getTriangulationIndicatorReturns the indication of whether or not triangulation has been performed upon the image.- Specified by:
- getTriangulationIndicatorin interface- ImageDescription
- Returns:
- whether or not triangulation has been performed upon the image, or nullif unspecified.
 
- 
setTriangulationIndicatorSets the indication of whether or not triangulation has been performed upon the image.- Parameters:
- newValue- the new triangulation indicator.
 
- 
isRadiometricCalibrationDataAvailableReturns the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.- Specified by:
- isRadiometricCalibrationDataAvailablein interface- ImageDescription
- Returns:
- whether or not the radiometric calibration information is available, or nullif unspecified.
 
- 
setRadiometricCalibrationDataAvailableSets the indication of whether or not the radiometric calibration information for generating the radiometrically calibrated standard data product is available.- Parameters:
- newValue-- trueif radiometric calibration data are available.
 
- 
isCameraCalibrationInformationAvailableReturns the indication of whether or not constants are available which allow for camera calibration corrections.- Specified by:
- isCameraCalibrationInformationAvailablein interface- ImageDescription
- Returns:
- whether or not constants are available for camera calibration corrections, or nullif unspecified.
 
- 
setCameraCalibrationInformationAvailableSets the indication of whether or not constants are available which allow for camera calibration corrections.- Parameters:
- newValue-- trueif camera calibration information are available.
 
- 
isFilmDistortionInformationAvailableReturns the indication of whether or not Calibration Reseau information is available.- Specified by:
- isFilmDistortionInformationAvailablein interface- ImageDescription
- Returns:
- whether or not Calibration Reseau information is available, or nullif unspecified.
 
- 
setFilmDistortionInformationAvailableSets the indication of whether or not Calibration Reseau information is available.- Parameters:
- newValue-- trueif film distortion information are available.
 
- 
isLensDistortionInformationAvailableReturns the indication of whether or not lens aberration correction information is available.- Specified by:
- isLensDistortionInformationAvailablein interface- ImageDescription
- Returns:
- whether or not lens aberration correction information is available, or nullif unspecified.
 
- 
setLensDistortionInformationAvailableSets the indication of whether or not lens aberration correction information is available.- Parameters:
- newValue-- trueif lens distortion information are available.
 
 
-