env_inst
#
- hypercoil.functional.fourier.env_inst(X: Tensor, axis: int = -1, n: int | None = None, fs: float = 1, period: float = 6.283185307179586) Tuple[Tensor, Tensor, Tensor] [source]#
Compute the analytic signal, and then decompose it into the envelope and instantaneous phase and frequency.
- 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
.) {analytic_signal_sampling_frequency}
- Returns:
- Tensor
Envelope of the analytic signal.
- Tensor
Instantaneous frequency of the analytic signal.
- Tensor
Instantaneous phase of the analytic signal.