PeakDetection.h

/*                                                         
** Copyright (C) 2008, 2009 Ricard Marxer <email@ricardmarxer.com>
**                                                                  
** 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.
*/                                                                          

#ifndef PEAKDETECTION_H
#define PEAKDETECTION_H

#include "Typedefs.h"
#include "Debug.h"

#include <limits>

class PeakDetection {
public:
  enum SortMethod {
    NONE              = 0 ,
    BYMAGNITUDE       = 1 ,
    BYPOSITION        = 2 
  };

protected:
  // Internal parameters
  int _peakCount;
  int _minimumPeakWidth;
  int _candidateCount;
  Real _minimumPeakContrast;
    
  SortMethod _sortMethod;

  // Internal variables
  MatrixXR _magnitudes;

public:
  PeakDetection(int peakCount = 1024 / 3, SortMethod sort = BYMAGNITUDE, int minimumPeakWidth = 3, int candidateCount = -1, Real minimumPeakContrast = 0);

  ~PeakDetection();

  void reset();
  void setup();
  
  void process(const MatrixXR& frames,
               MatrixXR* peakPositions, MatrixXR* peakMagnitudes);

  int peakCount() const;

  void setPeakCount( int count, bool callSetup = true );

  int minimumPeakWidth() const;

  void setMinimumPeakWidth( int width, bool callSetup = true );

  int candidateCount() const;

  void setCandidateCount( int count, bool callSetup = true );

  Real minimumPeakContrast() const;

  void setMinimumPeakContrast( Real contrast, bool callSetup = true );

  SortMethod sortMethod() const;

  void setSortMethod( SortMethod method, bool callSetup = true );
};

#endif  /* PEAKDETECTION_H */

---