colour.utilities.as_float_scalar

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

Convert the specified variable \(a\) to numpy.floating using the specified numpy.dtype.

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 numpy.floating.

Return type:

float

Warning

• The return type is effectively annotated as float and not numpy.floating.

Examples

>>> as_float_scalar(np.array(1))
1.0