envelope

hypercoil.functional.fourier.envelope(X: Tensor, axis: int = -1, n: int | None = None) → Tensor

Envelope of a signal, computed via the analytic signal.

Note

If you require the instantaneous phase or frequency in addition to the envelope, 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.

Returns:

Tensor

Output tensor.

See also

analytic_signal()

hilbert_transform()

envelope()

instantaneous_phase()

instantaneous_frequency()

env_inst()