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