setBSWFUsed: Set the "bswf.used" attribute

View source: R/spct.classes.r

setBSWFUsedR Documentation

Set the "bswf.used" attribute

Description

Function to set by reference the "time.unit" attribute of an existing source_spct object

Usage

setBSWFUsed(x, bswf.used = c("none", "unknown"))

Arguments

x

a source_spct object

bswf.used

a character string, either "none" or the name of a BSWF

Value

x

Note

This function alters x itself by reference and in addition returns x invisibly. If x is not a source_spct, x is not modified. The behaviour of this function is 'unusual' in that the default for parameter bswf.used is used only if x does not already have this attribute set. time.unit = "hour" is currently not fully supported.

See Also

Other BSWF attribute functions: getBSWFUsed()


photobiology documentation built on Oct. 21, 2023, 1:06 a.m.