r155: *** empty log message ***
[ctsim.git] / include / filter.h
index 274d7920443ec1f7b5a8e7d67db607eab0ac1042..6ad776792158c2f4d6d7604268a39f2baa4a67fd 100644 (file)
+/*****************************************************************************
+** 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: filter.h,v 1.14 2000/07/19 04:33:27 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 FILTER_H
+#define FILTER_H
+
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#ifdef HAVE_FFTW
+#include <fftw.h>
+#include <rfftw.h>
+#endif
+
+#include <complex>
+
+
 class SignalFilter {
  public:
 
-    SignalFilter (const FilterType filt_type, double bw, double xmin, double xmax, int n, double param, const DomainType domain, const int numInt);
+    typedef enum {        
+       FILTER_INVALID,
+       FILTER_BANDLIMIT, 
+       FILTER_SINC,
+       FILTER_G_HAMMING,
+       FILTER_COSINE,
+       FILTER_TRIANGLE,
+       FILTER_ABS_BANDLIMIT,   // filter times |x| 
+       FILTER_ABS_SINC, 
+       FILTER_ABS_G_HAMMING,
+       FILTER_ABS_COSINE,
+       FILTER_SHEPP
+    } FilterID;
+
+    typedef enum {
+       FILTER_METHOD_INVALID,
+       FILTER_METHOD_CONVOLUTION,
+       FILTER_METHOD_FOURIER,
+       FILTER_METHOD_FOURIER_TABLE,
+       FILTER_METHOD_FFT,
+#if HAVE_FFTW
+       FILTER_METHOD_FFTW,
+       FILTER_METHOD_RFFTW,
+#endif
+    } FilterMethodID;
+
+    typedef enum {
+       DOMAIN_INVALID,
+       DOMAIN_FREQUENCY,
+       DOMAIN_SPATIAL 
+    } DomainID;
+    
+    static const char FILTER_ABS_BANDLIMIT_STR[]= "abs_bandlimit";
+    static const char FILTER_ABS_SINC_STR[]=      "abs_sinc";
+    static const char FILTER_ABS_COS_STR[]=       "abs_cos";
+    static const char FILTER_ABS_HAMMING_STR[]=   "abs_hamming";
+    static const char FILTER_SHEPP_STR[]=         "shepp";
+    static const char FILTER_BANDLIMIT_STR[]=     "bandlimit";
+    static const char FILTER_SINC_STR[]=          "sinc";
+    static const char FILTER_COS_STR[]=           "cos";
+    static const char FILTER_HAMMING_STR[]=       "hamming";
+    static const char FILTER_TRIANGLE_STR[]=      "triangle";
+    
+    static const char FILTER_METHOD_CONVOLUTION_STR[]=  "convolution";
+    static const char FILTER_METHOD_FOURIER_STR[]=      "fourier";
+    static const char FILTER_METHOD_FOURIER_TABLE_STR[]="fourier_table";
+    static const char FILTER_METHOD_FFT_STR[]=          "fft";
+#if HAVE_FFTW
+    static const char FILTER_METHOD_FFTW_STR[]=         "fftw";
+    static const char FILTER_METHOD_RFFTW_STR[]=        "rfftw";
+#endif
+
+    static const char DOMAIN_FREQUENCY_STR[]="frequency";
+    static const char DOMAIN_SPATIAL_STR[]="spatial";
+
+
+    SignalFilter (const char* filterName, const char* filterMethodName,double bw, double signalIncrement, int n, double param, const char* domainName, const int zeropad = 0, const int preinterpolationFactor = 1);
+
+    SignalFilter (const FilterID filt_type, FilterMethodID filterMethodID, double bw, double signalIncrement, int n, double param, const DomainID domain, const int zeropad = 0, const int preinterpolationFactor = 1);
+
+    SignalFilter (const char* filterName, const char* domainName, double bw, double param);
 
     ~SignalFilter (void);
 
     double* getFilter (void) const
       { return m_vecFilter; }
 
-    double convolve (const double f[], const double dx, const int n, const int np, const FunctionSymmetry func_type) const;
+    int getNFilterPoints (void) const
+       { return m_nFilterPoints; }
+
+    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;
+
+    void filterSignal (const double input[], double output[]) const;
+    void filterSignal (const float input[], double output[]) const;
+
+    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);
+
+    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 float f[], const double dx, const int n, const int np, const FunctionSymmetry func_type) const;
+    void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
 
-    static double spatialResponseCalc (FilterType fType, double bw, double x, double param, int n);
+    bool fail(void) const      {return m_fail;}
+    const string& failMessage(void) const {return m_failMessage;}
 
-    static double spatialResponseAnalytic (FilterType fType, double bw, double x, double param);
+    const string& nameFilter(void) const       { return m_nameFilter;}
+    const string& nameDomain(void) const       { return m_nameDomain;}
+    const FilterID idFilter(void) const        { return m_idFilter;}
+    const DomainID idDomain(void) const        { return m_idDomain;}
+    const double getFilterMin(void) const {return m_filterMin;}
+    const double getFilterMax(void) const {return m_filterMax;}
+    const double getFilterIncrement(void) const {return m_filterInc;}
 
-    static double frequencyResponse (FilterType fType, double bw, double u, double param);
+    double response (double x);
+
+    static double spatialResponse (FilterID fType, double bw, double x, double param);
+
+    static double frequencyResponse (FilterID fType, double bw, double u, double param);
+
+    static double spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
+
+    static double spatialResponseCalc (FilterID fType, double bw, double x, double param, int nIntegral);
+
+    static void setNumIntegral(int nIntegral) {N_INTEGRAL = nIntegral;}
 
  private:
-    double *m_vecFilter;
     double m_bw;
-    FilterType m_filterType;
-
-    double spatialResponseCalc (double x, double param, int n) const;
+    int m_nFilterPoints;
+    int m_nSignalPoints;
+    double m_signalInc;
+    double m_filterMin;
+    double m_filterMax;
+    double m_filterInc;
+    double* m_vecFilter;
+    double* m_vecFourierCosTable;
+    double* m_vecFourierSinTable;
+    complex<double>* m_complexVecFilter;
+#ifdef HAVE_FFTW
+    fftw_real* m_vecRealFftInput, *m_vecRealFftSignal;
+    rfftw_plan m_realPlanForward, m_realPlanBackward;
+    fftw_complex* m_vecComplexFftInput, *m_vecComplexFftSignal;
+    fftw_plan m_complexPlanForward, m_complexPlanBackward;
+#endif
+
+    bool m_fail;
+    string m_failMessage;
+    string m_nameFilter;
+    string m_nameFilterMethod;
+    string m_nameDomain;
+    FilterID m_idFilter;
+    FilterMethodID m_idFilterMethod;
+    DomainID m_idDomain;
+    double m_filterParam;
+    int m_traceLevel;
+    int m_zeropad;
+    int m_nOutputPoints;
+    int m_preinterpolationFactor;
+
+    static int N_INTEGRAL;
+
+    static const bool haveAnalyticSpatial (const FilterID filterID);
+    static const FilterID convertFilterNameToID (const char* filterName);
+    static const char* convertFilterIDToName (const FilterID filterID);
+    static const FilterMethodID convertFilterMethodNameToID (const char* filterMethodName);
+    static const char* convertFilterMethodIDToName (const FilterMethodID filterMethodID);
+    static const DomainID convertDomainNameToID (const char* domainName);
+    static const char* convertDomainIDToName (const DomainID domainID);
+
+    void init (const FilterID filt_type, const FilterMethodID filterMethod, double bw, double signalIncrement, int n, double param, const DomainID domain, const int zeropad, const int preInterpScale);
+
+    double spatialResponseCalc (double x, double param) const;
 
     double spatialResponseAnalytic (double x, double param) const;
 
@@ -36,3 +211,4 @@ class SignalFilter {
 
 };
 
+#endif