colour.quality.colour_fidelity_index_CIE2017

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

colour.quality.colour_fidelity_index_CIE2017(sd_test: SpectralDistribution, additional_data: Literal[True]) → ColourRendering_Specification_CIE2017

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

Compute the CIE 2017 Colour Fidelity Index (CFI) \(R_f\) of the specified 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:

CIE 2017 Colour Fidelity Index (CFI) \(R_f\).

Return type:

float, numpy.ndarray or colour.quality.ColourRendering_Specification_CIE2017

References

[CIET19017]

Examples

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