Learn R Programming

photobiology (version 0.11.3)

s_prod: Product from collection of spectra

Description

Method to compute the "parallel" product of values across members of a collection of spectra or of a spectral object containing multiple spectra in long form.

Usage

s_prod(x, na.rm, ...)

# S3 method for default s_prod(x, na.rm = FALSE, ...)

# S3 method for generic_spct s_prod(x, na.rm = FALSE, ...)

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

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

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

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

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

# S3 method for cps_mspct s_prod(x, na.rm = FALSE, ...)

# S3 method for raw_mspct s_prod(x, na.rm = FALSE, ...)

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 summary spectrum, with variables with names tagged for summaries other than mean or median.

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.

Methods (by class)

  • s_prod(default):

  • s_prod(generic_spct):

  • s_prod(source_mspct):

  • s_prod(response_mspct):

  • s_prod(filter_mspct):

  • s_prod(reflector_mspct):

  • s_prod(calibration_mspct):

  • s_prod(cps_mspct):

  • s_prod(raw_mspct):

Details

Method specializations compute the product at each wavelength across a group of spectra stored in an object of one of the classes defined in package 'photobiology'. 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. An error is triggered if this condition is nor fulfilled.

See Also

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

Examples

Run this code
s_prod(two_filters.mspct)

Run the code above in your browser using DataLab