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