instantaneous_phase#

hypercoil.functional.fourier.instantaneous_phase(X: Tensor, axis: int = -1, n: int | None = None, period: float = 6.283185307179586) Tensor[source]#

Instantaneous phase of a signal, computed via the analytic signal.

Note

If you require the envelope or instantaneous frequency in addition to the instantaneous phase, env_inst() will be more efficient.

Parameters:
Xtensor

Input tensor.

axisint (default -1)

Axis along which the transform is applied.

nint (default None)

Number of frequency components; dimension of the Fourier transform. This defaults to the size of the input along the transform axis.

periodfloat (default 2 * pi)

Range over which the signal wraps. (See jax.numpy.unwrap.)

Returns
——-
Tensor

Output tensor.