/usr/include/CLAM/SpectralEnvelopeExtract.hxx is in libclam-dev 1.4.0-5.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | /*
* 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 _SpectralEnvelope_Extract_
#define _SpectralEnvelope_Extract_
#include "Processing.hxx"
#include "SpectralEnvelopeExtractConfig.hxx"
#include "BPF.hxx"
namespace CLAM {
class Spectrum;
class SpectralPeakArray;
class Storage;
class ProcessingConfig;
/** Configuration class for SpectralEnvelopeExtract objects
* @see ProcessingConfig, SpectralEnvelopeExtract
*/
/* SpectralEnvelopeExtractConfig moved to SpectralEnvelopeExtractConfig.hxx */
/**
* Processing to extract spectral envelope from an array of spectral peaks.
*/
class SpectralEnvelopeExtract: public Processing {
SpectralEnvelopeExtractConfig mConfig;
/** This method returns the name of the object
* @return Char pointer with the name of object
*/
const char *GetClassName() const {return "SpectralEnvelopeExtract";}
/** Config change method
* @param The ProcessingConfig object
* @pre argument should be an SpectralEnvelopeExtractConfig object.
* @return True if the cast has been commited correctly
*/
bool ConcreteConfigure(const ProcessingConfig&);
public:
/** Base constructor of class. Calls Configure method with a SpectralEnvelopeExtractConfig initialised by default*/
SpectralEnvelopeExtract();
/** Constructor with an object of SpectralEnvelopeExtractConfig class by parameter
* @param c SpectralEnvelopeExtractConfig object created by the user
*/
SpectralEnvelopeExtract(const SpectralEnvelopeExtractConfig &c);
/** Destructor of the class*/
~SpectralEnvelopeExtract();
/** This method allows to obtain the SpectralEnvelopeExtractConfig object of the class
* @return The configuration of the class
*/
const ProcessingConfig &GetConfig() const { return mConfig;}
/** Supervised Do() function, not implemented yet*/
bool Do(void);
/** Unsupervised Do function, receives an Spectrum object input, and the output of method is an SpectralPeakArray (passed by parameter)
* @param input The Spectral Peaks we want to extract the envelope from
* @param output A Spectrum in BPF form that represents the Spectral Envelope
* @return Boolean value, true if all has been executed correctly.
*/
bool Do(const SpectralPeakArray& input,Spectrum& output);
/** Change the internal type state.
*/
bool SetPrototypes(const SpectralPeakArray& input,Spectrum& output);
bool SetPrototypes();
bool UnsetPrototypes();
bool MayDisableExecution() const {return true;}
private:
/** Checks if the output type has the correct size and attributes .
* If not, resize Buffers and changes control flags to set correctly the object
* @param out SpectrumSpectralPeakArray object to be checked
* @return true if success
*/
bool CheckOutputType(Spectrum& out);
//member BPF's used for initialization
BPF mMagBPF;
BPF mPhaseBPF;
};
};//namespace CLAM
#endif // _SpectralEnvelope_Extract_
|