Loris::FundamentalEstimator Class Reference
#include <Fundamental.h>
Public Types | |
| enum | { DefaultAmpFloor = -60, DefaultAmpRange = 30, DefaultFreqCeiling = 4000, DefaultPrecisionOver100 = 10, DefaultMinConfidencePct = 90 } |
| typedef F0Estimate | value_type |
Public Member Functions | |
| virtual | ~FundamentalEstimator (void) |
| Destructor. | |
| double | ampFloor (void) const |
| double | ampRange (void) const |
| double | freqCeiling (void) const |
| double | precision (void) const |
| void | setAmpFloor (double x) |
| void | setAmpRange (double x) |
| void | setFreqCeiling (double x) |
| void | setPrecision (double x) |
Protected Member Functions | |
| FundamentalEstimator (double precisionHz) | |
Protected Attributes | |
| double | m_precision |
| double | m_ampFloor |
| double | m_ampRange |
| double | m_freqCeiling |
Detailed Description
Base class for fundamental estimation, common storage for member variable parameters, type definitions, and constants.
Member Enumeration Documentation
| anonymous enum |
Constructor & Destructor Documentation
| Loris::FundamentalEstimator::FundamentalEstimator | ( | double | precisionHz | ) | [protected] |
Construct a new estimator with specified precision and other parameters given default values.
The specified precision is used to terminate the iterative estimation procedure.
- Parameters:
-
precisionHz is the precision in Hz with which the fundamental estimates will be made.
Member Function Documentation
| double Loris::FundamentalEstimator::ampFloor | ( | void | ) | const |
Return the absolute amplitude threshold in (negative) dB, below which spectral peaks will not be considered in the estimation of the fundamental (default is 30 dB).
| double Loris::FundamentalEstimator::ampRange | ( | void | ) | const |
Return the amplitude range in dB, relative to strongest peak in a frame, floating amplitude threshold (negative) below which spectral peaks will not be considered in the estimation of the fundamental (default is 30 dB).
| double Loris::FundamentalEstimator::freqCeiling | ( | void | ) | const |
Return the frequency ceiling in Hz, the frequency threshold above which spectral peaks will not be considered in the estimation of the fundamental (default is 10 kHz).
| double Loris::FundamentalEstimator::precision | ( | void | ) | const |
Return the precision of the estimate in Hz, the fundamental frequency will be estimated to within this range (default is 0.1 Hz).
| void Loris::FundamentalEstimator::setAmpFloor | ( | double | x | ) |
Set the absolute amplitude threshold in (negative) dB, below which spectral peaks will not be considered in the estimation of the fundamental (default is 30 dB).
- Parameters:
-
x is the new value of this parameter.
| void Loris::FundamentalEstimator::setAmpRange | ( | double | x | ) |
Set the amplitude range in dB, relative to strongest peak in a frame, floating amplitude threshold (negative) below which spectral peaks will not be considered in the estimation of the fundamental (default is 30 dB).
- Parameters:
-
x is the new value of this parameter.
| void Loris::FundamentalEstimator::setFreqCeiling | ( | double | x | ) |
Set the frequency ceiling in Hz, the frequency threshold above which spectral peaks will not be considered in the estimation of the fundamental (default is 10 kHz). Must be greater than the lower bound.
- Parameters:
-
x is the new value of this parameter.
| void Loris::FundamentalEstimator::setPrecision | ( | double | x | ) |
Set the precision of the estimate in Hz, the fundamental frequency will be estimated to within this range (default is 0.1 Hz).
- Parameters:
-
x is the new value of this parameter.
Member Data Documentation
double Loris::FundamentalEstimator::m_ampFloor [protected] |
in Hz, fundamental frequency will be estimated to within this range (default is 0.1 Hz)
double Loris::FundamentalEstimator::m_ampRange [protected] |
absolute amplitude threshold below which spectral peaks will not be considered in the estimation of the fundamental (default is equivalent to 60 dB quieter than a full scale sinusoid)
double Loris::FundamentalEstimator::m_freqCeiling [protected] |
floating amplitude threshold relative to the peak having the largest magnitude below which spectral peaks will not be considered in the estimation of the fundamental (default is equivalent to 30 dB)
The documentation for this class was generated from the following file:
- /Users/kfitz/Projects/Loris/Loris development/src/Fundamental.h
