colour.utilities.as_int#

colour.utilities.as_int(a: NumberOrArrayLike, dtype: Type[DTypeInteger] | None = None) → IntegerOrNDArray[source]#

Attempt to convert given variable \(a\) to numpy.integer using given numpy.dtype. If variable \(a\) is not a scalar or 0-dimensional, it is converted to numpy.ndarray.

Parameters:

  • a (NumberOrArrayLike) – Variable to convert.

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

Returns:

Variable \(a\) converted to numpy.integer.

Return type:

numpy.integer or numpy.ndarray

Examples

>>> as_int(np.array([1]))
1
>>> as_int(np.arange(10))  
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]...)