photobiology: Afr2T – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Afr2T

Convert transmittance into absorptance.

Description

Function that converts transmittance (fraction) into absorptance (fraction). If reflectance (fraction) is available, it allows conversions between internal and total absorptance.

Usage

Afr2T(x, action, byref, clean, ...)

## Default S3 method:
Afr2T(x, action = NULL, byref = FALSE, clean = FALSE, ...)

## S3 method for class 'numeric'
Afr2T(x, action = NULL, byref = FALSE, clean = FALSE, Rfr = NA_real_, ...)

## S3 method for class 'filter_spct'
Afr2T(x, action = "add", byref = FALSE, clean = FALSE, ...)

## S3 method for class 'object_spct'
Afr2T(x, action = "add", byref = FALSE, clean = FALSE, ...)

## S3 method for class 'filter_mspct'
Afr2T(
  x,
  action = "add",
  byref = FALSE,
  clean = FALSE,
  ...,
  .parallel = FALSE,
  .paropts = NULL
)

## S3 method for class 'object_mspct'
Afr2T(
  x,
  action = "add",
  byref = FALSE,
  clean = FALSE,
  ...,
  .parallel = FALSE,
  .paropts = NULL
)

Arguments

`x`	an R object
`action`	character Allowed values "replace" and "add"
`byref`	logical indicating if new object will be created by reference or by copy of x
`clean`	logical replace off-boundary values before conversion
`...`	not used in current version
`Rfr`	numeric vector. Spectral reflectance o reflectance factor. Set to zero if `x` is internal reflectance,
`.parallel`	if TRUE, apply function in parallel, using parallel backend provided by foreach
`.paropts`	a list of additional options passed into the foreach function when parallel computation is enabled. This is important if (for example) your code relies on external data or packages: use the .export and .packages arguments to supply them so that all cluster nodes have the correct environment set up for computing.

Value

A copy of x with a column Tfr added and other columns possibly deleted except for w.length. If action = "replace", in all cases, the additional columns are removed, even if no column needs to be added.

Methods (by class)

default: Default method for generic function
numeric: Default method for generic function
filter_spct: Method for filter spectra
object_spct: Method for object spectra
filter_mspct: Method for collections of filter spectra
object_mspct: Method for collections of object spectra

Examples

T2Afr(Ler_leaf.spct)

photobiology

Photobiological Calculations

v0.10.10

GPL (>= 2)

Authors

Pedro J. Aphalo [aut, cre] (<https://orcid.org/0000-0003-3385-972X>), Titta K. Kotilainen [ctb] (<https://orcid.org/0000-0002-2822-9734>), Glenn Davis [ctb], Agnese Fazio [ctb]

Initial release

2022-03-24