ISOImageryBand: ISOImageryBand

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

ISOImageryBand

Description

ISOImageryBand

ISOImageryBand

Format

R6Class object.

Value

Object of R6Class for modelling an ISO imagery band

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> geometa::ISORangeDimension -> geometa::ISOBand -> ISOImageryBand

Public fields

bandBoundaryDefinition

bandBoundaryDefinition [0..1]: ISOImageryBandDefinition

nominalSpatialResolution

nominalSpatialResolution [0..1] ISOBaseReal

transferFunctionType

transferFunctionType [0..1]: ISOImageryTransferFunctionType

transmittedPolarisation

transmittedPolarisation [0..1]: ISOImageryPolarisationOrientation

detectedPolarisation

detectedPolarisation [0..1]: ISOImageryPolarisationOrientation

Methods

Public methods

• ISOImageryBand$new()

• ISOImageryBand$setBandBoundaryDefinition()

• ISOImageryBand$setNominalSpatialResolution()

• ISOImageryBand$setTransferFunctionType()

• ISOImageryBand$setTransmittedPolarisation()

• ISOImageryBand$setDetectedPolarisation()

• ISOImageryBand$clone()

Inherited methods

• geometa::geometaLogger$ERROR()
• geometa::geometaLogger$INFO()
• geometa::geometaLogger$WARN()
• geometa::ISOAbstractObject$addFieldAttrs()
• geometa::ISOAbstractObject$addListElement()
• geometa::ISOAbstractObject$checkMetadataStandardCompliance()
• geometa::ISOAbstractObject$contains()
• geometa::ISOAbstractObject$createLocalisedProperty()
• geometa::ISOAbstractObject$decode()
• geometa::ISOAbstractObject$delListElement()
• geometa::ISOAbstractObject$encode()
• geometa::ISOAbstractObject$getClass()
• geometa::ISOAbstractObject$getClassName()
• geometa::ISOAbstractObject$getNamespaceDefinition()
• geometa::ISOAbstractObject$isDocument()
• geometa::ISOAbstractObject$isFieldInheritedFrom()
• geometa::ISOAbstractObject$print()
• geometa::ISOAbstractObject$save()
• geometa::ISOAbstractObject$setAttr()
• geometa::ISOAbstractObject$setCodeList()
• geometa::ISOAbstractObject$setCodeListValue()
• geometa::ISOAbstractObject$setCodeSpace()
• geometa::ISOAbstractObject$setHref()
• geometa::ISOAbstractObject$setId()
• geometa::ISOAbstractObject$setIsNull()
• geometa::ISOAbstractObject$setValue()
• geometa::ISOAbstractObject$stopIfMetadataStandardIsNot()
• geometa::ISOAbstractObject$validate()
• geometa::ISOAbstractObject$wrapBaseElement()
• geometa::ISORangeDimension$setDescription()
• geometa::ISORangeDimension$setDescriptor()
• geometa::ISORangeDimension$setName()
• geometa::ISORangeDimension$setSequenceIdentifier()
• geometa::ISOBand$setBitsPerValue()
• geometa::ISOBand$setMaxValue()
• geometa::ISOBand$setMinValue()
• geometa::ISOBand$setOffset()
• geometa::ISOBand$setPeakResponse()
• geometa::ISOBand$setScaleFactor()
• geometa::ISOBand$setToneGradation()
• geometa::ISOBand$setUnits()

---

Method new()

Initializes object

Usage

ISOImageryBand$new(xml = NULL)

Arguments

xml

object of class XMLInternalNode-class

---

Method setBandBoundaryDefinition()

Set band boundary definition

Usage

ISOImageryBand$setBandBoundaryDefinition(definition)

Arguments

definition

object of class ISOImageryBandDefinition or character among values returned by ISOImageryBandDefinition$values()

---

Method setNominalSpatialResolution()

Set nominal spatial resolution

Usage

ISOImageryBand$setNominalSpatialResolution(resolution)

Arguments

resolution

object of class numeric

---

Method setTransferFunctionType()

Set transfer function type

Usage

ISOImageryBand$setTransferFunctionType(functionType)

Arguments

functionType

object of class ISOImageryTransferFunctionType or any character from values returned by ISOImageryTransferFunctionType$values()

---

Method setTransmittedPolarisation()

Set transmitted polarisation

Usage

ISOImageryBand$setTransmittedPolarisation(polarisation)

Arguments

polarisation

object of class ISOImageryPolarisationOrientation or any character from values returned by ISOImageryPolarisationOrientation$values()

---

Method setDetectedPolarisation()

Set detected polarisation

Usage

ISOImageryBand$setDetectedPolarisation(polarisation)

Arguments

polarisation

object of class ISOImageryPolarisationOrientation or any character from values returned by ISOImageryPolarisationOrientation$values()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ISOImageryBand$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <[e-mail]>

References

- ISO 19139 https://schemas.isotc211.org/19115/-2/gmi/1.0/gmi/#element_MI_Band

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

Examples

   #create band range dimension
   md <- ISOImageryBand$new()
   md$setSequenceIdentifier(ISOMemberName$new(aName = "name", attributeType = "type"))
   md$setDescriptor("descriptor")
   md$setMaxValue(10)
   md$setMinValue(1)
   gml <- GMLBaseUnit$new(id = "ID")
   gml$setDescriptionReference("someref")
   gml$setIdentifier("identifier", "codespace")
   gml$addName("name1", "codespace")
   gml$addName("name2", "codespace")
   gml$setQuantityTypeReference("someref")
   gml$setCatalogSymbol("symbol")
   gml$setUnitsSystem("somelink")
   md$setUnits(gml)
   md$setPeakResponse(9)
   md$setBitsPerValue(5)
   md$setToneGradation(100)
   md$setScaleFactor(1)
   md$setOffset(4)
   
   md$setBandBoundaryDefinition("fiftyPercent")
   md$setNominalSpatialResolution(14.5)
   md$setTransferFunctionType("linear")
   md$setTransmittedPolarisation("horizontal")
   md$setDetectedPolarisation("horizontal")
   
   xml <- md$encode()

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