as.filter_spct: Coerce or convert into a filter spectrum

In photobiology: Photobiological Calculations

Coerce or convert into a filter spectrum

Description

Return a possibly modified copy of an R object with its class set to a filter spectrum. In the case of conversion from a solute_spct object, compute the spectral quantity based on additional input from user.

Usage

as.filter_spct(x, ...)

## Default S3 method:
as.filter_spct(
  x,
  Tfr.type = c("total", "internal"),
  strict.range = getOption("photobiology.strict.range", default = FALSE),
  ...
)

## S3 method for class 'solute_spct'
as.filter_spct(
  x,
  Tfr.type = "internal",
  strict.range = getOption("photobiology.strict.range", default = FALSE),
  Rfr.constant = NA_real_,
  comment = NULL,
  molar.concentration = NULL,
  mass.concentration = NULL,
  path.length = 1,
  ...
)

Arguments

x	an R object.
...	other arguments passed to "set" functions.
Tfr.type	a character string, either "total" or "internal".
strict.range	logical Flag indicating whether off-range values result in an error instead of a warning.
Rfr.constant	numeric The value of the reflection factor (/1) to be set.
comment	character A string to be added as a comment attribute to the object created. If not supplied, the comment will be copied from x.
molar.concentration, mass.concentration	numeric Concentration to be used to compute transmittance of the solute in solution [mol\,m^{-3} = mmol\,dm^{-3} or kg\,m^{-3} = g\,dm^{-3}, respectively].
path.length	numeric The length of the light path (m) used to compute transmittance of the solute in a solution.

Value

A copy of x converted into a filter_spct. object.

Methods (by class)

• as.filter_spct(default):

• as.filter_spct(solute_spct):

See Also

setGenericSpct

Other constructors of spectral objects: as.calibration_spct(), as.chroma_spct(), as.cps_spct(), as.generic_spct(), as.object_spct(), as.raw_spct(), as.reflector_spct(), as.response_spct(), as.solute_spct(), as.source_spct(), source_spct()

photobiology documentation built on June 8, 2025, 10:14 a.m.