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.10 2000/07/06 08:30:30 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 class SignalFilter {
  32  public:
  33
  34     typedef enum {
  35         FILTER_INVALID,
  36         FILTER_BANDLIMIT,
  37         FILTER_SINC,
  38         FILTER_G_HAMMING,
  39         FILTER_COSINE,
  40         FILTER_TRIANGLE,
  41         FILTER_ABS_BANDLIMIT,   // filter times |x|
  42         FILTER_ABS_SINC,
  43         FILTER_ABS_G_HAMMING,
  44         FILTER_ABS_COSINE,
  45         FILTER_SHEPP
  46     } FilterID;
  47
  48     typedef enum {
  49         FILTER_METHOD_INVALID,
  50         FILTER_METHOD_CONVOLUTION,
  51         FILTER_METHOD_FOURIER,
  52         FILTER_METHOD_FFT,
  53         FILTER_METHOD_FFTW,
  54     } FilterMethodID;
  55
  56     typedef enum {
  57         DOMAIN_INVALID,
  58         DOMAIN_FREQUENCY,
  59         DOMAIN_SPATIAL
  60     } DomainID;
  61
  62     static const char FILTER_ABS_BANDLIMIT_STR[]= "abs_bandlimit";
  63     static const char FILTER_ABS_SINC_STR[]=      "abs_sinc";
  64     static const char FILTER_ABS_COS_STR[]=       "abs_cos";
  65     static const char FILTER_ABS_HAMMING_STR[]=   "abs_hamming";
  66     static const char FILTER_SHEPP_STR[]=         "shepp";
  67     static const char FILTER_BANDLIMIT_STR[]=     "bandlimit";
  68     static const char FILTER_SINC_STR[]=          "sinc";
  69     static const char FILTER_COS_STR[]=           "cos";
  70     static const char FILTER_HAMMING_STR[]=       "hamming";
  71     static const char FILTER_TRIANGLE_STR[]=      "triangle";
  72
  73     static const char FILTER_METHOD_CONVOLUTION_STR[]=  "convolution";
  74     static const char FILTER_METHOD_FOURIER_STR[]=      "fourier";
  75     static const char FILTER_METHOD_FFT_STR[]=          "fft";
  76     static const char FILTER_METHOD_FFTW_STR[]=         "fftw";
  77
  78     static const char DOMAIN_FREQUENCY_STR[]="frequency";
  79     static const char DOMAIN_SPATIAL_STR[]="spatial";
  80
  81
  82     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);
  83
  84     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);
  85
  86     SignalFilter (const char* filterName, const char* domainName, double bw, double param, int numIntegral = 0);
  87
  88     ~SignalFilter (void);
  89
  90     double* getFilter (void) const
  91       { return m_vecFilter; }
  92
  93     int getNFilterPoints (void) const
  94         { return m_nFilterPoints; }
  95
  96     double convolve (const double f[], const double dx, const int n, const int np) const;
  97
  98     double convolve (const float f[], const double dx, const int n, const int np) const;
  99
 100     void filterSignal (const double input[], double output[]) const;
 101     void filterSignal (const float input[], double output[]) const;
 102
 103     static void finiteFourierTransform (const double input[], complex<double> output[], const int n, const int direction);
 104
 105     static void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int n, const int direction);
 106
 107     void finiteFourierTransform (const double input[], complex<double> output[], const int direction) const;
 108
 109     void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int direction) const;
 110
 111     void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
 112
 113     bool fail(void) const       {return m_fail;}
 114     const string& failMessage(void) const {return m_failMessage;}
 115
 116     const string& nameFilter(void) const        { return m_nameFilter;}
 117     const string& nameDomain(void) const        { return m_nameDomain;}
 118     const FilterID idFilter(void) const         { return m_idFilter;}
 119     const DomainID idDomain(void) const         { return m_idDomain;}
 120     const double getFilterMin(void) const {return m_filterMin;}
 121     const double getFilterMax(void) const {return m_filterMax;}
 122     const double getFilterIncrement(void) const {return m_filterInc;}
 123
 124     double response (double x);
 125
 126     static double spatialResponse (FilterID fType, double bw, double x, double param, int nIntegral = 0);
 127
 128     static double frequencyResponse (FilterID fType, double bw, double u, double param);
 129
 130     static double spatialResponseCalc (FilterID fType, double bw, double x, double param, int n);
 131
 132     static double spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
 133
 134     static void dotProduct (const double v1[], const complex<double> v2[], complex<double> output[], const int n);
 135
 136  private:
 137     double m_bw;
 138     int m_nFilterPoints;
 139     int m_nSignalPoints;
 140     double m_signalInc;
 141     double m_filterMin;
 142     double m_filterMax;
 143     double m_filterInc;
 144     double* m_vecFilter;
 145     double* m_vecFourierCosTable;
 146     double* m_vecFourierSinTable;
 147     complex<double>* m_complexVecFilter;
 148 #ifdef HAVE_FFTW
 149     fftw_plan m_planForward, m_planBackward;
 150     fftw_complex* m_vecFftInput;
 151 #else
 152     complex<double>* m_vecFftInput;
 153 #endif
 154
 155     bool m_fail;
 156     string m_failMessage;
 157     string m_nameFilter;
 158     string m_nameFilterMethod;
 159     string m_nameDomain;
 160     FilterID m_idFilter;
 161     FilterMethodID m_idFilterMethod;
 162     DomainID m_idDomain;
 163     double m_filterParam;
 164     int m_numIntegral;
 165     int m_traceLevel;
 166     int m_zeropad;
 167
 168     static const FilterID convertFilterNameToID (const char* filterName);
 169     static const char* convertFilterIDToName (const FilterID filterID);
 170     static const FilterMethodID convertFilterMethodNameToID (const char* filterMethodName);
 171     static const char* convertFilterMethodIDToName (const FilterMethodID filterMethodID);
 172     static const DomainID convertDomainNameToID (const char* domainName);
 173     static const char* convertDomainIDToName (const DomainID domainID);
 174
 175     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);
 176
 177 double spatialResponseCalc (double x, double param, int n) const;
 178
 179     double spatialResponseAnalytic (double x, double param) const;
 180
 181     double frequencyResponse (double u, double param) const;
 182
 183     static double sinc (double x, double mult)
 184       { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
 185
 186     static double integral_abscos (double u, double w);
 187
 188 };
 189
 190
 191 #endif