include/filter.h

   1 /*****************************************************************************
   2 ** FILE IDENTIFICATION
   3 **
   4 **      Name:         filter.h
   5 **      Purpose:      Signal filter header file
   6 **      Programmer:   Kevin Rosenberg
   7 **      Date Started: June 2000
   8 **
   9 **  This is part of the CTSim program
  10 **  Copyright (C) 1983-2000 Kevin Rosenberg
  11 **
  12 **  $Id: filter.h,v 1.11 2000/07/06 18:37:24 kevin Exp $
  13 **
  14 **  This program is free software; you can redistribute it and/or modify
  15 **  it under the terms of the GNU General Public License (version 2) as
  16 **  published by the Free Software Foundation.
  17 **
  18 **  This program is distributed in the hope that it will be useful,
  19 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 **  GNU General Public License for more details.
  22 **
  23 **  You should have received a copy of the GNU General Public License
  24 **  along with this program; if not, write to the Free Software
  25 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  26 ******************************************************************************/
  27
  28 #ifndef FILTER_H
  29 #define FILTER_H
  30
  31
  32 class SignalFilter {
  33  public:
  34
  35     typedef enum {
  36         FILTER_INVALID,
  37         FILTER_BANDLIMIT,
  38         FILTER_SINC,
  39         FILTER_G_HAMMING,
  40         FILTER_COSINE,
  41         FILTER_TRIANGLE,
  42         FILTER_ABS_BANDLIMIT,   // filter times |x|
  43         FILTER_ABS_SINC,
  44         FILTER_ABS_G_HAMMING,
  45         FILTER_ABS_COSINE,
  46         FILTER_SHEPP
  47     } FilterID;
  48
  49     typedef enum {
  50         FILTER_METHOD_INVALID,
  51         FILTER_METHOD_CONVOLUTION,
  52         FILTER_METHOD_FOURIER,
  53         FILTER_METHOD_FOURIER_TABLE,
  54         FILTER_METHOD_FFT,
  55         FILTER_METHOD_FFTW,
  56         FILTER_METHOD_RFFTW
  57     } FilterMethodID;
  58
  59     typedef enum {
  60         DOMAIN_INVALID,
  61         DOMAIN_FREQUENCY,
  62         DOMAIN_SPATIAL
  63     } DomainID;
  64
  65     static const char FILTER_ABS_BANDLIMIT_STR[]= "abs_bandlimit";
  66     static const char FILTER_ABS_SINC_STR[]=      "abs_sinc";
  67     static const char FILTER_ABS_COS_STR[]=       "abs_cos";
  68     static const char FILTER_ABS_HAMMING_STR[]=   "abs_hamming";
  69     static const char FILTER_SHEPP_STR[]=         "shepp";
  70     static const char FILTER_BANDLIMIT_STR[]=     "bandlimit";
  71     static const char FILTER_SINC_STR[]=          "sinc";
  72     static const char FILTER_COS_STR[]=           "cos";
  73     static const char FILTER_HAMMING_STR[]=       "hamming";
  74     static const char FILTER_TRIANGLE_STR[]=      "triangle";
  75
  76     static const char FILTER_METHOD_CONVOLUTION_STR[]=  "convolution";
  77     static const char FILTER_METHOD_FOURIER_STR[]=      "fourier";
  78     static const char FILTER_METHOD_FOURIER_TABLE_STR[]="fourier_table";
  79     static const char FILTER_METHOD_FFT_STR[]=          "fft";
  80     static const char FILTER_METHOD_FFTW_STR[]=         "fftw";
  81     static const char FILTER_METHOD_RFFTW_STR[]=        "rfftw";
  82
  83     static const char DOMAIN_FREQUENCY_STR[]="frequency";
  84     static const char DOMAIN_SPATIAL_STR[]="spatial";
  85
  86
  87     SignalFilter (const char* filterName, const char* filterMethodName,double bw, double signalIncrement, int n, double param, const char* domainName, const int zeropad = 0, const int numIntegral = 0);
  88
  89     SignalFilter (const FilterID filt_type, FilterMethodID filterMethodID, double bw, double signalIncrement, int n, double param, const DomainID domain, const int zeropad = 0, const int numIntegral = 0);
  90
  91     SignalFilter (const char* filterName, const char* domainName, double bw, double param, int numIntegral = 0);
  92
  93     ~SignalFilter (void);
  94
  95     double* getFilter (void) const
  96       { return m_vecFilter; }
  97
  98     int getNFilterPoints (void) const
  99         { return m_nFilterPoints; }
 100
 101     double convolve (const double f[], const double dx, const int n, const int np) const;
 102
 103     double convolve (const float f[], const double dx, const int n, const int np) const;
 104
 105     void filterSignal (const double input[], double output[]) const;
 106     void filterSignal (const float input[], double output[]) const;
 107
 108     static void finiteFourierTransform (const double input[], complex<double> output[], const int n, const int direction);
 109     static void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int n, const int direction);
 110     static void finiteFourierTransform (const complex<double> input[], double output[], const int n, const int direction);
 111
 112     void finiteFourierTransform (const double input[], complex<double> output[], const int direction) const;
 113     void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int direction) const;
 114     void finiteFourierTransform (const complex<double> input[], double output[], const int direction) const;
 115
 116     void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
 117
 118     bool fail(void) const       {return m_fail;}
 119     const string& failMessage(void) const {return m_failMessage;}
 120
 121     const string& nameFilter(void) const        { return m_nameFilter;}
 122     const string& nameDomain(void) const        { return m_nameDomain;}
 123     const FilterID idFilter(void) const         { return m_idFilter;}
 124     const DomainID idDomain(void) const         { return m_idDomain;}
 125     const double getFilterMin(void) const {return m_filterMin;}
 126     const double getFilterMax(void) const {return m_filterMax;}
 127     const double getFilterIncrement(void) const {return m_filterInc;}
 128
 129     double response (double x);
 130
 131     static double spatialResponse (FilterID fType, double bw, double x, double param, int nIntegral = 0);
 132
 133     static double frequencyResponse (FilterID fType, double bw, double u, double param);
 134
 135     static double spatialResponseCalc (FilterID fType, double bw, double x, double param, int n);
 136
 137     static double spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
 138
 139     static void dotProduct (const double v1[], const complex<double> v2[], complex<double> output[], const int n);
 140
 141  private:
 142     double m_bw;
 143     int m_nFilterPoints;
 144     int m_nSignalPoints;
 145     double m_signalInc;
 146     double m_filterMin;
 147     double m_filterMax;
 148     double m_filterInc;
 149     double* m_vecFilter;
 150     double* m_vecFourierCosTable;
 151     double* m_vecFourierSinTable;
 152     complex<double>* m_complexVecFilter;
 153 #ifdef HAVE_FFTW
 154     fftw_real* m_vecRealFftInput;
 155     rfftw_plan m_realPlanForward, m_realPlanBackward;
 156     fftw_complex* m_vecComplexFftInput;
 157     fftw_plan m_complexPlanForward, m_complexPlanBackward;
 158 #else
 159     complex<double>* m_vecFftInput;
 160 #endif
 161
 162     bool m_fail;
 163     string m_failMessage;
 164     string m_nameFilter;
 165     string m_nameFilterMethod;
 166     string m_nameDomain;
 167     FilterID m_idFilter;
 168     FilterMethodID m_idFilterMethod;
 169     DomainID m_idDomain;
 170     double m_filterParam;
 171     int m_numIntegral;
 172     int m_traceLevel;
 173     int m_zeropad;
 174
 175     static const FilterID convertFilterNameToID (const char* filterName);
 176     static const char* convertFilterIDToName (const FilterID filterID);
 177     static const FilterMethodID convertFilterMethodNameToID (const char* filterMethodName);
 178     static const char* convertFilterMethodIDToName (const FilterMethodID filterMethodID);
 179     static const DomainID convertDomainNameToID (const char* domainName);
 180     static const char* convertDomainIDToName (const DomainID domainID);
 181
 182     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 numInt);
 183
 184 double spatialResponseCalc (double x, double param, int n) const;
 185
 186     double spatialResponseAnalytic (double x, double param) const;
 187
 188     double frequencyResponse (double u, double param) const;
 189
 190     static double sinc (double x, double mult)
 191       { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
 192
 193     static double integral_abscos (double u, double w);
 194
 195 };
 196
 197
 198 #endif