Learn R Programming

photobiology (version 0.9.16)

absorbance: Absorbance

Description

Function to calculate the mean, total, or other summary of absorbance for spectral data stored in a filter_spct or in an object_spct.

Usage

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

# S3 method for default absorbance(spct, w.band, quantity, wb.trim, use.hinges, ...)

# S3 method for filter_spct absorbance(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 object_spct absorbance(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 filter_mspct absorbance(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 object_mspct absorbance(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 or a numeric vector of length two. The waveband(s) determine the region(s) of the spectrum that are summarized. If a numeric range is supplied a waveband object is constructed on the fly from it.

quantity

character string One of "average" or "mean", "total", "contribution", "contribution.pc", "relative" or "relative.pc"

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 (possibly ignored)

idx

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

Methods (by class)

  • default: Default for generic function

  • filter_spct: Specialization for filter spectra

  • object_spct: Specialization for object spectra

  • filter_mspct: Calculates absorbance from a filter_mspct

  • object_mspct: Calculates absorbance from a object_mspct

Examples

Run this code
# NOT RUN {
absorbance(polyester.spct, new_waveband(400,700))
absorbance(yellow_gel.spct, new_waveband(400,700))
absorbance(yellow_gel.spct, split_bands(c(400,700), length.out = 3))
absorbance(yellow_gel.spct, split_bands(c(400,700), length.out = 3),
        quantity = "average")
absorbance(yellow_gel.spct, split_bands(c(400,700), length.out = 3),
        quantity = "total")
absorbance(yellow_gel.spct, split_bands(c(400,700), length.out = 3),
        quantity = "relative")
absorbance(yellow_gel.spct, split_bands(c(400,700), length.out = 3),
        quantity = "relative.pc")
absorbance(yellow_gel.spct, split_bands(c(400,700), length.out = 3),
        quantity = "contribution")
absorbance(yellow_gel.spct, split_bands(c(400,700), length.out = 3),
        quantity = "contribution.pc")

# }

Run the code above in your browser using DataLab