R/sensors-mspct.r

In photobiologySensors: Response Data for Light Sensors

#' @title Spectral response of sensors
#'
#' @description A collection of response spectra for various broadband sensors
#' used for measuring ultraviolet and visible radiation. Each spectrum in the
#' collection contains two variables, wavelengths (nm) at either regular or
#' irregular intervals and spectral responsiveness (in energy units).
#' Spectral data are in most cases normalized to one at the wavelength of
#' maximum energy responsivity. Absolute calibration values are given only for
#' data from a publication which reports on multiple units of the same type.
#'
#' @format A \code{response_mspct} object containing
#' \code{response_spct} objects as \emph{named} members.
#'
#' Spectral objects for single channel sensors contain two numeric variables,
#' with responsivity in most cases in relative energy units:
#' \itemize{
#'    \item w.length (nm)
#'    \item s.e.response (r.u.)
#' }
#' Spectral objects for multichannel sensors contain the spectra in long form
#' with two numeric variables, and in addition a factor with channel ids:
#' \itemize{
#'    \item w.length (nm)
#'    \item s.e.response (r.u.)
#'    \item channel (factor with names as levels)
#' }
#' The spectral objects contain, in addition to the spectral data, metadata
#' stored in R attributes \code{sensor.properties}, \code{what.measured},
#' \code{how.measured}, and \code{comment}.
#'
#' @note In addition to this object containing the spectral data, this package
#' provides character vectors useful for sub-setting spectra by supplier, type,
#' colour, etc.
#'
#' @docType data
#' @keywords datasets
#'
#' @seealso \code{\link[photobiology]{source_spct}} and
#' \code{\link[photobiology:generic_mspct]{source_mspct}}
#'
#' @examples
#' names(sensors.mspct)
#'
"sensors.mspct"

#' @title Spectral response of image sensors
#'
#' @description A collection of response spectra for various image sensors and
#' digital cameras responsive to ultraviolet, visible, NIR and/or SWIR
#' radiation. Each spectrum in the collection contains two variables,
#' wavelengths (nm) at irregular intervals and spectral responsiveness (in
#' photon units = quantum efficiency).
#' Spectral data are normalized to one at the wavelength of
#' maximum quantum efficiency only when this is how the original source
#' published the data.
#'
#' @format A \code{response_mspct} object containing
#' \code{response_spct} objects as \emph{named} members.
#'
#' Spectral objects for monochrome image sensors contain two numeric variables,
#' with quantum efficiency in some cases in relative energy units:
#' \itemize{
#'    \item w.length (nm)
#'    \item s.q.response (r.u.)
#' }
#' Spectral objects for colour image sensors contain the spectra in long form
#' with two numeric variables, and in addition a factor with channel ids:
#' \itemize{
#'    \item w.length (nm)
#'    \item s.q.response (r.u.)
#'    \item channel (factor with names as levels)
#' }
#' The spectral objects contain, in addition to the spectral data, metadata
#' stored in R attributes \code{sensor.properties}, \code{what.measured},
#' \code{how.measured}, and \code{comment}.
#'
#' @docType data
#' @keywords datasets
#'
#' @seealso \code{\link[photobiology:source_spct]{response_spct}} and
#' \code{\link[photobiology:generic_mspct]{response_mspct}}
#'
#' @examples
#' names(image_sensors.mspct)
#'
"image_sensors.mspct"