R: Convert an R object into a spectrum object.

setGenericSpct {photobiology} | R Documentation

## Convert an R object into a spectrum object.

### Description

Sets the class attribute of a data.frame or an object of a derived class to "generic_spct".

### Usage

    setGenericSpct(x, multiple.wl = 1L, idfactor = NULL)

    setCalibrationSpct(x, strict.range = getOption("photobiology.strict.range",
      default = FALSE), multiple.wl = 1L, idfactor = NULL)

    setRawSpct(x, strict.range = getOption("photobiology.strict.range", default =
      FALSE), multiple.wl = 1L, idfactor = NULL)

    setCpsSpct(x, strict.range = getOption("photobiology.strict.range", default =
      FALSE), multiple.wl = 1L, idfactor = NULL)

    setFilterSpct(x, Tfr.type = c("total", "internal"),
      strict.range = getOption("photobiology.strict.range", default = FALSE),
      multiple.wl = 1L, idfactor = NULL)

    setReflectorSpct(x, Rfr.type = c("total", "specular"),
      strict.range = getOption("photobiology.strict.range", default = FALSE),
      multiple.wl = 1L, idfactor = NULL)

    setObjectSpct(x, Tfr.type = c("total", "internal"), Rfr.type = c("total",
      "specular"), strict.range = getOption("photobiology.strict.range", default =
      FALSE), multiple.wl = 1L, idfactor = NULL)

    setResponseSpct(x, time.unit = "second", multiple.wl = 1L,
      idfactor = NULL)

    setSourceSpct(x, time.unit = "second", bswf.used = c("none", "unknown"),
      strict.range = getOption("photobiology.strict.range", default = FALSE),
      multiple.wl = 1L, idfactor = NULL)

    setChromaSpct(x, multiple.wl = 1L, idfactor = NULL)

### Arguments

`x` | data.frame, list or generic_spct and derived classes
`multiple.wl` | numeric Maximum number of repeated w.length entries with same value.
`idfactor` | character Name of factor distinguishing multiple spectra when stored logitudinally (required if mulitple.wl > 1).
`strict.range` | logical Flag indicating whether off-range values result in an error instead of a warning.
`Tfr.type` | character A string, either "total" or "internal".
`Rfr.type` | character A string, either "total" or "specular".
`time.unit` | character A string "second", "day" or "exposure".
`bswf.used` | character A string, either "none" or the name of a BSWF.

### Value

x

### Functions

- `setCalibrationSpct`: Set class of a an object to "calibration_spct".

- `setRawSpct`: Set class of a an object to "raw_spct".

- `setCpsSpct`: Set class of a an object to "cps_spct".

- `setFilterSpct`: Set class of an object to "filter_spct".

- `setReflectorSpct`: Set class of a an object to "reflector_spct".

- `setObjectSpct`: Set class of an object to "object_spct".

- `setResponseSpct`: Set class of an object to "response_spct".

- `setSourceSpct`: Set class of an object to "source_spct".

- `setChromaSpct`: Set class of an object to "chroma_spct".

### Note

This method alters x itself by reference and in addition returns x invisibly.

### See Also

Other set and unset spectral class functions: `rmDerivedSpct`

### Examples

    my.df <- data.frame(w.length = 300:309, s.e.irrad = rep(100, 10))
    is.source_spct(my.df)
    setSourceSpct(my.df)
    is.source_spct(my.df)

[Package photobiology version 0.9.21 Index]