Loris::FrequencyReference Class Reference

#include <FrequencyReference.h>

Inheritance diagram for Loris::FrequencyReference:
Loris::Envelope

List of all members.

Public Member Functions

 FrequencyReference (PartialList::const_iterator begin, PartialList::const_iterator end, double minFreq, double maxFreq, long numSamps)
 FrequencyReference (PartialList::const_iterator begin, PartialList::const_iterator end, double minFreq, double maxFreq)
 FrequencyReference (const FrequencyReference &other)
FrequencyReferenceoperator= (const FrequencyReference &other)
 ~FrequencyReference ()
 Destroy this FrequencyReference.
LinearEnvelope envelope (void) const
 FrequencyReference at all time.
virtual FrequencyReferenceclone (void) const
virtual double valueAt (double x) const

Detailed Description

Class FrequencyReference represents a reference frequency envelope derived from an estimate of the fundamental frequency of a given range of Partials within in a specified frequency range. This reference envelope can be used for channelizing the Partials in preparation for morphing (see Channelizer.h).

FrequencyReference implements the Envelope interface (see Envelope.h).


Constructor & Destructor Documentation

Loris::FrequencyReference::FrequencyReference ( PartialList::const_iterator  begin,
PartialList::const_iterator  end,
double  minFreq,
double  maxFreq,
long  numSamps 
)

Construct a new fundamental FrequencyReference derived from the specified half-open (STL-style) range of Partials that lies within the speficied average frequency range. Construct the reference envelope with approximately numSamps points.

Parameters:
begin The beginning of a range of Partials from which to construct a frequency refence envelope.
end The end of a range of Partials from which to construct a frequency refence envelope.
minFreq The minimum expected fundamental frequency.
maxFreq The maximum expected fundamental frequency.
numSamps The approximate number of estimate of the fundamental frequency from which to construct the frequency reference envelope.
Loris::FrequencyReference::FrequencyReference ( PartialList::const_iterator  begin,
PartialList::const_iterator  end,
double  minFreq,
double  maxFreq 
)

Construct a new fundamental FrequencyReference derived from the specified half-open (STL-style) range of Partials that lies within the speficied average frequency range. Construct the reference envelope from fundamental estimates taken every five milliseconds.

Parameters:
begin The beginning of a range of Partials from which to construct a frequency refence envelope.
end The end of a range of Partials from which to construct a frequency refence envelope.
minFreq The minimum expected fundamental frequency.
maxFreq The maximum expected fundamental frequency.
Loris::FrequencyReference::FrequencyReference ( const FrequencyReference other  ) 

Construct a new FrequencyReference that is an exact copy of the specified FrequencyReference.


Member Function Documentation

virtual FrequencyReference* Loris::FrequencyReference::clone ( void   )  const [virtual]

Return an exact copy of this FrequencyReference (following the Prototype pattern).

Implements Loris::Envelope.

LinearEnvelope Loris::FrequencyReference::envelope ( void   )  const

FrequencyReference at all time.

Return a LinearEnvelope that evaluates indentically to this

FrequencyReference& Loris::FrequencyReference::operator= ( const FrequencyReference other  ) 

Assignment operator: make this FrequencyReference an exact copy of the specified FrequencyReference.

virtual double Loris::FrequencyReference::valueAt ( double  x  )  const [virtual]

Return the frequency value (in Hz) of this FrequencyReference at the specified time.

Implements Loris::Envelope.


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

Generated by  doxygen 1.6.2