SpectralPeakDetect.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * 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 _SpectralPeakDetect_
#define _SpectralPeakDetect_

#include "Processing.hxx"
#include "InPort.hxx"
#include "OutPort.hxx"
#include "SpectralPeakDetectConfig.hxx"
#include "Spectrum.hxx"

namespace CLAM
{

        class SpectralPeakArray;
        class Storage;
        class ProcessingConfig;

        class SpectralPeakDetect: public Processing {

        protected: // attributes
                SpectralPeakDetectConfig mConfig;

                InPort< Spectrum >           mInput;
                OutPort< SpectralPeakArray > mOutput;

        protected: // methods
                const char *GetClassName() const {return "SpectralPeakDetect";}

                bool ConcreteConfigure(const ProcessingConfig&);

        public:
                SpectralPeakDetect();
                SpectralPeakDetect(const SpectralPeakDetectConfig &c);

                virtual ~SpectralPeakDetect();


                const ProcessingConfig &GetConfig() const { return mConfig;}

                bool Do(void);

                bool Do(const Spectrum& input, SpectralPeakArray& out);

                bool SetPrototypes(Spectrum& inputs,const SpectralPeakArray& out);

                bool SetPrototypes();

                bool UnsetPrototypes();

                bool MayDisableExecution() const {return true;}

        private:
                inline void Detect(Spectrum& inputs, Spectrum& out);

                bool CheckInputType(const Spectrum &in);
                bool CheckOutputType(const SpectralPeakArray &out);
                
                Spectrum mTmpLinearInSpectrum;
        }; 

} //namespace CLAM

#endif // _SpectralPeak_Detect_