colour.utilities.as_int_array

colour.utilities.as_int_array(a: ArrayLike, dtype: Type[DTypeInt] | None = None) → NDArrayInt

Convert the specified variable \(a\) to an integer array using the specified numpy.dtype.

This is a namespace-aware boundary helper. When Array API dispatch is enabled and \(a\) is a non-NumPy array (e.g. JAX, PyTorch), the result is returned in \(a\)’s native namespace, on its device, and cast to dtype. Otherwise the result is a numpy.ndarray.

Parameters:

• a (ArrayLike) – Variable \(a\) to convert.

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

Returns:

Variable \(a\) converted to an integer array in the input’s namespace.

Return type:

numpy.ndarray or backend tensor

Examples

>>> as_int_array([1.0, 2.0, 3.0])
array([1, 2, 3]...)