CLAM-Development  1.4.0
SpectralPeakDetect.hxx
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
3  * UNIVERSITAT POMPEU FABRA
4  *
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  */
21 
22 #ifndef _SpectralPeakDetect_
23 #define _SpectralPeakDetect_
24 
25 #include "Processing.hxx"
26 #include "InPort.hxx"
27 #include "OutPort.hxx"
29 #include "Spectrum.hxx"
30 
31 namespace CLAM
32 {
33 
34  class SpectralPeakArray;
35  class Storage;
36  class ProcessingConfig;
37 
49 
50  protected: // attributes
52 
55 
56  protected: // methods
60  const char *GetClassName() const {return "SpectralPeakDetect";}
61 
68 
69  public:
76 
78  virtual ~SpectralPeakDetect();
79 
80 
84  const ProcessingConfig &GetConfig() const { return mConfig;}
85 
87  bool Do(void);
88 
94  bool Do(const Spectrum& input, SpectralPeakArray& out);
95 
102  bool SetPrototypes(Spectrum& inputs,const SpectralPeakArray& out);
103 
104  bool SetPrototypes();
105 
106  bool UnsetPrototypes();
107 
108  bool MayDisableExecution() const {return true;}
109 
110  private:
112  inline void Detect(Spectrum& inputs, Spectrum& out);
113 
114  bool CheckInputType(const Spectrum &in);
115  bool CheckOutputType(const SpectralPeakArray &out);
116 
117  Spectrum mTmpLinearInSpectrum;
118  };
119 
120 } //namespace CLAM
121 
122 #endif // _SpectralPeak_Detect_
123