photobiology (version 0.9.6)

transmittance: Transmittance

Description

Summary transmittance for supplied wavebands from filter or object spectrum.

Usage

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

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

## S3 method for class 'filter_spct':
transmittance(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 'object_spct':
transmittance(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_mspct':
transmittance(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':
transmittance(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)))

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 indicating 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

idx

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

Value

• A numeric vector with no change in scale factor

Methods (by class)

• default: Default method
• filter_spct: Method for filter spectra
• object_spct: Method for object spectra
• filter_mspct: Calculates transmittance from afilter_mspct
• object_mspct: Calculates transmittance from aobject_mspct

Examples

transmittance(polyester.spct, waveband(c(280, 315)))
transmittance(polyester.spct, waveband(c(315, 400)))
transmittance(polyester.spct, waveband(c(400, 700)))