photobiology (version 0.9.4)

absorptance.filter_mspct: Absorptance

Description

Function to calculate the mean, total, or other summary of absorptance for spectral data stored in a filter_spct or in an object_spct. Absorptance is a different quantity than absorbance.

Usage

## S3 method for class 'filter_mspct':
absorptance(spct, w.band = NULL,
  quantity = "average", wb.trim = getOption("photobiology.waveband.trim",
  default = TRUE), use.hinges = getOption("photobiology.use.hinges", default =
  NULL), ..., idx = !is.null(names(spct)))

## S3 method for class 'object_mspct':
absorptance(spct, w.band = NULL,
  quantity = "average", wb.trim = getOption("photobiology.waveband.trim",
  default = TRUE), use.hinges = getOption("photobiology.use.hinges", default =
  NULL), ..., idx = !is.null(names(spct)))

absorptance(spct, w.band, quantity, wb.trim, use.hinges, ...)

## S3 method for class 'default':
absorptance(spct, w.band, quantity, wb.trim, use.hinges, ...)

## S3 method for class 'object_spct':
absorptance(spct, w.band = NULL, quantity = "average",
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.hinges = getOption("photobiology.use.hinges", default = NULL), ...)

## S3 method for class 'filter_spct':
absorptance(spct, w.band = NULL, quantity = "average",
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.hinges = getOption("photobiology.use.hinges", default = NULL), ...)

Arguments

spct

an R object

w.band

waveband or list of waveband objects The waveband(s) determine the region(s) of the spectrum that are summarized.

quantity

character

wb.trim

logical Flag if wavebands crossing spectral data boundaries are trimmed or ignored

use.hinges

logical Flag indicating whether to use hinges to reduce interpolation errors

...

other arguments (possibly ignored)

idx

logical whether to add a column with the names of the elements of spct

Value

• A single numeric value with no change in scale factor, except in the case of percentages (absorptance is the fraction absorbed)

Methods (by class)

• filter_mspct: Calculates absorptance from afilter_mspct
• object_mspct: Calculates absorptance from aobject_mspct
• default: Default for generic function
• object_spct: Specialization for object spectra
• filter_spct: Specialization for filter spectra

Examples

absorptance(yellow_gel.spct, new_waveband(400,500))
absorptance(yellow_gel.spct, new_waveband(300,400))