r180: *** empty log message ***
[ctsim.git] / include / procsignal.h
diff --git a/include/procsignal.h b/include/procsignal.h
new file mode 100644 (file)
index 0000000..1b08aea
--- /dev/null
@@ -0,0 +1,167 @@
+/*****************************************************************************
+** FILE IDENTIFICATION
+**
+**     Name:         filter.h
+**      Purpose:      Signal filter header file
+**     Programmer:   Kevin Rosenberg
+**     Date Started: June 2000
+**
+**  This is part of the CTSim program
+**  Copyright (C) 1983-2000 Kevin Rosenberg
+**
+**  $Id: procsignal.h,v 1.1 2000/08/19 23:00:05 kevin Exp $
+**
+**  This program is free software; you can redistribute it and/or modify
+**  it under the terms of the GNU General Public License (version 2) as
+**  published by the Free Software Foundation.
+**
+**  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 PROCSIGNAL_H
+#define PROCSIGNAL_H
+
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#ifdef HAVE_FFTW
+#include <fftw.h>
+#include <rfftw.h>
+#endif
+
+#include <complex>
+
+
+class SignalFilter;
+
+class ProcessSignal {
+ public:
+    static const int FILTER_METHOD_INVALID;
+    static const int FILTER_METHOD_CONVOLUTION;
+    static const int FILTER_METHOD_FOURIER;
+    static const int FILTER_METHOD_FOURIER_TABLE;
+    static const int FILTER_METHOD_FFT;
+#if HAVE_FFTW
+    static const int FILTER_METHOD_FFTW;
+    static const int FILTER_METHOD_RFFTW;
+#endif
+
+    static const int FILTER_GENERATION_INVALID;
+    static const int FILTER_GENERATION_DIRECT;
+    static const int FILTER_GENERATION_INVERSE_FOURIER;
+
+    ProcessSignal (const char* szFilterName, const char* szFilterMethodName,double bw, double signalIncrement, int n, double param, const char* szDomainName, const char* szFilterGenerationName, const int zeropad = 0, const int preinterpolationFactor = 1);
+
+    ProcessSignal (const int idFilter, int idFilterMethod, double dBandwidth, double dSignalIncrement, int nSignalPoints, double dFilterParam, const int idDomain, int idFilterGeneration, const int iZeropad = 0, const int iPreinterpolationFactor = 1);
+
+    ~ProcessSignal();
+
+    void filterSignal (const double input[], double output[]) const;
+    void filterSignal (const float input[], double output[]) const;
+
+    bool fail(void) const      {return m_fail;}
+    const string& failMessage(void) const {return m_failMessage;}
+
+    void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
+
+    int getNFilterPoints (void) const  { return m_nFilterPoints; }
+    const double getFilterMin(void) const {return m_dFilterMin;}
+    const double getFilterMax(void) const {return m_dFilterMax;}
+    const double getFilterIncrement(void) const {return m_dFilterInc;}
+    double* getFilter(void) {return m_adFilter;}
+    const double* getFilter(void) const {return m_adFilter;}
+
+    const int idFilterGeneration() const { return m_idFilterGeneration;}
+
+    static const int getFilterGenerationCount() {return s_iFilterGenerationCount;}
+    static const char** getFilterGenerationNameArray() {return s_aszFilterGenerationName;}
+    static const char** getFilterGenerationTitleArray() {return s_aszFilterGenerationTitle;}
+    static int convertFilterGenerationNameToID (const char* const fgName);
+    static const char* convertFilterGenerationIDToName (const int idFG);
+    static const char* convertFilterGenerationIDToTitle (const int idFG);
+  
+    static const int getFilterMethodCount() {return s_iFilterMethodCount;}
+    static const char** getFilterMethodNameArray() {return s_aszFilterMethodName;}
+    static const char** getFilterMethodTitleArray() {return s_aszFilterMethodTitle;}
+    static int convertFilterMethodNameToID (const char* const filterMethodName);
+    static const char* convertFilterMethodIDToName (const int idFilterMethod);
+    static const char* convertFilterMethodIDToTitle (const int idFilterMethod);
+
+    // transforms using direct trigometric calculation
+    static void finiteFourierTransform (const double input[], double output[], const int n, const int direction);
+    static void finiteFourierTransform (const double input[], complex<double> output[], const int n, const int direction);
+    static void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int n, const int direction);
+    static void finiteFourierTransform (const complex<double> input[], double output[], const int n, const int direction);
+
+
+    static void shuffleNaturalToFourierOrder (double* pdVector, const int n);
+
+    static void shuffleFourierToNaturalOrder (double* pdVector, const int n);
+
+ private:
+    string m_nameFilterMethod;
+    string m_nameFilterGeneration;
+    int m_idFilterMethod;
+    int m_idFilterGeneration;
+    int m_nSignalPoints;
+    double* m_adFourierCosTable;
+    double* m_adFourierSinTable;
+    int m_nFilterPoints;
+    double m_dSignalInc;
+    double m_dFilterInc;
+    double m_dFilterMin;
+    double m_dFilterMax;
+    double* m_adFilter;
+    bool m_bFrequencyFiltering;
+
+    // Variables also kept in SignalFilter class
+    int m_idFilter;
+    int m_idDomain;
+
+    int m_traceLevel;
+    double m_dBandwidth;
+    double m_dFilterParam;
+    int m_iZeropad;
+    int m_nOutputPoints;
+    int m_iPreinterpolationFactor;
+
+    bool m_fail;
+    string m_failMessage;
+
+    static const char* s_aszFilterMethodName[];
+    static const char* s_aszFilterMethodTitle[];
+    static const int s_iFilterMethodCount;
+    static const char* s_aszFilterGenerationName[];
+    static const char* s_aszFilterGenerationTitle[];
+    static const int s_iFilterGenerationCount;
+
+#ifdef HAVE_FFTW
+    fftw_real* m_adRealFftInput, *m_adRealFftSignal;
+    rfftw_plan m_realPlanForward, m_realPlanBackward;
+    fftw_complex* m_adComplexFftInput, *m_adComplexFftSignal;
+    fftw_plan m_complexPlanForward, m_complexPlanBackward;
+#endif
+
+    void init (const int idFilter, int idFilterMethod, double dBandwidth, double dSignalIncrement, int nSignalPoints, double dFilterParam, const int idDomain, int idFilterGeneration, const int iZeropad, const int iPreinterpolationFactor);
+
+    // transforms that use precalculated trig tables, therefore don't 
+    // require number of data points (n) as an argument
+    void finiteFourierTransform (const double input[], complex<double> output[], const int direction) const;
+    void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int direction) const;
+    void finiteFourierTransform (const complex<double> input[], double output[], const int direction) const;
+
+    double convolve (const double f[], const double dx, const int n, const int np) const;
+    double convolve (const float f[], const double dx, const int n, const int np) const;
+
+};
+
+
+#endif