Fundamental.h

#ifndef INCLUDE_FUNDAMENTAL_H
#define INCLUDE_FUNDAMENTAL_H
/*
 * This is the Loris C++ Class Library, implementing analysis, 
 * manipulation, and synthesis of digitized sounds using the Reassigned 
 * Bandwidth-Enhanced Additive Sound Model.
 *
 * Loris is Copyright (c) 1999-2007 by Kelly Fitz and Lippold Haken
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 * Fundamental.h
 *
 * Definition of class Fundamental for computing an estimate of 
 * fundamental frequency from a sequence of Partials using a 
 * maximum likelihood algorithm.
 *
 * Kelly Fitz, 10 June 2004
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "LorisExceptions.h"
#include "Envelope.h"
#include "LinearEnvelope.h"
#include "PartialList.h"

//  begin namespace
namespace Loris {


// ---------------------------------------------------------------------------
//  class Fundamental
//
//
class Fundamental : public Envelope
{
//  -- instance variables --
    PartialList partials_;      //  store a collated copy of the 
                                //  sequence of Partials
    double freqMin_, freqMax_;  //  frequency bounds on the search for 
                                //  a likely estimate
    double ampThreshold_;       //  minimum Partial amplitude (dB), quieter Partials
                                //  are ignored when estimating the fundamental
    double freqResolution_;     //  estimates of fundamental frequency are 
                                //  computed iteratively until within this
                                //  many Hz of the local most likely value
    
//  -- public interface --
public:
//  -- construction --

#if !defined(NO_TEMPLATE_MEMBERS)
    template<typename Iter>
    Fundamental( Iter begin_partials, Iter end_partials,
                 double fmin, double fmax  ); 
#else 
    Fundamental( PartialList::const_iterator begin_partials, 
                 PartialList::const_iterator end_partials,
                 double fmin, double fmax );
#endif
    
    //  copy, assign, and destroy are free, the 
    //  compiler-generated versions are OK   
     
//  -- estimation of fundamental frequency --

    double estimateAt( double time ) const;

    double operator() ( double time ) const;
     
    LinearEnvelope constructEnvelope( double interval ) const;
     
    LinearEnvelope 
    constructEnvelope( double t1, double t2, double interval ) const;
 
//  -- parameter access/mutation --

    double ampThreshold( void ) const { return ampThreshold_; }
    
    void setAmpThreshold( double x );
    
    double freqResolution( void ) const { return freqResolution_; }
    
    void setFreqResolution( double x ); 
    
//  -- Envelope interface --

    virtual Fundamental * clone( void ) const 
        { return new Fundamental( *this ); }
    
    virtual double valueAt( double time ) const
        { return estimateAt( time ); }
     
//  -- default parameters --

    static const double DefaultThreshold;   
    static const double DefaultResolution;  

private:
//  -- internal implementation members --
    void preparePartials( void );   //  preprocess the Partials for speed
    
};  // end of class FrequencyReference


// ---------------------------------------------------------------------------
//  constructor from Partial range
// ---------------------------------------------------------------------------
//  Construct a fundamental estimator for a sequence
//  of Partials. [begin_partials, end_partials) must 
//  specify a valid range of Partials. f1 and f2 are 
//  frequency bounds on the search for a likely estimate
//  of the fundamental (a narrower range will speed 
//  up the search). Throws InvalidArgument if f1==f2 or
//  if either frequency is negative.
//
#if !defined(NO_TEMPLATE_MEMBERS)
template <typename Iter>
Fundamental::Fundamental( Iter begin_partials, Iter end_partials,
                          double f1, double f2  ) :
#else
inline
Fundamental::Fundamental( PartialList::const_iterator begin_partials, 
                          PartialList::const_iterator end_partials,
                          double f1, double f2 ) :
#endif
    //  initializers
    partials_( begin_partials, end_partials ),
    freqMin_( (f1<f2)?(f1):(f2) ),  //  the lesser of f1 and f2
    freqMax_( (f1<f2)?(f2):(f1) ),  //  the greater of f1 and f2
    ampThreshold_( DefaultThreshold ),
    freqResolution_( DefaultResolution )
{
    //  sanity check:
    if ( f1 == f2 )
    {
        Throw( InvalidArgument, "Cannot estimate the fundamental over "
                                "an empty frequency range." );
    }
    if ( f1 < 0 )
    {
        Throw( InvalidArgument, "Cannot estimate the fundamental over "
                                "a negative frequency range." );
    }
    
    preparePartials();
}

}   //  end of namespace Loris

#endif  // ndef INCLUDE_FUNDAMENTAL_H

---