ISOBand: ISOBand

ISOBandR Documentation

ISOBand

Description

ISOBand

ISOBand

Format

R6Class object.

Value

Object of R6Class for modelling an ISOBand

Super classes

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

Public fields

maxValue

maxValue [0..1] : numeric

minValue

minValue [0..1] : numeric

units

units [0..1] : GMLUnitDefinition

peakResponse

peakResponse [0..1] : numeric

bitsPerValue

bitsPerValue [0..1] : integer

toneGradation

toneGradation [0..1] : integer

scaleFactor

scaleFactor [0..1] : numeric

offset

offset [0..1] : numeric

Methods

Public methods

Inherited methods

Method new()

Initializes object

Usage
ISOBand$new(xml = NULL)
Arguments
xml

object of class XMLInternalNode-class


Method setMaxValue()

Set max value

Usage
ISOBand$setMaxValue(maxValue)
Arguments
maxValue

max value, object of class numeric


Method setMinValue()

Set min value

Usage
ISOBand$setMinValue(minValue)
Arguments
minValue

min value, object of class numeric


Method setUnits()

Set unit definition

Usage
ISOBand$setUnits(uom)
Arguments
uom

object of class GMLUnitDefinition


Method setPeakResponse()

Set peak response

Usage
ISOBand$setPeakResponse(peakResponse)
Arguments
peakResponse

object of class numeric


Method setBitsPerValue()

Set bits per value

Usage
ISOBand$setBitsPerValue(bitsPerValue)
Arguments
bitsPerValue

object of class numeric


Method setToneGradation()

Set tone gradation

Usage
ISOBand$setToneGradation(toneGradation)
Arguments
toneGradation

object of class numeric


Method setScaleFactor()

Set scale factor

Usage
ISOBand$setScaleFactor(scaleFactor)
Arguments
scaleFactor

object of class numeric


Method setOffset()

Set offset

Usage
ISOBand$setOffset(offset)
Arguments
offset

object of class numeric


Method clone()

The objects of this class are cloneable with this method.

Usage
ISOBand$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

Examples

   #create band range dimension
   md <- ISOBand$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)
   xml <- md$encode()


geometa documentation built on May 29, 2024, 10:31 a.m.