instantaneous_frequency#
- hypercoil.functional.fourier.instantaneous_frequency(X: Tensor, axis: int = -1, n: int | None = None, fs: float = 1, period: float = 6.283185307179586) Tensor[source]#
Instantaneous frequency of a signal, computed via the analytic signal.
Note
If you require the envelope or instantaneous phase in addition to the the instantaneous frequency,
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.) {analytic_signal_sampling_frequency}
- Returns:
- Tensor
Output tensor.