OGC Geographic Metadata

ISOImageDescription

R Documentation

ISOImageDescription

Description

ISOImageDescription

Format

R6Class object.

Value

Object of R6Class for modelling an ISOImageDescription

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> geometa::ISOAbstractContentInformation -> geometa::ISOCoverageDescription -> ISOImageDescription

Public fields

illuminationElevationAngle: illuminationElevationAngle [0..1]
illuminationAzimuthAngle: illuminationAzimuthAngle [0..1]
imagingCondition: imagingCondition [0..1]
imageQualityCode: imageQualityCode [0..1]
cloudCoverPercentage: cloudCoverPercentage [0..1]
processingLevelCode: processingLevelCode [0..1]
compressionGenerationQuantity: compressionGenerationQuantity [0..1]
triangulationIndicator: triangulationIndicator [0..1]
radiometricCalibrationDataAvailability: radiometricCalibrationDataAvailability [0..1]
cameraCalibrationInformationAvailability: cameraCalibrationInformationAvailability [0..1]
filmDistortionInformationAvailability: filmDistortionInformationAvailability [0..1]
lensDistortionInformationAvailability: lensDistortionInformationAvailability [0..1]

Methods

Public methods

ISOImageDescription$new()
ISOImageDescription$setIlluminationElevationAngle()
ISOImageDescription$setIlluminationAzimuthAngle()
ISOImageDescription$setImagingCondition()
ISOImageDescription$setImageQualityCode()
ISOImageDescription$setCloudCoverPercentage()
ISOImageDescription$setProcessingLevelCode()
ISOImageDescription$setCompressionGenerationQuantity()
ISOImageDescription$setTriangulationIndicator()
ISOImageDescription$setRadiometricCalibrationDataAvailability()
ISOImageDescription$setCameraCalibrationInformationAvailability()
ISOImageDescription$setFilmDistortionInformationAvailability()
ISOImageDescription$setLensDistortionInformationAvailability()
ISOImageDescription$clone()

Inherited methods

Method `new()`

Initializes object

Usage

ISOImageDescription$new(xml = NULL)

Arguments

xml: object of class XMLInternalNode-class

Method `setIlluminationElevationAngle()`

Set illumination elevation angle

Usage

ISOImageDescription$setIlluminationElevationAngle(illuminationElevationAngle)

Arguments

illuminationElevationAngle: object of class numeric

Method `setIlluminationAzimuthAngle()`

Set illumination azimuth angle

Usage

ISOImageDescription$setIlluminationAzimuthAngle(illuminationAzimuthAngle)

Arguments

illuminationAzimuthAngle: object of class numeric

Method `setImagingCondition()`

Set imaging condition

Usage

ISOImageDescription$setImagingCondition(imagingCondition)

Arguments

imagingCondition: object of class ISOImagingCondition or character among values returned by ISOImagingCondition$values()

Method `setImageQualityCode()`

Set image quality code

Usage

ISOImageDescription$setImageQualityCode(code)

Arguments

code: object of class ISOMetaIdentifier

Method `setCloudCoverPercentage()`

Set cloud cover percentage

Usage

ISOImageDescription$setCloudCoverPercentage(cloudCoverPercentage)

Arguments

cloudCoverPercentage: object of class numeric

Method `setProcessingLevelCode()`

Set processing level code

Usage

ISOImageDescription$setProcessingLevelCode(code)

Arguments

code: object of class ISOMetaIdentifier

Method `setCompressionGenerationQuantity()`

Set compression generation quantity

Usage

ISOImageDescription$setCompressionGenerationQuantity(quantity)

Arguments

quantity: object of class integer

Method `setTriangulationIndicator()`

Set triangulation indicator

Usage

ISOImageDescription$setTriangulationIndicator(triangulationIndicator)

Arguments

triangulationIndicator: object of class logical

Method `setRadiometricCalibrationDataAvailability()`

Set radiometric calibration data availability

Usage

ISOImageDescription$setRadiometricCalibrationDataAvailability(
  radiometricCalibrationDataAvailability
)

Arguments

radiometricCalibrationDataAvailability: object of class logical

Method `setCameraCalibrationInformationAvailability()`

Set camera calibration information availability

Usage

ISOImageDescription$setCameraCalibrationInformationAvailability(
  cameraCalibrationInformationAvailability
)

Arguments

cameraCalibrationInformationAvailability: object of class logical

Method `setFilmDistortionInformationAvailability()`

Set film distortion information availability

Usage

ISOImageDescription$setFilmDistortionInformationAvailability(
  filmDistortionInformationAvailability
)

Arguments

filmDistortionInformationAvailability: object of class logical

Method `setLensDistortionInformationAvailability()`

Set lens distortion information availability

Usage

ISOImageDescription$setLensDistortionInformationAvailability(
  lensDistortionInformationAvailability
)

Arguments

lensDistortionInformationAvailability: object of class logical

Method `clone()`

The objects of this class are cloneable with this method.

Usage

ISOImageDescription$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.

Author(s)

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

References

- ISO 19139 https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_MD_ImageDescription

- ISO 19115-3 https://schemas.isotc211.org/19115/-3/mrc/1.0/mrc/#element_MD_ImageDescription

Examples

   #create image description
   md <- ISOImageDescription$new()
   md$setAttributeDescription("test")
   md$setContentType("modelResult")
   
   #adding 3 arbitrary dimensions
   for(i in 1:3){
      band <- ISOBand$new()
      mn <- ISOMemberName$new(aName = sprintf("name %s",i), attributeType = sprintf("type %s",i))
      band$setSequenceIdentifier(mn)
      band$setDescriptor("descriptor")
      band$setMaxValue(10)
      band$setMinValue(1)
      gml <- GMLBaseUnit$new(id = sprintf("ID%s",i))
      gml$setDescriptionReference("someref")
      gml$setIdentifier("identifier", "codespace")
      gml$addName("name1", "codespace")
      gml$addName("name2", "codespace")
      gml$setQuantityTypeReference("someref")
      gml$setCatalogSymbol("symbol")
      gml$setUnitsSystem("somelink")
      band$setUnits(gml)
      band$setPeakResponse(9)
      band$setBitsPerValue(5)
      band$setToneGradation(100)
      band$setScaleFactor(1)
      band$setOffset(4)
      md$addDimension(band)
   }
   
   md$setIlluminationElevationAngle(15)
   md$setIlluminationAzimuthAngle(10)
   md$setImagingCondition("rain")
   md$setImageQualityCode("bad")
   md$setCloudCoverPercentage(90)
   md$setProcessingLevelCode("high")
   md$setCompressionGenerationQuantity(1L)
   md$setTriangulationIndicator(FALSE)
   md$setRadiometricCalibrationDataAvailability(FALSE)
   md$setCameraCalibrationInformationAvailability(FALSE)
   md$setFilmDistortionInformationAvailability(FALSE)
   md$setLensDistortionInformationAvailability(FALSE)
   
   xml <- md$encode()

eblondel/geometa documentation built on Oct. 10, 2024, 4:46 p.m.

eblondel/geometa index

README.md

rdrr.io home R language documentation Run R code online

CRAN packages Bioconductor packages R-Forge packages GitHub packages

Note that we can't provide technical support on individual packages. You should contact the package authors for that.

eblondel/geometa Tools for Reading and Writing ISO/OGC Geographic Metadata

ISOImageDescription: ISOImageDescription In eblondel/geometa: Tools for Reading and Writing ISO/OGC Geographic Metadata