#ifndef INCLUDE_SPECTRALPEAKSELECTOR_H
#define INCLUDE_SPECTRALPEAKSELECTOR_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-2010 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
 *
 *
 * SpectralPeakSelector.h
 *
 * Definition of a class representing a policy for selecting energy
 * peaks in a reassigned spectrum to be used in Partial formation.
 *
 * Kelly Fitz, 28 May 2003
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */
 
#include "SpectralPeaks.h"

//	begin namespace
namespace Loris {

class ReassignedSpectrum;

// ---------------------------------------------------------------------------
//	class SpectralPeakSelector
//
//	A class representing the process of selecting 
//	peaks (ridges) on a reassigned time-frequency surface.
//
class SpectralPeakSelector
{
// --- interface ---
public:
	//	construction:
	SpectralPeakSelector( double srate, double maxTimeCorrection );

	//	Collect and return magnitude peaks in the lower half of the spectrum, 
	//	ignoring those having frequencies below the specified minimum (in Hz), and
	//	those having large time corrections.
    //
    //  If the minimumFrequency is unspecified, 0 Hz is used.
	//
    //  There are two strategies for doing. Probably each one should be a 
    //  separate class, but for now, they are just separate functions.
    Peaks selectPeaks( ReassignedSpectrum & spectrum, double minFrequency = 0 );
    
    	
// --- implementation ---
private:

    //  There are two strategies for doing. Probably each one should be a 
    //  separate class, but for now, they are just separate functions.
    //
    //  Currently, the reassignment minima are used.
    
    Peaks selectReassignmentMinima( ReassignedSpectrum & spectrum, double minFrequency );
    Peaks selectMagnitudePeaks( ReassignedSpectrum & spectrum, double minFrequency );
        

// --- member data ---
	
	double mSampleRate;
	double mMaxTimeOffset;

	
};	//	end of class SpectralPeakSelector

}	//	end of namespace Loris

#endif /* ndef INCLUDE_SPECTRALPEAKSELECTOR_H */