signal.InstFreq.Function.instFreqSingle_maxWindow

dsp-collection / signal/InstFreq / instFreqSingle_maxWindow

Function: instFreqSingle_maxWindow()

function instFreqSingle_maxWindow(
   samples, 
   position, 
   roughtMeasuringFrequency, 
   shiftFactor, 
   maxWindowWidth, 
   windowFunction): 
  | InstFreqSingleResult
  | undefined;

Defined in: signal/InstFreq.ts:87

Computes the instantaneous frequency for a single measuring frequency. For this version, the maximum window width is specified.

Parameters

samples

Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike>

The input signal.

position

number

The rough position where to measure the instantaneous frequency. This is the rough center position of the window.

roughtMeasuringFrequency

number

A rough value for the measuring frequency. The specified value is adjusted to the nearest value that allows a computation without subsampling. The unit of the specified frequency value is 1/samples (normalized frequency).

shiftFactor

number

Shift factor, relative to the wavelength of the frequency. This shift is used for measuring the phase delta. A reasonable value is 0.25, which corresponds to 1/4 of the wavelength of the measuring frequency.

maxWindowWidth

number

The maximum window width (in sample positions).

windowFunction

| WindowFunction | undefined

A window function or undefined for no windowing (i.e. for using a rectangular window).

Returns

| InstFreqSingleResult | undefined

The result structure, or undefined if the instantaneous frequency cannot be computed.