colour.utilities.as_complex_array#

colour.utilities.as_complex_array(a: ArrayLike, dtype: Type[DTypeComplex] | None = None) → NDArrayComplex[source]#

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

Parameters:

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

Returns:

Variable \(a\) converted to complex numpy.ndarray.

Return type:

numpy.ndarray

Examples

>>> as_complex_array([1, 2, 3])
array([1.+0.j, 2.+0.j, 3.+0.j])
>>> as_complex_array([1 + 2j, 3 + 4j])
array([1.+2.j, 3.+4.j])