emd.imftools.wrap_phase#
- emd.imftools.wrap_phase(IP, ncycles=1, mode='2pi')[source]#
Wrap a phase time-course.
- Parameters:
- IPndarray
Input array of unwrapped phase values
- ncyclesint
Number of cycles per wrap (Default value = 1)
- mode{‘2pi’,’-pi2pi’}
Flag to indicate the values to wrap phase within (Default value = ‘2pi’)
- Returns:
- ndarray
Wrapped phase time-course
Notes
Non-finite phase values are not changed by this operation. eg np.nans in the input will be present and unchanged in the output.