Skip to contents

Function to set the "how.measured" attribute of an existing generic_spct, generic_mspct, summary_generic_spct, data.frame or a derived-class object.

Usage

setHowMeasured(x, ...)

how_measured(x) <- value

# Default S3 method
setHowMeasured(x, how.measured, ...)

# S3 method for class 'generic_spct'
setHowMeasured(x, how.measured, ...)

# S3 method for class 'summary_generic_spct'
setHowMeasured(x, how.measured, ...)

# S3 method for class 'data.frame'
setHowMeasured(x, how.measured, ...)

# S3 method for class 'generic_mspct'
setHowMeasured(x, how.measured, ...)

Arguments

x

a R object

...

Allows use of additional arguments in methods for other classes.

how.measured, value

a list or a character string.

Value

x modified by reference.

Methods (by class)

  • setHowMeasured(default): default

  • setHowMeasured(generic_spct): generic_spct

  • setHowMeasured(summary_generic_spct): summary_generic_spct

  • setHowMeasured(data.frame): data.frame

  • setHowMeasured(generic_mspct): generic_mspct

Note

This function alters x itself by reference and in addition returns x invisibly. If x is not an object of a supported class, x is silently returned unchanged.

Examples


my.spct <- sun.spct
how_measured(my.spct)
#> [1] "Simulated using 'libRadtran'. Average for one hour, centred approximately on local solar noon."
how_measured(my.spct) <- "simulated with a radiation transfer model"
how_measured(my.spct)
#> [1] "simulated with a radiation transfer model"