1 /*****************************************************************************
5 ** Purpose: Routines for signal-procesing filters
6 ** Progammer: Kevin Rosenberg
7 ** Date Started: Aug 1984
9 ** This is part of the CTSim program
10 ** Copyright (c) 1983-2009 Kevin Rosenberg
12 ** This program is free software; you can redistribute it and/or modify
13 ** it under the terms of the GNU General Public License (version 2) as
14 ** published by the Free Software Foundation.
16 ** This program is distributed in the hope that it will be useful,
17 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ** GNU General Public License for more details.
21 ** You should have received a copy of the GNU General Public License
22 ** along with this program; if not, write to the Free Software
23 ** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 ******************************************************************************/
28 int SignalFilter::N_INTEGRAL=500; //static member
30 const int SignalFilter::FILTER_INVALID = -1 ;
31 const int SignalFilter::FILTER_ABS_BANDLIMIT = 0; // filter times |x|
32 const int SignalFilter::FILTER_ABS_G_HAMMING = 1;
33 const int SignalFilter::FILTER_ABS_HANNING = 2;
34 const int SignalFilter::FILTER_ABS_COSINE = 3;
35 const int SignalFilter::FILTER_ABS_SINC = 4;
36 const int SignalFilter::FILTER_SHEPP = 5;
37 const int SignalFilter::FILTER_BANDLIMIT = 6;
38 const int SignalFilter::FILTER_SINC = 7;
39 const int SignalFilter::FILTER_G_HAMMING = 8;
40 const int SignalFilter::FILTER_HANNING = 9;
41 const int SignalFilter::FILTER_COSINE = 10;
42 const int SignalFilter::FILTER_TRIANGLE = 11;
44 const int SignalFilter::s_iReconstructFilterCount = 4;
46 const char* const SignalFilter::s_aszFilterName[] = {
61 const char* const SignalFilter::s_aszFilterTitle[] = {
76 const int SignalFilter::s_iFilterCount = sizeof(s_aszFilterName) / sizeof(const char*);
79 const int SignalFilter::DOMAIN_INVALID = -1;
80 const int SignalFilter::DOMAIN_FREQUENCY = 0;
81 const int SignalFilter::DOMAIN_SPATIAL = 1;
83 const char* const SignalFilter::s_aszDomainName[] = {
88 const char* const SignalFilter::s_aszDomainTitle[] = {
93 const int SignalFilter::s_iDomainCount = sizeof(s_aszDomainName) / sizeof(const char*);
97 * SignalFilter::SignalFilter Construct a signal
100 * f = SignalFilter (filt_type, bw, filterMin, filterMax, n, param, domain, analytic)
101 * double f Generated filter vector
102 * int filt_type Type of filter wanted
103 * double bw Bandwidth of filter
104 * double filterMin, filterMax Filter limits
105 * int nFilterPoints Number of points in signal
106 * double param General input parameter to filters
107 * int domain FREQUENCY or SPATIAL domain wanted
110 SignalFilter::SignalFilter (const char* szFilterName, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const char* szDomainName)
111 : m_adFilter(NULL), m_fail(false)
113 m_idFilter = convertFilterNameToID (szFilterName);
114 if (m_idFilter == FILTER_INVALID) {
116 m_failMessage = "Invalid Filter name ";
117 m_failMessage += szFilterName;
120 m_idDomain = convertDomainNameToID (szDomainName);
121 if (m_idDomain == DOMAIN_INVALID) {
123 m_failMessage = "Invalid domain name ";
124 m_failMessage += szDomainName;
127 init (m_idFilter, dFilterMinimum, dFilterMaximum, nFilterPoints, dBandwidth, dFilterParam, m_idDomain);
130 SignalFilter::SignalFilter (const int idFilter, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const int idDomain)
131 : m_adFilter(NULL), m_fail(false)
133 init (idFilter, dFilterMinimum, dFilterMaximum, nFilterPoints, dBandwidth, dFilterParam, idDomain);
136 SignalFilter::SignalFilter (const char* szFilterName, const char* szDomainName, double dBandwidth, double dFilterParam)
137 : m_adFilter(NULL), m_fail(false)
140 m_dBandwidth = dBandwidth;
141 m_dFilterParam = dFilterParam;
142 m_idFilter = convertFilterNameToID (szFilterName);
143 if (m_idFilter == FILTER_INVALID) {
145 m_failMessage = "Invalid Filter name ";
146 m_failMessage += szFilterName;
149 m_idDomain = convertDomainNameToID (szDomainName);
150 if (m_idDomain == DOMAIN_INVALID) {
152 m_failMessage = "Invalid domain name ";
153 m_failMessage += szDomainName;
159 SignalFilter::init (const int idFilter, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const int idDomain)
161 m_idFilter = idFilter;
162 m_idDomain = idDomain;
163 if (m_idFilter == FILTER_INVALID || m_idDomain == DOMAIN_INVALID) {
167 if (nFilterPoints < 2) {
169 m_failMessage = "Number of filter points ";
170 m_failMessage += nFilterPoints;
171 m_failMessage = " less than 2";
175 m_nameFilter = convertFilterIDToName (m_idFilter);
176 m_nameDomain = convertDomainIDToName (m_idDomain);
177 m_nFilterPoints = nFilterPoints;
178 m_dFilterParam = dFilterParam;
179 m_dBandwidth = dBandwidth;
180 m_dFilterMin = dFilterMinimum;
181 m_dFilterMax = dFilterMaximum;
183 m_dFilterInc = (m_dFilterMax - m_dFilterMin) / (m_nFilterPoints - 1);
184 m_adFilter = new double [m_nFilterPoints];
186 if (m_idDomain == DOMAIN_FREQUENCY)
187 createFrequencyFilter (m_adFilter);
188 else if (m_idDomain == DOMAIN_SPATIAL)
189 createSpatialFilter (m_adFilter);
193 SignalFilter::~SignalFilter (void)
195 delete [] m_adFilter;
199 SignalFilter::createFrequencyFilter (double* adFilter) const
203 for (x = m_dFilterMin, i = 0; i < m_nFilterPoints; x += m_dFilterInc, i++)
204 adFilter[i] = frequencyResponse (x);
209 SignalFilter::createSpatialFilter (double* adFilter) const
211 if (m_idFilter == FILTER_SHEPP) {
212 double a = 2 * m_dBandwidth;
213 double c = - 4. / (a * a);
214 int center = (m_nFilterPoints - 1) / 2;
215 int sidelen = center;
216 m_adFilter[center] = 4. / (a * a);
218 for (int i = 1; i <= sidelen; i++ )
219 m_adFilter [center + i] = m_adFilter [center - i] = c / (4 * (i * i) - 1);
221 double x = m_dFilterMin;
222 for (int i = 0; i < m_nFilterPoints; i++, x += m_dFilterInc) {
223 if (haveAnalyticSpatial(m_idFilter))
224 m_adFilter[i] = spatialResponseAnalytic (x);
226 m_adFilter[i] = spatialResponseCalc (x);
232 SignalFilter::convertFilterNameToID (const char *filterName)
234 int filterID = FILTER_INVALID;
236 for (int i = 0; i < s_iFilterCount; i++)
237 if (strcasecmp (filterName, s_aszFilterName[i]) == 0) {
246 SignalFilter::convertFilterIDToName (const int filterID)
248 static const char *name = "";
250 if (filterID >= 0 && filterID < s_iFilterCount)
251 return (s_aszFilterName [filterID]);
257 SignalFilter::convertFilterIDToTitle (const int filterID)
259 static const char *title = "";
261 if (filterID >= 0 && filterID < s_iFilterCount)
262 return (s_aszFilterTitle [filterID]);
268 SignalFilter::convertDomainNameToID (const char* const domainName)
270 int dID = DOMAIN_INVALID;
272 for (int i = 0; i < s_iDomainCount; i++)
273 if (strcasecmp (domainName, s_aszDomainName[i]) == 0) {
282 SignalFilter::convertDomainIDToName (const int domainID)
284 static const char *name = "";
286 if (domainID >= 0 && domainID < s_iDomainCount)
287 return (s_aszDomainName [domainID]);
293 SignalFilter::convertDomainIDToTitle (const int domainID)
295 static const char *title = "";
297 if (domainID >= 0 && domainID < s_iDomainCount)
298 return (s_aszDomainTitle [domainID]);
305 SignalFilter::response (double x)
309 if (m_idDomain == DOMAIN_SPATIAL)
310 response = spatialResponse (m_idFilter, m_dBandwidth, x, m_dFilterParam);
311 else if (m_idDomain == DOMAIN_FREQUENCY)
312 response = frequencyResponse (m_idFilter, m_dBandwidth, x, m_dFilterParam);
319 SignalFilter::spatialResponse (int filterID, double bw, double x, double param)
321 if (haveAnalyticSpatial(filterID))
322 return spatialResponseAnalytic (filterID, bw, x, param);
324 return spatialResponseCalc (filterID, bw, x, param, N_INTEGRAL);
328 SignalFilter::copyFilterData (double* pdFilter, const int iStart, const int nPoints) const
330 int iFirst = clamp (iStart, 0, m_nFilterPoints - 1);
331 int iLast = clamp (iFirst + nPoints - 1, 0, m_nFilterPoints - 1);
333 for (int i = iFirst; i <= iLast; i++)
334 pdFilter[i - iFirst] = m_adFilter[i];
338 * filter_spatial_response_calc Calculate filter by discrete inverse fourier
339 * transform of filters's frequency
343 * y = filter_spatial_response_calc (filt_type, x, m_bw, param, n)
344 * double y Filter's response in spatial domain
345 * int filt_type Type of filter (definitions in ct.h)
346 * double x Spatial position to evaluate filter
347 * double m_bw Bandwidth of window
348 * double param General parameter for various filters
349 * int n Number of points to calculate integrations
353 SignalFilter::spatialResponseCalc (double x) const
355 return (spatialResponseCalc (m_idFilter, m_dBandwidth, x, m_dFilterParam, N_INTEGRAL));
359 SignalFilter::spatialResponseCalc (int filterID, double bw, double x, double param, int n)
363 if (filterID == FILTER_TRIANGLE) {
370 double zinc = (zmax - zmin) / (n - 1);
373 double* q = new double [n];
374 for (int i = 0; i < n; i++, z += zinc)
375 q[i] = frequencyResponse (filterID, bw, z, param) * cos (TWOPI * z * x);
377 double y = 2 * integrateSimpson (zmin, zmax, q, n);
385 * filter_frequency_response Return filter frequency response
388 * h = filter_frequency_response (filt_type, u, m_bw, param)
389 * double h Filters frequency response at u
390 * int filt_type Type of filter
391 * double u Frequency to evaluate filter at
392 * double m_bw Bandwidth of filter
393 * double param General input parameter for various filters
397 SignalFilter::frequencyResponse (double u) const
399 return frequencyResponse (m_idFilter, m_dBandwidth, u, m_dFilterParam);
404 SignalFilter::frequencyResponse (int filterID, double bw, double u, double param)
407 double au = fabs (u);
408 double abw = fabs (bw);
411 case FILTER_BANDLIMIT:
412 if (au >= (abw / 2) + F_EPSILON)
417 case FILTER_ABS_BANDLIMIT:
418 if (au >= (abw / 2) + F_EPSILON)
423 case FILTER_TRIANGLE:
424 if (au >= (abw / 2) + F_EPSILON)
430 if (au >= (abw / 2) + F_EPSILON)
433 q = cos(PI * au / abw);
435 case FILTER_ABS_COSINE:
436 if (au >= (abw / 2) + F_EPSILON)
439 q = au * cos(PI * au / abw);
442 q = abw * sinc (PI * abw * au, 1.);
444 case FILTER_ABS_SINC:
445 if (au >= (abw / 2) + F_EPSILON)
448 q = au * abw * sinc (PI * abw * au, 1.);
452 // follow through to G_HAMMING
453 case FILTER_G_HAMMING:
454 if (au >= (abw / 2) + F_EPSILON)
457 q = param + (1 - param) * cos (TWOPI * au / abw);
459 case FILTER_ABS_HANNING:
461 // follow through to ABS_G_HAMMING
462 case FILTER_ABS_G_HAMMING:
463 if (au >= (abw / 2) + F_EPSILON)
466 q = au * (param + (1 - param) * cos(TWOPI * au / abw));
470 sys_error (ERR_WARNING, "Frequency response for filter %d not implemented [filter_frequency_response]", filterID);
480 * filter_spatial_response_analytic Calculate filter by analytic inverse fourier
481 * transform of filters's frequency
485 * y = filter_spatial_response_analytic (filt_type, x, m_bw, param)
486 * double y Filter's response in spatial domain
487 * int filt_type Type of filter (definitions in ct.h)
488 * double x Spatial position to evaluate filter
489 * double m_bw Bandwidth of window
490 * double param General parameter for various filters
494 SignalFilter::spatialResponseAnalytic (double x) const
496 return spatialResponseAnalytic (m_idFilter, m_dBandwidth, x, m_dFilterParam);
500 SignalFilter::haveAnalyticSpatial (int filterID)
502 bool haveAnalytic = false;
505 case FILTER_BANDLIMIT:
506 case FILTER_TRIANGLE:
508 case FILTER_G_HAMMING:
510 case FILTER_ABS_BANDLIMIT:
511 case FILTER_ABS_COSINE:
512 case FILTER_ABS_G_HAMMING:
513 case FILTER_ABS_HANNING:
522 return (haveAnalytic);
526 SignalFilter::spatialResponseAnalytic (int filterID, double bw, double x, double param)
529 double u = TWOPI * x;
532 double b2 = TWOPI / bw;
535 case FILTER_BANDLIMIT:
536 q = bw * sinc(u * w, 1.0);
538 case FILTER_TRIANGLE:
539 temp = sinc (u * w, 1.0);
540 q = bw * temp * temp;
543 q = sinc(b-u,w) + sinc(b+u,w);
547 // follow through to G_HAMMING
548 case FILTER_G_HAMMING:
549 q = 2 * param * sin(u*w)/u + (1-param) * (sinc(b2-u, w) + sinc(b2+u, w));
551 case FILTER_ABS_BANDLIMIT:
552 q = 2 * integral_abscos (u, w);
554 case FILTER_ABS_COSINE:
555 q = integral_abscos(b-u,w) + integral_abscos(b+u,w);
557 case FILTER_ABS_HANNING:
559 // follow through to ABS_G_HAMMING
560 case FILTER_ABS_G_HAMMING:
561 q = 2 * param * integral_abscos(u,w) +
562 (1-param)*(integral_abscos(u-b2,w)+integral_abscos(u+b2,w));
566 q = 4. / (PI * bw * bw);
568 q = fabs ((2 / bw) * sin (u * w)) * sinc (u * w, 1.) * sinc (u * w, 1.);
571 if (fabs (x) < bw / 2)
576 case FILTER_ABS_SINC:
578 sys_error (ERR_WARNING, "Analytic filter type %d not implemented [filter_spatial_response_analytic]", filterID);
588 // Functions that are inline in filter.h
591 // sinc Return sin(x)/x function
592 // v = sinc (x, mult)
593 // Calculates sin(x * mult) / x;
595 // integral_abscos Returns integral of u*cos(u)
597 // q = integral_abscos (u, w)
598 // double q Integral value
599 // double u Integration variable
600 // double w Upper integration boundary
601 // Returns the value of integral of u*cos(u)*dV for V = 0 to w