s_mean: Mean from collection of spectra

In photobiology: Photobiological Calculations

Mean from collection of spectra

Description

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

Usage

s_mean(x, trim, na.rm, ...)

## Default S3 method:
s_mean(x, trim = 0, na.rm = FALSE, ...)

## S3 method for class 'generic_spct'
s_mean(x, trim = 0, na.rm = FALSE, ...)

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

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

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

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

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

## S3 method for class 'cps_mspct'
s_mean(x, trim = 0, na.rm = FALSE, ...)

## S3 method for class 'raw_mspct'
s_mean(x, trim = 0, na.rm = FALSE, ...)

Arguments

x	An R object.
trim	numeric The fraction (0 to 0.5) of observations to be trimmed from each end of x before the mean is computed. Values of trim outside that range are taken as the nearest endpoint.
na.rm	logical A value indicating whether NA values should be stripped before the computation proceeds.
...	Further arguments passed to or from other methods.

Details

Method specializations compute the mean at each wavelength across a group of spectra stored in an object of one of the classes defined in package 'photobiolgy'. Trimming of extreme values is possible (trimmed mean) and 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.

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.

Methods (by class)

• s_mean(default):

• s_mean(generic_spct):

• s_mean(source_mspct):

• s_mean(response_mspct):

• s_mean(filter_mspct):

• s_mean(reflector_mspct):

• s_mean(calibration_mspct):

• s_mean(cps_mspct):

• s_mean(raw_mspct):

Note

Objects of classes raw_spct and cps_spct can contain data from multiple scans in multiple variables or "columns". The methods accept as arguments objects of these classes only if spectra contain data for a single spectrometer scan. In the case of cps_spct objects, a single column can also contain data from multiple scans spliced into a single variable.

See Also

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

Examples

s_mean(sun_evening.mspct)

photobiology documentation built on April 4, 2025, 4:37 a.m.