pulp::test::audio::PitchEstimate Struct Reference

A single fundamental-frequency estimate. More...

#include <pitch_track.hpp>

Public Attributes
double	hz = 0.0
	Estimated fundamental in Hz. 0.0 when voiced is false.
double	confidence = 0.0
	Fraction of the analyzed segment's energy explained by the fundamental and its harmonics, clamped to [0, 1].
bool	voiced = false
	False when the estimator refused: the segment was below the silence floor or its confidence fell under the gate.
double	coarse_hz = 0.0
	Diagnostics — the coarse FFT-peak estimate before projection refinement, and the raw (unclamped) harmonic-energy fraction.
double	harmonic_energy_ratio = 0.0

Detailed Description

A single fundamental-frequency estimate.

Member Data Documentation

coarse_hz

double pulp::test::audio::PitchEstimate::coarse_hz = 0.0

Diagnostics — the coarse FFT-peak estimate before projection refinement, and the raw (unclamped) harmonic-energy fraction.

Exposed so a caller can see how far the refinement moved the peak and how tonal the segment was.

confidence

double pulp::test::audio::PitchEstimate::confidence = 0.0

Fraction of the analyzed segment's energy explained by the fundamental and its harmonics, clamped to [0, 1].

~1 for a clean tone or saw, low for noise. This is the number gated against PitchOptions::min_confidence.

harmonic_energy_ratio

double pulp::test::audio::PitchEstimate::harmonic_energy_ratio = 0.0

hz

double pulp::test::audio::PitchEstimate::hz = 0.0

Estimated fundamental in Hz. 0.0 when voiced is false.

voiced

bool pulp::test::audio::PitchEstimate::voiced = false

False when the estimator refused: the segment was below the silence floor or its confidence fell under the gate.

A refused estimate never carries a frequency — treat it as "no fundamental here", not as a measurement.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/tools/audio/analysis/include/pulp/audio/analysis/pitch_track.hpp