colour.CorrespondingColourDataset#

class colour.CorrespondingColourDataset(name: int, XYZ_r: NDArrayFloat, XYZ_t: NDArrayFloat, XYZ_cr: NDArrayFloat, XYZ_ct: NDArrayFloat, Y_r: float, Y_t: float, B_r: float, B_t: float, metadata: dict)[source]#

Define a corresponding colour dataset for chromatic adaptation studies.

Parameters:

name (int) – Corresponding colour dataset name.
XYZ_r (NDArrayFloat) – CIE XYZ tristimulus values of the reference illuminant.
XYZ_t (NDArrayFloat) – CIE XYZ tristimulus values of the test illuminant.
XYZ_cr (NDArrayFloat) – Corresponding CIE XYZ tristimulus values under the reference illuminant.
XYZ_ct (NDArrayFloat) – Corresponding CIE XYZ tristimulus values under the test illuminant.
Y_r (float) – Reference white luminance \(Y_r\) in \(cd/m^2\).
Y_t (float) – Test white luminance \(Y_t\) in \(cd/m^2\).
B_r (float) – Luminance factor \(B_r\) of reference achromatic background as percentage.
B_t (float) – Luminance factor \(B_t\) of test achromatic background as percentage.
metadata (dict) – Dataset metadata.

Notes

This class is compatible with Luo and Rhodes (1999) Corresponding-Colour Datasets datasets.

References

__init__(name: int, XYZ_r: NDArrayFloat, XYZ_t: NDArrayFloat, XYZ_cr: NDArrayFloat, XYZ_ct: NDArrayFloat, Y_r: float, Y_t: float, B_r: float, B_t: float, metadata: dict) → None#

Parameters:

Return type:

None

Methods

__init__(name, XYZ_r, XYZ_t, XYZ_cr, XYZ_ct, ...)

Attributes

`fields`	Getter for the fields of the `dataclass`-like class.
`items`	Getter for the `dataclass`-like class items, i.e., the field names and values.
`keys`	Getter for the `dataclass`-like class keys, i.e., the field names.
`values`	Getter for the `dataclass`-like class field values.
`name`
`XYZ_r`
`XYZ_t`
`XYZ_cr`
`XYZ_ct`
`Y_r`
`Y_t`
`B_r`
`B_t`
`metadata`