r124: *** empty log message ***
[ctsim.git] / include / filter.h
1 #ifndef FILTER_H
2 #define FILTER_H
3
4
5 class SignalFilter {
6  public:
7
8     typedef enum {         
9         FILTER_INVALID,
10         FILTER_BANDLIMIT, 
11         FILTER_SINC,
12         FILTER_G_HAMMING,
13         FILTER_COSINE,
14         FILTER_TRIANGLE,
15         FILTER_ABS_BANDLIMIT,   // filter times |x| 
16         FILTER_ABS_SINC, 
17         FILTER_ABS_G_HAMMING,
18         FILTER_ABS_COSINE,
19         FILTER_SHEPP
20     } FilterID;
21
22     typedef enum {
23         FILTER_METHOD_INVALID,
24         FILTER_METHOD_CONVOLUTION,
25         FILTER_METHOD_FOURIER,
26         FILTER_METHOD_FFT,
27         FILTER_METHOD_FFT_ZEROPAD_2,
28         FILTER_METHOD_FFT_ZEROPAD_4,
29         FILTER_METHOD_FFT_ZEROPAD_6
30     } FilterMethodID;
31
32     typedef enum {
33         DOMAIN_INVALID,
34         DOMAIN_FREQ,
35         DOMAIN_SPATIAL 
36     } DomainID;
37     
38     static const char FILTER_ABS_BANDLIMIT_STR[]= "abs_bandlimit";
39     static const char FILTER_ABS_SINC_STR[]=      "abs_sinc";
40     static const char FILTER_ABS_COS_STR[]=       "abs_cos";
41     static const char FILTER_ABS_HAMMING_STR[]=   "abs_hamming";
42     static const char FILTER_SHEPP_STR[]=         "shepp";
43     static const char FILTER_BANDLIMIT_STR[]=     "bandlimit";
44     static const char FILTER_SINC_STR[]=          "sinc";
45     static const char FILTER_COS_STR[]=           "cos";
46     static const char FILTER_HAMMING_STR[]=       "hamming";
47     static const char FILTER_TRIANGLE_STR[]=      "triangle";
48     
49     static const char FILTER_METHOD_CONVOLUTION_STR[]=  "convolution";
50     static const char FILTER_METHOD_FOURIER_STR[]=      "fourier";
51     static const char FILTER_METHOD_FFT_STR[]=          "fft";
52     static const char FILTER_METHOD_FFT_ZEROPAD_2_STR[]="fft_zeropad2";
53     static const char FILTER_METHOD_FFT_ZEROPAD_4_STR[]="fft_zeropad4";
54     static const char FILTER_METHOD_FFT_ZEROPAD_6_STR[]="fft_zeropad6";
55
56     static const char DOMAIN_FREQ_STR[]=    "freq";
57     static const char DOMAIN_SPATIAL_STR[]= "spatial";
58
59
60     SignalFilter (const char* filterName, double bw, double xmin, double xmax, int n, double param, const char* domainName, const int numIntegral = 0);
61
62     SignalFilter (const FilterID filt_type, double bw, double xmin, double xmax, int n, double param, const DomainID domain, const int numIntegral = 0);
63
64     SignalFilter (const char* filterName, const char* domainName, double bw, double param, int numIntegral = 0);
65
66     ~SignalFilter (void);
67
68     double* getFilter (void) const
69       { return m_vecFilter; }
70
71     double convolve (const double f[], const double dx, const int n, const int np) const;
72
73     double convolve (const float f[], const double dx, const int n, const int np) const;
74
75     bool fail(void) const       {return m_fail;}
76     const string& failMessage(void) const {return m_failMessage;}
77
78     const string& nameFilter(void) const        { return m_nameFilter;}
79     const string& nameDomain(void) const        { return m_nameDomain;}
80     const FilterID idFilter(void) const         { return m_idFilter;}
81     const DomainID idDomain(void) const         { return m_idDomain;}
82
83     double response (double x);
84
85     static double spatialResponse (FilterID fType, double bw, double x, double param, int nIntegral = 0);
86
87     static double frequencyResponse (FilterID fType, double bw, double u, double param);
88
89     static double spatialResponseCalc (FilterID fType, double bw, double x, double param, int n);
90
91     static double spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
92
93  private:
94     double m_bw;
95     int m_nPoints;
96     double m_xmin;
97     double m_xmax;
98     double* m_vecFilter;
99     bool m_fail;
100     string m_failMessage;
101     string m_nameFilter;
102     string m_nameFilterMethod;
103     string m_nameDomain;
104     FilterID m_idFilter;
105     FilterMethodID m_idFilterMethod;
106     DomainID m_idDomain;
107     double m_filterParam;
108     int m_numIntegral;
109
110     static FilterID convertFilterNameToID (const char* filterName);
111     static const char* convertFilterIDToName (const FilterID filterID);
112     static const DomainID convertDomainNameToID (const char* domainName);
113     static const char* convertDomainIDToName (const DomainID domainID);
114
115     void init (const FilterID filt_type, double bw, double xmin, double xmax, int n, double param, const DomainID domain, const int numInt);
116
117 double spatialResponseCalc (double x, double param, int n) const;
118
119     double spatialResponseAnalytic (double x, double param) const;
120
121     double frequencyResponse (double u, double param) const;
122
123     static double sinc (double x, double mult)
124       { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
125
126     static double integral_abscos (double u, double w);
127
128 };
129
130
131 #endif