s_prod: Product from collection of spectra

Description Usage Arguments Value Methods (by class) Note See Also

View source: R/mspct.prod.r

Description

A method to compute the product of values across members of a collections of spectra. Computes the product at each wavelength across all the spectra in the collection returning a spectral object.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
s_prod(x, na.rm, ...)

## Default S3 method:
s_prod(x, na.rm = FALSE, ...)

## S3 method for class 'source_mspct'
s_prod(x, na.rm = FALSE, ...)

## S3 method for class 'response_mspct'
s_prod(x, na.rm = FALSE, ...)

## S3 method for class 'filter_mspct'
s_prod(x, na.rm = FALSE, ...)

## S3 method for class 'reflector_mspct'
s_prod(x, na.rm = FALSE, ...)

## S3 method for class 'calibration_mspct'
s_prod(x, na.rm = FALSE, ...)

Arguments

x

An R object. Currently this package defines methods for collections of spectral objects.

na.rm

logical. A value indicating whether NA values should be stripped before the computation proceeds.

...

Further arguments passed to or from other methods.

Value

If x is a collection spectral of objects, such as a "filter_mspct" object, the returned object is of same class as the members of the collection, such as "filter_spct", containing the product of the spectra.

Methods (by class)

Note

Omission of NAs is done separately at each wavelength. Interpolation is not applied, so all spectra in x must share the same set of wavelengths.

A product of spectral irradiance or spectral response is no longer a well defined physical quanttiy, and these product operations return an object of class generic_spct.

See Also

See prod for the prod() method used for the computations.


photobiology documentation built on Aug. 28, 2020, 1:11 a.m.