include/procsignal.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: procsignal.h,v 1.9 2000/12/29 15:45:06 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 PROCSIGNAL_H
  29 #define PROCSIGNAL_H
  30
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35 #ifdef HAVE_FFTW
  36 #include <fftw.h>
  37 #include <rfftw.h>
  38 #endif
  39
  40 #include <complex>
  41
  42 class SignalFilter;
  43 class SGP;
  44
  45 class ProcessSignal {
  46  public:
  47     static const int FILTER_METHOD_INVALID;
  48     static const int FILTER_METHOD_CONVOLUTION;
  49     static const int FILTER_METHOD_FOURIER;
  50     static const int FILTER_METHOD_FOURIER_TABLE;
  51     static const int FILTER_METHOD_FFT;
  52 #if HAVE_FFTW
  53     static const int FILTER_METHOD_FFTW;
  54     static const int FILTER_METHOD_RFFTW;
  55 #endif
  56
  57     static const int FILTER_GENERATION_INVALID;
  58     static const int FILTER_GENERATION_DIRECT;
  59     static const int FILTER_GENERATION_INVERSE_FOURIER;
  60 \r
  61     enum {\r
  62       FORWARD = -1,\r
  63       BACKWARD = 1,\r
  64     };\r
  65
  66     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, const int iTraceLevel = Trace::TRACE_NONE, int iGeometry = Scanner::GEOMETRY_PARALLEL, double dFocalLength = 1., SGP* pSGP = NULL);
  67
  68     ~ProcessSignal();
  69
  70     void filterSignal (const float input[], double output[]) const;
  71
  72     bool fail(void) const       {return m_fail;}
  73     const std::string& failMessage(void) const {return m_failMessage;}
  74
  75     void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
  76
  77     int getNFilterPoints (void) const  { return m_nFilterPoints; }
  78     const double getFilterMin(void) const {return m_dFilterMin;}
  79     const double getFilterMax(void) const {return m_dFilterMax;}
  80     const double getFilterIncrement(void) const {return m_dFilterInc;}
  81     double* getFilter(void) {return m_adFilter;}
  82     const double* getFilter(void) const {return m_adFilter;}
  83
  84     const int idFilterGeneration() const { return m_idFilterGeneration;}
  85
  86     static const int getFilterGenerationCount() {return s_iFilterGenerationCount;}
  87     static const char** getFilterGenerationNameArray() {return s_aszFilterGenerationName;}
  88     static const char** getFilterGenerationTitleArray() {return s_aszFilterGenerationTitle;}
  89     static int convertFilterGenerationNameToID (const char* const fgName);
  90     static const char* convertFilterGenerationIDToName (const int idFG);
  91     static const char* convertFilterGenerationIDToTitle (const int idFG);
  92
  93     static const int getFilterMethodCount() {return s_iFilterMethodCount;}
  94     static const char** getFilterMethodNameArray() {return s_aszFilterMethodName;}
  95     static const char** getFilterMethodTitleArray() {return s_aszFilterMethodTitle;}
  96     static int convertFilterMethodNameToID (const char* const filterMethodName);
  97     static const char* convertFilterMethodIDToName (const int idFilterMethod);
  98     static const char* convertFilterMethodIDToTitle (const int idFilterMethod);
  99
 100     // transforms using direct trigometric calculation
 101     static void finiteFourierTransform (const double input[], double output[], const int n, const int direction);
 102     static void finiteFourierTransform (const double input[], std::complex<double> output[], const int n, const int direction);
 103     static void finiteFourierTransform (const std::complex<double> input[], std::complex<double> output[], const int n, const int direction);
 104     static void finiteFourierTransform (const std::complex<double> input[], double output[], const int n, const int direction);
 105
 106
 107     static void shuffleNaturalToFourierOrder (double* pdVector, const int n);\r
 108     static void shuffleNaturalToFourierOrder (std::complex<double>* pdVector, const int n);\r
 109     static void shuffleFourierToNaturalOrder (double* pdVector, const int n);\r
 110     static void shuffleFourierToNaturalOrder (std::complex<double>* pdVector, const int n);\r
 111
 112  private:
 113          std::string m_nameFilterMethod;
 114          std::string m_nameFilterGeneration;
 115     int m_idFilterMethod;
 116     int m_idFilterGeneration;
 117     int m_nSignalPoints;
 118     double* m_adFourierCosTable;
 119     double* m_adFourierSinTable;
 120     int m_nFilterPoints;
 121     double m_dSignalInc;
 122     double m_dFilterInc;
 123     double m_dFilterMin;
 124     double m_dFilterMax;
 125     double* m_adFilter;
 126     bool m_bFrequencyFiltering;
 127
 128     // Variables also kept in SignalFilter class
 129     int m_idFilter;
 130     int m_idDomain;
 131
 132     int m_traceLevel;
 133     double m_dBandwidth;
 134     double m_dFilterParam;
 135     int m_iZeropad;
 136     int m_nOutputPoints;
 137     int m_iPreinterpolationFactor;
 138     int m_idGeometry;
 139     double m_dFocalLength;
 140
 141     bool m_fail;
 142     std::string m_failMessage;
 143
 144     static const char* s_aszFilterMethodName[];
 145     static const char* s_aszFilterMethodTitle[];
 146     static const int s_iFilterMethodCount;
 147     static const char* s_aszFilterGenerationName[];
 148     static const char* s_aszFilterGenerationTitle[];
 149     static const int s_iFilterGenerationCount;
 150
 151 #ifdef HAVE_FFTW
 152     fftw_real* m_adRealFftInput, *m_adRealFftSignal;
 153     rfftw_plan m_realPlanForward, m_realPlanBackward;
 154     fftw_complex* m_adComplexFftInput, *m_adComplexFftSignal;
 155     fftw_plan m_complexPlanForward, m_complexPlanBackward;
 156 #endif
 157
 158     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, const int iTraceLevel, const int iGeometry, double dFocalLength, SGP* pSGP);
 159
 160     // transforms that use precalculated trig tables, therefore don't
 161     // require number of data points (n) as an argument
 162     void finiteFourierTransform (const double input[], std::complex<double> output[], const int direction) const;
 163     void finiteFourierTransform (const std::complex<double> input[], std::complex<double> output[], const int direction) const;
 164     void finiteFourierTransform (const std::complex<double> input[], double output[], const int direction) const;
 165
 166     double convolve (const double func[], const double filter[], const double dx, const int n, const int np) const;
 167     double convolve (const double f[], const double dx, const int n, const int np) const;
 168     double convolve (const float f[], const double dx, const int n, const int np) const;
 169
 170 };
 171
 172
 173 #endif