1 /*****************************************************************************
5 ** Purpose: Signal filter header file
6 ** Programmer: Kevin Rosenberg
7 ** Date Started: June 2000
9 ** This is part of the CTSim program
10 ** Copyright (C) 1983-2000 Kevin Rosenberg
12 ** $Id: filter.h,v 1.15 2000/07/20 11:17:31 kevin Exp $
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.
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.
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 ******************************************************************************/
53 FILTER_ABS_BANDLIMIT, // filter times |x|
61 FILTER_METHOD_INVALID,
62 FILTER_METHOD_CONVOLUTION,
63 FILTER_METHOD_FOURIER,
64 FILTER_METHOD_FOURIER_TABLE,
79 static const char FILTER_ABS_BANDLIMIT_STR[];
80 static const char FILTER_ABS_SINC_STR[];
81 static const char FILTER_ABS_COS_STR[];
82 static const char FILTER_ABS_HAMMING_STR[];
83 static const char FILTER_SHEPP_STR[];
84 static const char FILTER_BANDLIMIT_STR[];
85 static const char FILTER_SINC_STR[];
86 static const char FILTER_COS_STR[];
87 static const char FILTER_HAMMING_STR[];
88 static const char FILTER_TRIANGLE_STR[];
90 static const char FILTER_ABS_BANDLIMIT_TITLE_STR[];
91 static const char FILTER_ABS_SINC_TITLE_STR[];
92 static const char FILTER_ABS_COS_TITLE_STR[];
93 static const char FILTER_ABS_HAMMING_TITLE_STR[];
94 static const char FILTER_SHEPP_TITLE_STR[];
95 static const char FILTER_BANDLIMIT_TITLE_STR[];
96 static const char FILTER_SINC_TITLE_STR[];
97 static const char FILTER_COS_TITLE_STR[];
98 static const char FILTER_HAMMING_TITLE_STR[];
99 static const char FILTER_TRIANGLE_TITLE_STR[];
102 static const char FILTER_METHOD_CONVOLUTION_STR[];
103 static const char FILTER_METHOD_FOURIER_STR[];
104 static const char FILTER_METHOD_FOURIER_TABLE_STR[];
105 static const char FILTER_METHOD_FFT_STR[];
107 static const char FILTER_METHOD_FFTW_STR[];
108 static const char FILTER_METHOD_RFFTW_STR[];
111 static const char FILTER_METHOD_CONVOLUTION_TITLE_STR[];
112 static const char FILTER_METHOD_FOURIER_TITLE_STR[];
113 static const char FILTER_METHOD_FOURIER_TABLE_TITLE_STR[];
114 static const char FILTER_METHOD_FFT_TITLE_STR[];
116 static const char FILTER_METHOD_FFTW_TITLESTR[];
117 static const char FILTER_METHOD_RFFTW_TITLE_STR[];
121 static const char DOMAIN_FREQUENCY_STR[];
122 static const char DOMAIN_SPATIAL_STR[];
124 static const char DOMAIN_FREQUENCY_TITLE_STR[];
125 static const char DOMAIN_SPATIAL_TITLE_STR[];
128 SignalFilter (const char* filterName, const char* filterMethodName,double bw, double signalIncrement, int n, double param, const char* domainName, const int zeropad = 0, const int preinterpolationFactor = 1);
130 SignalFilter (const FilterID filt_type, FilterMethodID filterMethodID, double bw, double signalIncrement, int n, double param, const DomainID domain, const int zeropad = 0, const int preinterpolationFactor = 1);
132 SignalFilter (const char* filterName, const char* domainName, double bw, double param);
134 ~SignalFilter (void);
136 double* getFilter (void) const
137 { return m_vecFilter; }
139 int getNFilterPoints (void) const
140 { return m_nFilterPoints; }
142 double convolve (const double f[], const double dx, const int n, const int np) const;
144 double convolve (const float f[], const double dx, const int n, const int np) const;
146 void filterSignal (const double input[], double output[]) const;
147 void filterSignal (const float input[], double output[]) const;
149 static void finiteFourierTransform (const double input[], complex<double> output[], const int n, const int direction);
150 static void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int n, const int direction);
151 static void finiteFourierTransform (const complex<double> input[], double output[], const int n, const int direction);
153 void finiteFourierTransform (const double input[], complex<double> output[], const int direction) const;
154 void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int direction) const;
155 void finiteFourierTransform (const complex<double> input[], double output[], const int direction) const;
157 void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
159 bool fail(void) const {return m_fail;}
160 const string& failMessage(void) const {return m_failMessage;}
162 const string& nameFilter(void) const { return m_nameFilter;}
163 const string& nameDomain(void) const { return m_nameDomain;}
164 const FilterID idFilter(void) const { return m_idFilter;}
165 const DomainID idDomain(void) const { return m_idDomain;}
166 const double getFilterMin(void) const {return m_filterMin;}
167 const double getFilterMax(void) const {return m_filterMax;}
168 const double getFilterIncrement(void) const {return m_filterInc;}
170 double response (double x);
172 static double spatialResponse (FilterID fType, double bw, double x, double param);
174 static double frequencyResponse (FilterID fType, double bw, double u, double param);
176 static double spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
178 static double spatialResponseCalc (FilterID fType, double bw, double x, double param, int nIntegral);
180 static void setNumIntegral(int nIntegral) {N_INTEGRAL = nIntegral;}
191 double* m_vecFourierCosTable;
192 double* m_vecFourierSinTable;
193 complex<double>* m_complexVecFilter;
195 fftw_real* m_vecRealFftInput, *m_vecRealFftSignal;
196 rfftw_plan m_realPlanForward, m_realPlanBackward;
197 fftw_complex* m_vecComplexFftInput, *m_vecComplexFftSignal;
198 fftw_plan m_complexPlanForward, m_complexPlanBackward;
202 string m_failMessage;
204 string m_nameFilterMethod;
207 FilterMethodID m_idFilterMethod;
209 double m_filterParam;
213 int m_preinterpolationFactor;
215 static int N_INTEGRAL;
217 static const bool haveAnalyticSpatial (const FilterID filterID);
218 static const FilterID convertFilterNameToID (const char* filterName);
219 static const char* convertFilterIDToName (const FilterID filterID);
220 static const FilterMethodID convertFilterMethodNameToID (const char* filterMethodName);
221 static const char* convertFilterMethodIDToName (const FilterMethodID filterMethodID);
222 static const DomainID convertDomainNameToID (const char* domainName);
223 static const char* convertDomainIDToName (const DomainID domainID);
225 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 preInterpScale);
227 double spatialResponseCalc (double x, double param) const;
229 double spatialResponseAnalytic (double x, double param) const;
231 double frequencyResponse (double u, double param) const;
233 static double sinc (double x, double mult)
234 { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
236 static double integral_abscos (double u, double w);