colour.utilities.MixinDataclassArray

class colour.utilities.MixinDataclassArray

Bases: MixinDataclassIterable

Provide conversion methods for dataclass-like classes to numpy.ndarray objects.

This mixin extends dataclass functionality to enable seamless conversion to NumPy arrays, facilitating numerical operations on structured data.

Methods

• __array__()

Notes

• The colour.utilities.MixinDataclassArray class inherits the methods from the following classes:

  • colour.utilities.MixinDataclassIterable

  • colour.utilities.MixinDataclassFields

__array__(dtype: Type[DTypeReal] | None = None, copy: bool = True) → NDArray

Implement support for dataclass-like class conversion to numpy.ndarray class.

A field set to None will be filled with np.nan according to the shape of the first field not set with None.

Parameters:

• dtype (Type[DTypeReal] | None) – numpy.dtype to use for conversion to np.ndarray, default to the numpy.dtype defined by colour.constant.DTYPE_FLOAT_DEFAULT attribute.

• copy (bool) – Whether to return a copy of the underlying data, will always be True, irrespective of the parameter value.

Returns:

dataclass-like class converted to numpy.ndarray.

Return type:

numpy.ndarray