Skip to content

signal.PitchDetectionHarm.Interface.HarmonicInstSumParms

Christian d'Heureuse edited this page Jun 7, 2026 · 2 revisions

dsp-collection / signal/PitchDetectionHarm / HarmonicInstSumParms

Interface: HarmonicInstSumParms

Defined in: signal/PitchDetectionHarm.ts:63

Secondary parameters for harmonicInstSum().

Extends

Properties

amplitudeCompressionExponent

amplitudeCompressionExponent: number;

Defined in: signal/PitchDetectionHarm.ts:21

Exponent for the common compression of all harmonic amplitudes.

Inherited from

HarmonicSumParms.amplitudeCompressionExponent


fCutoff

fCutoff: number;

Defined in: signal/PitchDetectionHarm.ts:47

Cutoff frequency in Hz. Specifies a hard upper frequency limit up to which the harmonic amplitudes are evaluated.

Inherited from

HarmonicSumParms.fCutoff


harmonicsDeclineExponent

harmonicsDeclineExponent: number;

Defined in: signal/PitchDetectionHarm.ts:36

Hyperbolic decline exponent constant for the decline rate of the harmonic.

  • 1 for harmonic decline.
  • 0 for exponential decline.
  • -1 for linear decline (with clipping to 0).
  • Between 0 and 1 for hyperbolic decline.

Inherited from

HarmonicSumParms.harmonicsDeclineExponent


harmonicsDeclineRate

harmonicsDeclineRate: number;

Defined in: signal/PitchDetectionHarm.ts:27

Base value for a decline rate depending on the order of the harmonic. Initial negative slope of the decline curve.

Inherited from

HarmonicSumParms.harmonicsDeclineRate


peakWidthFactor

peakWidthFactor: number;

Defined in: signal/PitchDetectionHarm.ts:76

Relative peak width factor. Used for peak shaping of a harmonic amplitude, depending on the deviation from the instantaneous frequency. Specifies the peak width relative to F0.


relWindowWidth

relWindowWidth: number;

Defined in: signal/PitchDetectionHarm.ts:53

Window width, relative to the wavelength of the fundamental frequency. Must be an integer.

Inherited from

HarmonicSumParms.relWindowWidth


shiftFactor

shiftFactor: number;

Defined in: signal/PitchDetectionHarm.ts:69

Shift factor, relative to the wavelength of the frequency. Used for measuring the phase delta for computing the instantaneous frequency.


windowFunction

windowFunction: 
  | WindowFunction
  | undefined;

Defined in: signal/PitchDetectionHarm.ts:58

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

Inherited from

HarmonicSumParms.windowFunction

Clone this wiki locally