colour.quality.colour_fidelity_index_ANSIIESTM3018

colour.quality.colour_fidelity_index_ANSIIESTM3018(sd_test: SpectralDistribution, additional_data: Literal[True] = True) → ColourQuality_Specification_ANSIIESTM3018

colour.quality.colour_fidelity_index_ANSIIESTM3018(sd_test: SpectralDistribution, *, additional_data: Literal[False]) → float

colour.quality.colour_fidelity_index_ANSIIESTM3018(sd_test: SpectralDistribution, additional_data: Literal[False]) → float

colour.quality.colour_fidelity_index_ANSIIESTM3018(sd_test: MultiSpectralDistributions, additional_data: Literal[False] = False) → NDArrayFloat

Compute the ANSI/IES TM-30-18 Colour Fidelity Index (CFI) \(R_f\) for the specified test spectral distribution.

Parameters:

• sd_test (SpectralDistribution | MultiSpectralDistributions) – Test spectral distribution. A colour.MultiSpectralDistributions of N test illuminants is also accepted, in which case additional_data must be False and the return value is a numpy.ndarray of N \(R_f\) values.

• additional_data (bool) – Whether to output additional data.

Returns:

ANSI/IES TM-30-18 Colour Fidelity Index (CFI).

Return type:

float, numpy.ndarray or colour.quality.ColourQuality_Specification_ANSIIESTM3018

References

[ANSIIESCCommittee18], [VincentJ17]

Examples

>>> from colour import SDS_ILLUMINANTS
>>> sd = SDS_ILLUMINANTS["FL2"]
>>> colour_fidelity_index_ANSIIESTM3018(sd)
np.float64(70.1208244...)