Warning

You are reading the documentation related to the development version. Go here if you are looking for the documentation of the stable release.

spectrochempy.set_complex

set_complex(inplace=False)

Set the object data as complex.

When nD-dimensional array are set to complex, we assume that it is along the first dimension. Two succesives rows are merged to form a complex rows. This means that the number of row must be even If the complexity is to be applied in other dimension, either transpose/swapdims your data before applying this function in order that the complex dimension is the first in the array.

Parameters

inplace (bool, optional, default=False) – Flag to say that the method return a new object (default) or not (inplace=True).

Returns

out – Same object or a copy depending on the inplace flag.

See also

set_quaternion, has_complex_dims, is_complex, is_quaternion