spct_SSI: Spectral (color) similarity index

View source: R/color-wrappers.r

spct_SSIR Documentation

Spectral (color) similarity index

Description

Wrapper on function computeSSI from package 'colorSpec' that accepts source_spct objects.

Usage

spct_SSI(
  spct,
  reference.spct = NULL,
  digits = 0,
  isotherms = "mccamy",
  locus = "robertson",
  named = FALSE
)

Arguments

spct, reference.spct

source_spct Single light source spectra.

digits

integer The number of digits after the decimal point in the returned vector. According to Holm the output should be rounded to the nearest integer, which corresponds to digits = 0. To return full precision, set digits = Inf.

isotherms

character This is only used when reference=NULL. It is passed to computeCCT in order to compute the CCT of each test spectrum.

locus

character This is only used when reference=NULL. It is passed to computeCCT in order to compute the CCT of each test spectrum.

named

logical Whether to set the name attribute of the returned value to the name of the spectrum passed as argument if possible.

Details

Please see computeSSI for the details of the computations and references.

Value

A numeric value between zero and 100.

Examples


spct_SSI(white_led.source_spct, sun.spct)


photobiologyInOut documentation built on Aug. 15, 2022, 9:09 a.m.