Loris::FundamentalFromPartials Class Reference
#include <Fundamental.h>
Inheritance diagram for Loris::FundamentalFromPartials:
Public Member Functions | |
| FundamentalFromPartials (double precisionHz=DefaultPrecisionOver100 *0.01) | |
| ~FundamentalFromPartials (void) | |
| Destructor. | |
| FundamentalFromPartials (const FundamentalFromPartials &) | |
| FundamentalFromPartials & | operator= (const FundamentalFromPartials &) |
| Pass the assignment opertion up to the base class. | |
| LinearEnvelope | buildEnvelope (PartialList::const_iterator begin_partials, PartialList::const_iterator end_partials, double tbeg, double tend, double interval, double lowerFreqBound, double upperFreqBound, double confidenceThreshold) |
| LinearEnvelope | buildEnvelope (const PartialList &partials, double tbeg, double tend, double interval, double lowerFreqBound, double upperFreqBound, double confidenceThreshold) |
| value_type | estimateAt (PartialList::const_iterator begin_partials, PartialList::const_iterator end_partials, double time, double lowerFreqBound, double upperFreqBound) |
| value_type | estimateAt (const PartialList &partials, double time, double lowerFreqBound, double upperFreqBound) |
Detailed Description
Class FundamentalFromPartials represents an algorithm for time-varying fundamental frequency estimation from instantaneous Partial amplitudes and frequencies based on a likelihood estimator adapted from Quatieri's Speech Signal Processing text
Constructor & Destructor Documentation
| Loris::FundamentalFromPartials::FundamentalFromPartials | ( | double | precisionHz = DefaultPrecisionOver100 *0.01 |
) |
Construct a new estimator.
The specified precision is used to terminate the iterative estimation procedure. If unspecified, the default value, DefaultPrecisionOver100 * 100 is used.
- Parameters:
-
precisionHz is the precision in Hz with which the fundamental estimates will be made.
| Loris::FundamentalFromPartials::FundamentalFromPartials | ( | const FundamentalFromPartials & | ) |
Construct a copy of an estimator. Nothing much to do since this class has no data members.
Member Function Documentation
| LinearEnvelope Loris::FundamentalFromPartials::buildEnvelope | ( | const PartialList & | partials, | |
| double | tbeg, | |||
| double | tend, | |||
| double | interval, | |||
| double | lowerFreqBound, | |||
| double | upperFreqBound, | |||
| double | confidenceThreshold | |||
| ) | [inline] |
Construct a linear envelope from fundamental frequency estimates taken at the specified interval in seconds starting at tbeg (seconds) and ending before tend (seconds).
- Parameters:
-
partials is the sequence of Partials tbeg is the beginning of the time interval (in seconds) tend is the end of the time interval (in seconds) interval is the time between breakpoints in the fundamental frequency envelope (in seconds) lowerFreqBound is the lower bound on the fundamental frequency estimate (in Hz) upperFreqBound is the lower bound on the fundamental frequency estimate (in Hz) confidenceThreshold is the minimum confidence level resuired for a fundamental frequency estimate to be added to the envelope. Lower confidence estimates are not added, the envelope returned will not contain breakpoints at times associated with low confidence estimates
- Returns:
- a LinearEnvelope composed of breakpoints corresponding to the fundamental frequency estimates at samples of the span tbeg to tend at the specified sampling interval, only estimates having confidence level exceeding the specified confidence threshold are added to the envelope
| LinearEnvelope Loris::FundamentalFromPartials::buildEnvelope | ( | PartialList::const_iterator | begin_partials, | |
| PartialList::const_iterator | end_partials, | |||
| double | tbeg, | |||
| double | tend, | |||
| double | interval, | |||
| double | lowerFreqBound, | |||
| double | upperFreqBound, | |||
| double | confidenceThreshold | |||
| ) |
Construct a linear envelope from fundamental frequency estimates taken at the specified interval in seconds starting at tbeg (seconds) and ending before tend (seconds).
- Parameters:
-
begin_partials is the beginning of a sequence of Partials end_partials is the end of a sequence of Partials tbeg is the beginning of the time interval (in seconds) tend is the end of the time interval (in seconds) interval is the time between breakpoints in the fundamental frequency envelope (in seconds) lowerFreqBound is the lower bound on the fundamental frequency estimate (in Hz) upperFreqBound is the lower bound on the fundamental frequency estimate (in Hz) confidenceThreshold is the minimum confidence level resuired for a fundamental frequency estimate to be added to the envelope. Lower confidence estimates are not added, the envelope returned will not contain breakpoints at times associated with low confidence estimates
- Returns:
- a LinearEnvelope composed of breakpoints corresponding to the fundamental frequency estimates at samples of the span tbeg to tend at the specified sampling interval, only estimates having confidence level exceeding the specified confidence threshold are added to the envelope
| value_type Loris::FundamentalFromPartials::estimateAt | ( | const PartialList & | partials, | |
| double | time, | |||
| double | lowerFreqBound, | |||
| double | upperFreqBound | |||
| ) | [inline] |
Return an estimate of the fundamental frequency computed at the specified time. The F0Estimate returned stores the estimate of the fundamental frequency (in Hz) and the relative confidence (from 0 to 1) associated with that estimate.
- Parameters:
-
partials is the sequence of Partials time is the time in seconds at which to attempt to estimate the fundamental frequency lowerFreqBound is the lower bound on the fundamental frequency estimate (in Hz) upperFreqBound is the lower bound on the fundamental frequency estimate (in Hz)
- Returns:
- the estimate of fundamental frequency in Hz and the confidence associated with that estimate (see F0Estimate.h)
| value_type Loris::FundamentalFromPartials::estimateAt | ( | PartialList::const_iterator | begin_partials, | |
| PartialList::const_iterator | end_partials, | |||
| double | time, | |||
| double | lowerFreqBound, | |||
| double | upperFreqBound | |||
| ) |
Return an estimate of the fundamental frequency computed at the specified time. The F0Estimate returned stores the estimate of the fundamental frequency (in Hz) and the relative confidence (from 0 to 1) associated with that estimate.
- Parameters:
-
begin_partials is the beginning of a sequence of Partials end_partials is the end of a sequence of Partials time is the time in seconds at which to attempt to estimate the fundamental frequency lowerFreqBound is the lower bound on the fundamental frequency estimate (in Hz) upperFreqBound is the lower bound on the fundamental frequency estimate (in Hz)
- Returns:
- the estimate of fundamental frequency in Hz and the confidence associated with that estimate (see F0Estimate.h)
The documentation for this class was generated from the following file:
- /Users/kfitz/Projects/Loris/Loris development/src/Fundamental.h
