pado.math.wrap_phase

wrap_phase(phase_u, stay_positive=False)

Wrap phase values to [-π, π] or [0, 2π] range.

Parameters:

• phase_u (torch.Tensor) – Unwrapped phase values tensor

• stay_positive (bool) – If True, output range is [0, 2π]. If False, [-π, π]

Returns:

Wrapped phase values tensor

Return type:

torch.Tensor

Examples

>>> phase = torch.tensor([3.5 * np.pi, -2.5 * np.pi])
>>> wrapped = wrap_phase(phase)  # tensor([0.5000 * π, -0.5000 * π])