setKType {photobiology}

Set the "K.type" attribute

Description

Function to set by reference the "K.type" attribute of an existing solute_spct object

Usage

setKType(x, K.type = c("attenuation", "absorption", "scattering"))

Arguments

x

a solute_spct or a summary_solute_spct object.

K.type

character A string, either "attenuation", "absorption" or "scattering".

Value

x

Note

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

See Also

Other K attribute functions: getKType()

Examples

print("missing example")