r120: *** 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         DOMAIN_INVALID,
24         DOMAIN_FREQ,
25         DOMAIN_SPATIAL 
26     } DomainID;
27     
28     static const char FILTER_ABS_BANDLIMIT_STR[]= "abs_bandlimit";
29     static const char FILTER_ABS_SINC_STR[]=      "abs_sinc";
30     static const char FILTER_ABS_COS_STR[]=       "abs_cos";
31     static const char FILTER_ABS_HAMMING_STR[]=   "abs_hamming";
32     static const char FILTER_SHEPP_STR[]=         "shepp";
33     static const char FILTER_BANDLIMIT_STR[]=     "bandlimit";
34     static const char FILTER_SINC_STR[]=          "sinc";
35     static const char FILTER_COS_STR[]=           "cos";
36     static const char FILTER_HAMMING_STR[]=       "hamming";
37     static const char FILTER_TRIANGLE_STR[]=      "triangle";
38     
39     static const char DOMAIN_FREQ_STR[]=    "freq";
40     static const char DOMAIN_SPATIAL_STR[]= "spatial";
41
42
43     SignalFilter (const char* filterName, double bw, double xmin, double xmax, int n, double param, const char* domainName, const int numIntegral = 0);
44
45     SignalFilter (const FilterID filt_type, double bw, double xmin, double xmax, int n, double param, const DomainID domain, const int numIntegral = 0);
46
47     SignalFilter (const char* filterName, const char* domainName, double bw, double param, int numIntegral = 0);
48
49     ~SignalFilter (void);
50
51     double* getFilter (void) const
52       { return m_vecFilter; }
53
54     double convolve (const double f[], const double dx, const int n, const int np) const;
55
56     double convolve (const float f[], const double dx, const int n, const int np) const;
57
58     bool fail(void) const       {return m_fail;}
59     const string& failMessage(void) const {return m_failMessage;}
60
61     const string& nameFilter(void) const        { return m_nameFilter;}
62     const string& nameDomain(void) const        { return m_nameDomain;}
63     const FilterID idFilter(void) const         { return m_idFilter;}
64     const DomainID idDomain(void) const         { return m_idDomain;}
65
66     double response (double x);
67
68     static double spatialResponse (FilterID fType, double bw, double x, double param, int nIntegral = 0);
69
70     static double frequencyResponse (FilterID fType, double bw, double u, double param);
71
72     static double spatialResponseCalc (FilterID fType, double bw, double x, double param, int n);
73
74     static double spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
75
76  private:
77     double m_bw;
78     int m_nPoints;
79     double m_xmin;
80     double m_xmax;
81     double* m_vecFilter;
82     bool m_fail;
83     string m_failMessage;
84     string m_nameFilter;
85     string m_nameDomain;
86     FilterID m_idFilter;
87     DomainID m_idDomain;
88     double m_filterParam;
89     int m_numIntegral;
90
91     static FilterID convertFilterNameToID (const char* filterName);
92     static const char* convertFilterIDToName (const FilterID filterID);
93     static const DomainID convertDomainNameToID (const char* domainName);
94     static const char* convertDomainIDToName (const DomainID domainID);
95
96     void init (const FilterID filt_type, double bw, double xmin, double xmax, int n, double param, const DomainID domain, const int numInt);
97
98 double spatialResponseCalc (double x, double param, int n) const;
99
100     double spatialResponseAnalytic (double x, double param) const;
101
102     double frequencyResponse (double u, double param) const;
103
104     static double sinc (double x, double mult)
105       { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
106
107     static double integral_abscos (double u, double w);
108
109 };
110
111
112 #endif