DSPark 1.8.0
Header-only C++20 DSP for real-time and offline audio
Loading...
Searching...
No Matches
dspark::KeyDetector< T >::Key Struct Reference

One key estimate. More...

#include <KeyDetector.h>

Public Attributes

int tonicPitchClass = -1
 Numerical rank 1; -1 = nothing yet.
 
bool isMinor = false
 Mode of the numerical winner.
 
T confidence = T(0)
 Numerical rank-1/rank-2 margin.
 
int runnerUpPitchClass = -1
 Numerical rank 2; -1 = nothing yet.
 
bool runnerUpMinor = false
 Mode of the numerical runner-up.
 
int relativeAlternativePitchClass = -1
 Winner's relative key.
 
bool relativeAlternativeMinor = false
 Mode of the relative key.
 
int relativeAlternativeRank = 0
 Its actual 1-based numerical rank.
 

Detailed Description

template<FloatType T>
struct dspark::KeyDetector< T >::Key

One key estimate.

Definition at line 125 of file KeyDetector.h.

Member Data Documentation

◆ confidence

template<FloatType T>
T dspark::KeyDetector< T >::Key::confidence = T(0)

Numerical rank-1/rank-2 margin.

Definition at line 129 of file KeyDetector.h.

◆ isMinor

template<FloatType T>
bool dspark::KeyDetector< T >::Key::isMinor = false

Mode of the numerical winner.

Definition at line 128 of file KeyDetector.h.

◆ relativeAlternativeMinor

template<FloatType T>
bool dspark::KeyDetector< T >::Key::relativeAlternativeMinor = false

Mode of the relative key.

Definition at line 133 of file KeyDetector.h.

◆ relativeAlternativePitchClass

template<FloatType T>
int dspark::KeyDetector< T >::Key::relativeAlternativePitchClass = -1

Winner's relative key.

Definition at line 132 of file KeyDetector.h.

◆ relativeAlternativeRank

template<FloatType T>
int dspark::KeyDetector< T >::Key::relativeAlternativeRank = 0

Its actual 1-based numerical rank.

Definition at line 134 of file KeyDetector.h.

◆ runnerUpMinor

template<FloatType T>
bool dspark::KeyDetector< T >::Key::runnerUpMinor = false

Mode of the numerical runner-up.

Definition at line 131 of file KeyDetector.h.

◆ runnerUpPitchClass

template<FloatType T>
int dspark::KeyDetector< T >::Key::runnerUpPitchClass = -1

Numerical rank 2; -1 = nothing yet.

Definition at line 130 of file KeyDetector.h.

◆ tonicPitchClass

template<FloatType T>
int dspark::KeyDetector< T >::Key::tonicPitchClass = -1

Numerical rank 1; -1 = nothing yet.

Definition at line 127 of file KeyDetector.h.


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