pulp::test::audio::AliasComponent Struct Reference

One expected component of the ideal series, and what was measured where it landed. More...

#include <audio_spectrum.hpp>

Public Attributes
int	index = 0
	h — 1 is the fundamental.
ComponentClass	component_class = ComponentClass::harmonic
double	source_hz = 0.0
	h · f0: where it would sit at infinite fs.
double	hz = 0.0
	Where it actually landed (== source_hz for a harmonic; the fold site for an alias).
double	amplitude = 0.0
	Linear amplitude from the joint fit, in the SAME units as the input samples — directly comparable to the fundamental's.
double	db_below_fundamental = 0.0
	20·log10(amplitude / fundamental).
bool	in_band = true
	Inside the measurement band — i.e.
bool	resolved = true
	False when this component's landing site could not be separated from another component's, from DC, or from Nyquist (see AliasOptions::min_separation_bins).

Detailed Description

One expected component of the ideal series, and what was measured where it landed.

Member Data Documentation

amplitude

double pulp::test::audio::AliasComponent::amplitude = 0.0

Linear amplitude from the joint fit, in the SAME units as the input samples — directly comparable to the fundamental's.

Meaningless when resolved is false.

component_class

ComponentClass pulp::test::audio::AliasComponent::component_class = ComponentClass::harmonic

db_below_fundamental

double pulp::test::audio::AliasComponent::db_below_fundamental = 0.0

20·log10(amplitude / fundamental).

hz

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

Where it actually landed (== source_hz for a harmonic; the fold site for an alias).

in_band

bool pulp::test::audio::AliasComponent::in_band = true

Inside the measurement band — i.e.

hz <= max_alias_frequency_hz. Applies to aliases only; a harmonic is legitimate at any frequency and is always reported with in_band = true.

index

int pulp::test::audio::AliasComponent::index = 0

h — 1 is the fundamental.

resolved

bool pulp::test::audio::AliasComponent::resolved = true

False when this component's landing site could not be separated from another component's, from DC, or from Nyquist (see AliasOptions::min_separation_bins).

amplitude and db_below_fundamental are NOT populated — a gate must treat an unresolved in-band alias as INCONCLUSIVE, never as a pass.

source_hz

double pulp::test::audio::AliasComponent::source_hz = 0.0

h · f0: where it would sit at infinite fs.

---

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

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