setRfrType: Set the "Rfr.type" attribute

In photobiology: Photobiological Calculations

Set the "Rfr.type" attribute

Description

Function to set by reference the "Rfr.type" attribute of an existing reflector_spct or object_spct object.

Usage

setRfrType(x, Rfr.type = c("total", "specular"))

Arguments

x	a reflector_spct or an object_spct object
Rfr.type	a character string, either "total" or "specular"

Value

x

Note

This function alters x itself by reference and in addition returns x invisibly. If x is not a reflector_spct or object_spct object, x is not modified. The behaviour of this function is 'unusual' in that the default for parameter Rfr.type is used only if x does not already have this attribute set.

See Also

Other Rfr attribute functions: getRfrType()

Examples

my.spct <- reflector_spct(w.length = 400:409, Rfr = 0.1)
getRfrType(my.spct)
setRfrType(my.spct, "specular")
getRfrType(my.spct)

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