colour.utilities.as_float#

colour.utilities.as_float(a: float | DTypeFloat, dtype: Type[DTypeFloat] | None = None) → DTypeFloat[source]#

colour.utilities.as_float(a: NDArray | Sequence[float], dtype: Type[DTypeFloat] | None = None) → NDArrayFloat

colour.utilities.as_float(a: ArrayLike, dtype: Type[DTypeFloat] | None = None) → DTypeFloat | NDArrayFloat

Convert the specified variable \(a\) to a floating-point value.

Scalars and 0-dimensional arrays are returned as a Python / NumPy float scalar. Higher-dimensional arrays go through as_float_array(), which is namespace-aware: when Array API dispatch is enabled and \(a\) is a non-NumPy array, the result is returned in \(a\)’s native namespace.

Parameters:

a (ArrayLike) – Variable \(a\) to convert.
dtype (Type[DTypeFloat] | None) – numpy.dtype to use for conversion, default to the numpy.dtype defined by the colour.constant.DTYPE_FLOAT_DEFAULT attribute.

Returns:

Variable \(a\) converted to a floating-point scalar or array in the input’s namespace.

Return type:

numpy.floating or numpy.ndarray or backend tensor

Examples

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

colour.utilities.as_float#

This Page