r460: no message
[ctsim.git] / include / filter.h
index 5f5789b6fa2e857d1271ff042f4f8414b6adbb44..0a610d6843370cb28443c5b582188715da046c24 100644 (file)
@@ -7,9 +7,9 @@
 **     Date Started: June 2000
 **
 **  This is part of the CTSim program
-**  Copyright (C) 1983-2000 Kevin Rosenberg
+**  Copyright (c) 1983-2001 Kevin Rosenberg
 **
-**  $Id: filter.h,v 1.6 2000/07/02 18:21:39 kevin Exp $
+**  $Id: filter.h,v 1.24 2001/01/28 19:10:18 kevin Exp $
 **
 **  This program is free software; you can redistribute it and/or modify
 **  it under the terms of the GNU General Public License (version 2) as
 #ifndef FILTER_H
 #define FILTER_H
 
-class SignalFilter {
- public:
 
-    typedef enum {        
-       FILTER_INVALID,
-       FILTER_BANDLIMIT, 
-       FILTER_SINC,
-       FILTER_G_HAMMING,
-       FILTER_COSINE,
-       FILTER_TRIANGLE,
-       FILTER_ABS_BANDLIMIT,   // filter times |x| 
-       FILTER_ABS_SINC, 
-       FILTER_ABS_G_HAMMING,
-       FILTER_ABS_COSINE,
-       FILTER_SHEPP
-    } FilterID;
-
-    typedef enum {
-       FILTER_METHOD_INVALID,
-       FILTER_METHOD_CONVOLUTION,
-       FILTER_METHOD_FOURIER,
-       FILTER_METHOD_FFT,
-       FILTER_METHOD_FFT_ZEROPAD_2,
-       FILTER_METHOD_FFT_ZEROPAD_4,
-       FILTER_METHOD_FFT_ZEROPAD_6
-    } FilterMethodID;
-
-    typedef enum {
-       DOMAIN_INVALID,
-       DOMAIN_FREQUENCY,
-       DOMAIN_SPATIAL 
-    } DomainID;
-    
-    static const char FILTER_ABS_BANDLIMIT_STR[]= "abs_bandlimit";
-    static const char FILTER_ABS_SINC_STR[]=      "abs_sinc";
-    static const char FILTER_ABS_COS_STR[]=       "abs_cos";
-    static const char FILTER_ABS_HAMMING_STR[]=   "abs_hamming";
-    static const char FILTER_SHEPP_STR[]=         "shepp";
-    static const char FILTER_BANDLIMIT_STR[]=     "bandlimit";
-    static const char FILTER_SINC_STR[]=          "sinc";
-    static const char FILTER_COS_STR[]=           "cos";
-    static const char FILTER_HAMMING_STR[]=       "hamming";
-    static const char FILTER_TRIANGLE_STR[]=      "triangle";
-    
-    static const char FILTER_METHOD_CONVOLUTION_STR[]=  "convolution";
-    static const char FILTER_METHOD_FOURIER_STR[]=      "fourier";
-    static const char FILTER_METHOD_FFT_STR[]=          "fft";
-    static const char FILTER_METHOD_FFT_ZEROPAD_2_STR[]="fft_zeropad2";
-    static const char FILTER_METHOD_FFT_ZEROPAD_4_STR[]="fft_zeropad4";
-    static const char FILTER_METHOD_FFT_ZEROPAD_6_STR[]="fft_zeropad6";
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#ifdef HAVE_FFTW
+#include <fftw.h>
+#include <rfftw.h>
+#endif
 
-    static const char DOMAIN_FREQUENCY_STR[]=    "frequency";
-    static const char DOMAIN_SPATIAL_STR[]= "spatial";
 
+// CLASS IDENTIFICATION
+//    SignalFilter       A filter used to process signals
+//
+// CONTAINS
+//    signal vector
+//
+//    Can create either a time/spatial waveform or a frequency signal
+//    Waveforms can be created either by direct calculation or by inverse fourier transform
 
-    SignalFilter (const char* filterName, const char* filterMethodName,double bw, double signalLength, int n, double param, const char* domainName, const int numIntegral = 0);
+class SignalFilter {
+ public:
+    static const int FILTER_INVALID;
+    static const int FILTER_ABS_BANDLIMIT;     // filter times |x|
+    static const int FILTER_ABS_SINC;
+    static const int FILTER_ABS_G_HAMMING;
+    static const int FILTER_ABS_COSINE;
+    static const int FILTER_SHEPP;
+    static const int FILTER_BANDLIMIT;
+    static const int FILTER_SINC;
+    static const int FILTER_G_HAMMING;
+    static const int FILTER_COSINE;
+    static const int FILTER_TRIANGLE;
+
+    static const int DOMAIN_INVALID;
+    static const int DOMAIN_FREQUENCY;
+    static const int DOMAIN_SPATIAL;
+    
+    SignalFilter (const char* szFilterName, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const char* szDomainName);
 
-    SignalFilter (const FilterID filt_type, FilterMethodID filterMethodID, double bw, double signalLength, int n, double param, const DomainID domain, const int numIntegral = 0);
+    SignalFilter (const int idFilter, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const int idDomain);
 
-    SignalFilter (const char* filterName, const char* domainName, double bw, double param, int numIntegral = 0);
+    SignalFilter (const char* szFilterName, const char* szDomainName, double dBandwidth, double dFilterParam);
 
     ~SignalFilter (void);
 
     double* getFilter (void) const
-      { return m_vecFilter; }
+      { return m_adFilter; }
 
-    int getNFilterPoints (void) const
-       { return m_nFilterPoints; }
+    bool fail(void) const      {return m_fail;}
+    const std::string& failMessage(void) const {return m_failMessage;}
 
-    double convolve (const double f[], const double dx, const int n, const int np) const;
+    const std::string& nameFilter(void) const  { return m_nameFilter;}
+    const std::string& nameDomain(void) const  { return m_nameDomain;}
+    const int idFilter(void) const     { return m_idFilter;}
+    const int idDomain(void) const     { return m_idDomain;}
 
-    double convolve (const float f[], const double dx, const int n, const int np) const;
+    int getNFilterPoints (void) const  { return m_nFilterPoints; }
+    const double getFilterMin(void) const {return m_dFilterMin;}
+    const double getFilterMax(void) const {return m_dFilterMax;}
+    const double getFilterIncrement(void) const {return m_dFilterInc;}
+    void copyFilterData(double *pdFilter, const int iStart, const int nPoints) const;
 
-    void filterSignal (const double input[], double output[], double dx, const int n) const;
-    void filterSignal (const float input[], double output[], double dx, const int n) const;
+    double response (double x);
 
-    static void finiteFourierTransform (const double input[], complex<double> output[], const int n, const int direction);
+    static double spatialResponse (int fType, double bw, double x, double param);
 
-    void finiteFourierTransform (const double input[], complex<double> output[], const int direction) const;
+    static double frequencyResponse (int fType, double bw, double u, double param);
 
-    bool fail(void) const      {return m_fail;}
-    const string& failMessage(void) const {return m_failMessage;}
+    static double spatialResponseAnalytic (int fType, double bw, double x, double param);
 
-    const string& nameFilter(void) const       { return m_nameFilter;}
-    const string& nameDomain(void) const       { return m_nameDomain;}
-    const FilterID idFilter(void) const        { return m_idFilter;}
-    const DomainID idDomain(void) const        { return m_idDomain;}
+    static double spatialResponseCalc (int fType, double bw, double x, double param, int nIntegral);
 
-    double response (double x);
+    static void setNumIntegral(int nIntegral) {N_INTEGRAL = nIntegral;}
 
-    static double spatialResponse (FilterID fType, double bw, double x, double param, int nIntegral = 0);
+  static const int getFilterCount() {return s_iFilterCount;}
+  static const char** getFilterNameArray() {return s_aszFilterName;}
+  static const char** getFilterTitleArray() {return s_aszFilterTitle;}
+  static int convertFilterNameToID (const char* const filterName);
+  static const char* convertFilterIDToName (const int idFilter);
+  static const char* convertFilterIDToTitle (const int idFilter);
 
-    static double frequencyResponse (FilterID fType, double bw, double u, double param);
+  static const int getDomainCount() {return s_iDomainCount;}
+  static const char** getDomainNameArray() {return s_aszDomainName;}
+  static const char** getDomainTitleArray() {return s_aszDomainTitle;}
+  static int convertDomainNameToID (const char* const domainName);
+  static const char* convertDomainIDToName (const int idDomain);
+  static const char* convertDomainIDToTitle (const int idDomain);
 
-    static double spatialResponseCalc (FilterID fType, double bw, double x, double param, int n);
+  static double sinc (double x)
+      { return (fabs(x) > F_EPSILON ? (sin (x) / x) : 1.0); }
 
-    static double spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
+  static double sinc (double x, double mult)
+      { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
 
  private:
-    double m_bw;
     int m_nFilterPoints;
-    int m_nSignalPoints;
-    double m_signalLength;
-    double m_xmin;
-    double m_xmax;
-    double* m_vecFilter;
-    double* m_vecFourierCosTable;
-    double* m_vecFourierSinTable;
+    double m_dBandwidth;
+    double m_dFilterParam;
+    double m_dFilterInc;
+    double m_dFilterMin;
+    double m_dFilterMax;
+    double* m_adFilter;
+
+    std::string m_nameFilter;
+    std::string m_nameDomain;
+    int m_idFilter;
+    int m_idDomain;
 
     bool m_fail;
-    string m_failMessage;
-    string m_nameFilter;
-    string m_nameFilterMethod;
-    string m_nameDomain;
-    FilterID m_idFilter;
-    FilterMethodID m_idFilterMethod;
-    DomainID m_idDomain;
-    double m_filterParam;
-    int m_numIntegral;
+    std::string m_failMessage;
 
-    static const FilterID convertFilterNameToID (const char* filterName);
-    static const char* convertFilterIDToName (const FilterID filterID);
-    static const FilterMethodID convertFilterMethodNameToID (const char* filterMethodName);
-    static const char* convertFilterMethodIDToName (const FilterMethodID filterMethodID);
-    static const DomainID convertDomainNameToID (const char* domainName);
-    static const char* convertDomainIDToName (const DomainID domainID);
+    static const char* s_aszFilterName[];
+    static const char* s_aszFilterTitle[];
+    static const int s_iFilterCount;
+    static const char* s_aszDomainName[];
+    static const char* s_aszDomainTitle[];
+    static const int s_iDomainCount;
+    static int N_INTEGRAL;
 
-    void init (const FilterID filt_type, const FilterMethodID filterMethod, double bw, double xmin, double xmax, int n, double param, const DomainID domain, const int numInt);
+    static const bool haveAnalyticSpatial (const int filterID);
 
-double spatialResponseCalc (double x, double param, int n) const;
+    void init (const int idFilter, double dFilterMin, double dFilterMax, int nFilterPoints, double dBandwidth, double dFilterParam, const int idDomain);
 
-    double spatialResponseAnalytic (double x, double param) const;
+    void createFrequencyFilter (double* x) const;
+    void createSpatialFilter (double* x) const;
 
-    double frequencyResponse (double u, double param) const;
-
-    static double sinc (double x, double mult)
-      { return (fabs(x) > F_EPSILON ? (sin (x * mult) / x) : 1.0); }
-
-    static double integral_abscos (double u, double w);
+    double spatialResponseCalc (double x) const;
+    double spatialResponseAnalytic (double x) const;
+    double frequencyResponse (double u) const;
 
+    static double integral_abscos (double u, double w)
+    { return (fabs (u) > F_EPSILON ? (cos (u * w) - 1) / (u * u) + w / u * sin (u * w) : (w * w / 2)); }
 };
 
-
 #endif