spct_CRI: Color reproduction index

View source: R/color-wrappers.r

spct_CRIR Documentation

Color reproduction index

Description

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

Usage

spct_CRI(spct, adapt = TRUE, attach = FALSE, tol = 0.0054, named = FALSE)

Arguments

spct

source_spct A single light source spectrum.

adapt

logical If TRUE, then a special chromatic adaption is performed, see Details in computeCRI.

attach

logical If TRUE, then a large list of intermediate calculations is attached to the returned number, as attribute data. This attached list includes data for all special 14 color samples, although the last 6 do not affect the returned CRI

tol

numeric For the CRI to be meaningful the chromaticities of the test and reference illuminants must be sufficiently close in the CIE 1960 uniform chromaticity space. If the tolerance is exceeded, the function returns NA. The default tol=5.4e-3 is the one recommended by the CIE, but the argument allows the user to override it.

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 computeCRI for the details of the computations and references.

Value

A numeric value between zero and 100, or NA if the light is not white enough.

Examples


spct_CRI(white_led.source_spct)
spct_CRI(sun.spct)


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