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.19 2000/08/09 22:52:52 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 ******************************************************************************/
46 static const int FILTER_INVALID;
47 static const int FILTER_ABS_BANDLIMIT; // filter times |x|
48 static const int FILTER_ABS_SINC;
49 static const int FILTER_ABS_G_HAMMING;
50 static const int FILTER_ABS_COSINE;
51 static const int FILTER_SHEPP;
52 static const int FILTER_BANDLIMIT;
53 static const int FILTER_SINC;
54 static const int FILTER_G_HAMMING;
55 static const int FILTER_COSINE;
56 static const int FILTER_TRIANGLE;
58 static const int FILTER_METHOD_INVALID;
59 static const int FILTER_METHOD_CONVOLUTION;
60 static const int FILTER_METHOD_FOURIER;
61 static const int FILTER_METHOD_FOURIER_TABLE;
62 static const int FILTER_METHOD_FFT;
64 static const int FILTER_METHOD_FFTW;
65 static const int FILTER_METHOD_RFFTW;
68 static const int DOMAIN_INVALID;
69 static const int DOMAIN_FREQUENCY;
70 static const int DOMAIN_SPATIAL;
72 static const int FREQUENCY_FILTER_INVALID;
73 static const int FREQUENCY_FILTER_DIRECT_FREQUENCY;
74 static const int FREQUENCY_FILTER_INVERSE_SPATIAL;
76 SignalFilter (const char* filterName, const char* filterMethodName,double bw, double signalIncrement, int n, double param, const char* domainName, const char* frequencyFilterName, const int zeropad = 0, const int preinterpolationFactor = 1);
78 SignalFilter (const int filt_type, int filterMethodID, double bw, double signalIncrement, int n, double param, const int domain, int filterFilterID, const int zeropad = 0, const int preinterpolationFactor = 1);
80 SignalFilter (const char* filterName, const char* domainName, double bw, double param);
84 double* getFilter (void) const
85 { return m_vecFilter; }
87 int getNFilterPoints (void) const
88 { return m_nFilterPoints; }
90 double convolve (const double f[], const double dx, const int n, const int np) const;
92 double convolve (const float f[], const double dx, const int n, const int np) const;
94 void filterSignal (const double input[], double output[]) const;
95 void filterSignal (const float input[], double output[]) const;
97 static void finiteFourierTransform (const double input[], complex<double> output[], const int n, const int direction);
98 static void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int n, const int direction);
99 static void finiteFourierTransform (const complex<double> input[], double output[], const int n, const int direction);
101 void finiteFourierTransform (const double input[], complex<double> output[], const int direction) const;
102 void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int direction) const;
103 void finiteFourierTransform (const complex<double> input[], double output[], const int direction) const;
105 void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
107 bool fail(void) const {return m_fail;}
108 const string& failMessage(void) const {return m_failMessage;}
110 const string& nameFilter(void) const { return m_nameFilter;}
111 const string& nameDomain(void) const { return m_nameDomain;}
112 const int idFilter(void) const { return m_idFilter;}
113 const int idDomain(void) const { return m_idDomain;}
114 const int idFrequencyFilter() const { return m_idFrequencyFilter;}
115 const double getFilterMin(void) const {return m_filterMin;}
116 const double getFilterMax(void) const {return m_filterMax;}
117 const double getFilterIncrement(void) const {return m_filterInc;}
119 double response (double x);
121 static double spatialResponse (int fType, double bw, double x, double param);
123 static double frequencyResponse (int fType, double bw, double u, double param);
125 static double spatialResponseAnalytic (int fType, double bw, double x, double param);
127 static double spatialResponseCalc (int fType, double bw, double x, double param, int nIntegral);
129 static void setNumIntegral(int nIntegral) {N_INTEGRAL = nIntegral;}
131 static const int getFilterCount() {return s_iFilterCount;}
132 static const char** getFilterNameArray() {return s_aszFilterName;}
133 static const char** getFilterTitleArray() {return s_aszFilterTitle;}
134 static int convertFilterNameToID (const char* const filterName);
135 static const char* convertFilterIDToName (const int idFilter);
136 static const char* convertFilterIDToTitle (const int idFilter);
138 static const int getFilterMethodCount() {return s_iFilterMethodCount;}
139 static const char** getFilterMethodNameArray() {return s_aszFilterMethodName;}
140 static const char** getFilterMethodTitleArray() {return s_aszFilterMethodTitle;}
141 static int convertFilterMethodNameToID (const char* const filterMethodName);
142 static const char* convertFilterMethodIDToName (const int idFilterMethod);
143 static const char* convertFilterMethodIDToTitle (const int idFilterMethod);
145 static const int getDomainCount() {return s_iDomainCount;}
146 static const char** getDomainNameArray() {return s_aszDomainName;}
147 static const char** getDomainTitleArray() {return s_aszDomainTitle;}
148 static int convertDomainNameToID (const char* const domainName);
149 static const char* convertDomainIDToName (const int idDomain);
150 static const char* convertDomainIDToTitle (const int idDomain);
152 static const int getFrequencyFilterCount() {return s_iFrequencyFilterCount;}
153 static const char** getFrequencyFilterNameArray() {return s_aszFrequencyFilterName;}
154 static const char** getFrequencyFilterTitleArray() {return s_aszFrequencyFilterTitle;}
155 static int convertFrequencyFilterNameToID (const char* const ffName);
156 static const char* convertFrequencyFilterIDToName (const int idFF);
157 static const char* convertFrequencyFilterIDToTitle (const int idFF);
168 double* m_vecFourierCosTable;
169 double* m_vecFourierSinTable;
170 complex<double>* m_complexVecFilter;
172 fftw_real* m_vecRealFftInput, *m_vecRealFftSignal;
173 rfftw_plan m_realPlanForward, m_realPlanBackward;
174 fftw_complex* m_vecComplexFftInput, *m_vecComplexFftSignal;
175 fftw_plan m_complexPlanForward, m_complexPlanBackward;
179 string m_failMessage;
181 string m_nameFilterMethod;
183 string m_nameFrequencyFilter;
185 int m_idFilterMethod;
186 int m_idFrequencyFilter;
188 double m_filterParam;
192 int m_preinterpolationFactor;
194 static const char* s_aszFilterName[];
195 static const char* s_aszFilterTitle[];
196 static const int s_iFilterCount;
197 static const char* s_aszFilterMethodName[];
198 static const char* s_aszFilterMethodTitle[];
199 static const int s_iFilterMethodCount;
200 static const char* s_aszDomainName[];
201 static const char* s_aszDomainTitle[];
202 static const int s_iDomainCount;
203 static const char* s_aszFrequencyFilterName[];
204 static const char* s_aszFrequencyFilterTitle[];
205 static const int s_iFrequencyFilterCount;
207 static int N_INTEGRAL;
209 static const bool haveAnalyticSpatial (const int filterID);
211 void init (const int filt_type, const int filterMethod, double bw, double signalIncrement, int n, double param, const int domain, const int frequencyFilter, const int zeropad, const int preInterpScale);
213 double spatialResponseCalc (double x, double param) const;
215 double spatialResponseAnalytic (double x, double param) const;
217 double frequencyResponse (double u, double param) const;
219 static double sinc (double x, double mult)
220 { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
222 static double integral_abscos (double u, double w);