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-2001 Kevin Rosenberg
12 ** $Id: filter.h,v 1.27 2001/02/22 18:22:40 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 ******************************************************************************/
41 // CLASS IDENTIFICATION
42 // SignalFilter A filter used to process signals
47 // Can create either a time/spatial waveform or a frequency signal
48 // Waveforms can be created either by direct calculation or by inverse fourier transform
52 static const int FILTER_INVALID;
53 static const int FILTER_ABS_BANDLIMIT; // filter times |x|
54 static const int FILTER_ABS_SINC;
55 static const int FILTER_ABS_G_HAMMING;
56 static const int FILTER_ABS_HANNING;
57 static const int FILTER_ABS_COSINE;
58 static const int FILTER_SHEPP;
59 static const int FILTER_BANDLIMIT;
60 static const int FILTER_SINC;
61 static const int FILTER_G_HAMMING;
62 static const int FILTER_HANNING;
63 static const int FILTER_COSINE;
64 static const int FILTER_TRIANGLE;
66 static const int DOMAIN_INVALID;
67 static const int DOMAIN_FREQUENCY;
68 static const int DOMAIN_SPATIAL;
70 SignalFilter (const char* szFilterName, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const char* szDomainName);
72 SignalFilter (const int idFilter, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const int idDomain);
74 SignalFilter (const char* szFilterName, const char* szDomainName, double dBandwidth, double dFilterParam);
78 double* getFilter (void) const
79 { return m_adFilter; }
81 bool fail(void) const {return m_fail;}
82 const std::string& failMessage(void) const {return m_failMessage;}
84 const std::string& nameFilter(void) const { return m_nameFilter;}
85 const std::string& nameDomain(void) const { return m_nameDomain;}
86 const int idFilter(void) const { return m_idFilter;}
87 const int idDomain(void) const { return m_idDomain;}
89 int getNFilterPoints (void) const { return m_nFilterPoints; }
90 const double getFilterMin(void) const {return m_dFilterMin;}
91 const double getFilterMax(void) const {return m_dFilterMax;}
92 const double getFilterIncrement(void) const {return m_dFilterInc;}
93 void copyFilterData(double *pdFilter, const int iStart, const int nPoints) const;
95 double response (double x);
97 static double spatialResponse (int fType, double bw, double x, double param);
99 static double frequencyResponse (int fType, double bw, double u, double param);
101 static double spatialResponseAnalytic (int fType, double bw, double x, double param);
103 static double spatialResponseCalc (int fType, double bw, double x, double param, int nIntegral);
105 static void setNumIntegral(int nIntegral) {N_INTEGRAL = nIntegral;}
107 static const int getFilterCount() {return s_iFilterCount;}
108 static const int getReconstructFilterCount() { return s_iReconstructFilterCount; }
110 static const char* const* getFilterNameArray() {return s_aszFilterName;}
111 static const char* const* getFilterTitleArray() {return s_aszFilterTitle;}
112 static int convertFilterNameToID (const char* const filterName);
113 static const char* convertFilterIDToName (const int idFilter);
114 static const char* convertFilterIDToTitle (const int idFilter);
116 static const int getDomainCount() {return s_iDomainCount;}
117 static const char* const* getDomainNameArray() {return s_aszDomainName;}
118 static const char* const* getDomainTitleArray() {return s_aszDomainTitle;}
119 static int convertDomainNameToID (const char* const domainName);
120 static const char* convertDomainIDToName (const int idDomain);
121 static const char* convertDomainIDToTitle (const int idDomain);
123 static double sinc (double x)
124 { return (fabs(x) > F_EPSILON ? (sin (x) / x) : 1.0); }
126 static double sinc (double x, double mult)
127 { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
132 double m_dFilterParam;
138 std::string m_nameFilter;
139 std::string m_nameDomain;
144 std::string m_failMessage;
146 static const char* const s_aszFilterName[];
147 static const char* const s_aszFilterTitle[];
148 static const int s_iFilterCount;
149 static const int s_iReconstructFilterCount;
150 static const char* const s_aszDomainName[];
151 static const char* const s_aszDomainTitle[];
152 static const int s_iDomainCount;
153 static int N_INTEGRAL;
155 static const bool haveAnalyticSpatial (const int filterID);
157 void init (const int idFilter, double dFilterMin, double dFilterMax, int nFilterPoints, double dBandwidth, double dFilterParam, const int idDomain);
159 void createFrequencyFilter (double* x) const;
160 void createSpatialFilter (double* x) const;
162 double spatialResponseCalc (double x) const;
163 double spatialResponseAnalytic (double x) const;
164 double frequencyResponse (double u) const;
166 static double integral_abscos (double u, double w)
167 { return (fabs (u) > F_EPSILON ? (cos (u * w) - 1) / (u * u) + w / u * sin (u * w) : (w * w / 2)); }