as.generic_mspct: Coerce to a collection-of-spectra

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

View source: R/zmspct.classes.R

Description

Return a copy of an R object with its class set to a given type of spectrum.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
as.generic_mspct(x, ...)

## Default S3 method:
as.generic_mspct(x, ...)

## S3 method for class 'data.frame'
as.generic_mspct(x, force.spct.class = FALSE, ...)

## S3 method for class 'generic_spct'
as.generic_mspct(x, force.spct.class = FALSE, ...)

## S3 method for class 'list'
as.generic_mspct(x, force.spct.class = FALSE, ..., ncol = 1, byrow = FALSE)

## S3 method for class 'matrix'
as.generic_mspct(
  x,
  w.length,
  member.class,
  spct.data.var,
  multiplier = 1,
  byrow = NULL,
  spct.names = "spct_",
  ...
)

mat2mspct(
  x,
  w.length,
  member.class,
  spct.data.var,
  multiplier = 1,
  byrow = NULL,
  spct.names = "spct_",
  ...
)

Arguments

x

a list of spectral objects or a list of objects such as data frames that can be converted into spectral objects.

...

passed to individual spectrum object constructor

force.spct.class

logical indicating whether to change the class of members to generic_spct or retain the existing class.

ncol

integer Number of 'virtual' columns in data

byrow

logical If ncol > 1 how to read in the data

w.length

numeric A vector of wavelengthvalues sorted in strictly ascending order (nm).

member.class

character The name of the class of the individual spectra to be constructed.

spct.data.var

character The name of the variable that will contain the spectral data. This indicates what physical quantity is stored in the matrix and the units of expression used.

multiplier

numeric A multiplier to be applied to the values in x to do unit or scale conversion.

spct.names

character Vector of names to be assigned to collection members, either of length 1, or with length equal to the number of spectra.

Value

A copy of x converted into a generic_mspct object.

Methods (by class)

Note

Members of generic_mspct objects can be heterogeneous: they can belong to any class derived from generic_spct and class is not enforced. When x is a list of data frames force.spct.class = TRUE needs to be supplied. When x is a square matrix an explicit argument is needed for byrow to indicate how data in x should be read. In every case the length of the w.length vector must match one of the dimensions of x.

See Also

Other Coercion methods for collections of spectra: as.calibration_mspct(), as.chroma_mspct(), as.cps_mspct(), as.filter_mspct(), as.object_mspct(), as.raw_mspct(), as.reflector_mspct(), as.response_mspct(), as.source_mspct(), split2mspct(), subset2mspct()


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