r460: no message
[ctsim.git] / include / filter.h
index ad2fc260b77f8dbdb46ff910f46a9d7be29492d1..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.19 2000/08/09 22:52:52 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
 #include <rfftw.h>
 #endif
 
-#include <complex>
 
+// 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
 
 class SignalFilter {
  public:
-
     static const int FILTER_INVALID;
     static const int FILTER_ABS_BANDLIMIT;     // filter times |x|
     static const int FILTER_ABS_SINC;
@@ -55,66 +61,34 @@ class SignalFilter {
     static const int FILTER_COSINE;
     static const int FILTER_TRIANGLE;
 
-    static const int FILTER_METHOD_INVALID;
-    static const int FILTER_METHOD_CONVOLUTION;
-    static const int FILTER_METHOD_FOURIER;
-    static const int FILTER_METHOD_FOURIER_TABLE;
-    static const int FILTER_METHOD_FFT;
-#if HAVE_FFTW
-    static const int FILTER_METHOD_FFTW;
-    static const int FILTER_METHOD_RFFTW;
-#endif
-
     static const int DOMAIN_INVALID;
     static const int DOMAIN_FREQUENCY;
     static const int DOMAIN_SPATIAL;
     
-    static const int FREQUENCY_FILTER_INVALID;
-    static const int FREQUENCY_FILTER_DIRECT_FREQUENCY;
-    static const int FREQUENCY_FILTER_INVERSE_SPATIAL;
-
-    SignalFilter (const char* filterName, const char* filterMethodName,double bw, double signalIncrement, int n, double param, const char* domainName, const char* frequencyFilterName, const int zeropad = 0, const int preinterpolationFactor = 1);
+    SignalFilter (const char* szFilterName, double dFilterMinimum, double dFilterMaximum, int nFilterPoints, double dBandwidth, double dFilterParam, const char* szDomainName);
 
-    SignalFilter (const int filt_type, int filterMethodID, double bw, double signalIncrement, int n, double param, const int domain, int filterFilterID, const int zeropad = 0, const int preinterpolationFactor = 1);
+    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);
+    SignalFilter (const char* szFilterName, const char* szDomainName, double dBandwidth, double dFilterParam);
 
     ~SignalFilter (void);
 
     double* getFilter (void) const
-      { return m_vecFilter; }
-
-    int getNFilterPoints (void) const
-       { return m_nFilterPoints; }
-
-    double convolve (const double f[], const double dx, const int n, const int np) const;
-
-    double convolve (const float f[], const double dx, const int n, const int np) const;
-
-    void filterSignal (const double input[], double output[]) const;
-    void filterSignal (const float input[], double output[]) const;
-
-    static void finiteFourierTransform (const double input[], complex<double> output[], const int n, const int direction);
-    static void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int n, const int direction);
-    static void finiteFourierTransform (const complex<double> input[], double output[], const int n, const int direction);
-
-    void finiteFourierTransform (const double input[], complex<double> output[], const int direction) const;
-    void finiteFourierTransform (const complex<double> input[], complex<double> output[], const int direction) const;
-    void finiteFourierTransform (const complex<double> input[], double output[], const int direction) const;
-
-    void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
+      { return m_adFilter; }
 
     bool fail(void) const      {return m_fail;}
-    const string& failMessage(void) const {return m_failMessage;}
+    const std::string& failMessage(void) const {return m_failMessage;}
 
-    const string& nameFilter(void) const       { return m_nameFilter;}
-    const string& nameDomain(void) const       { return m_nameDomain;}
+    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;}
-    const int idFrequencyFilter() const { return m_idFrequencyFilter;}
-    const double getFilterMin(void) const {return m_filterMin;}
-    const double getFilterMax(void) const {return m_filterMax;}
-    const double getFilterIncrement(void) const {return m_filterInc;}
+
+    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;
 
     double response (double x);
 
@@ -135,13 +109,6 @@ class SignalFilter {
   static const char* convertFilterIDToName (const int idFilter);
   static const char* convertFilterIDToTitle (const int idFilter);
 
-  static const int getFilterMethodCount() {return s_iFilterMethodCount;}
-  static const char** getFilterMethodNameArray() {return s_aszFilterMethodName;}
-  static const char** getFilterMethodTitleArray() {return s_aszFilterMethodTitle;}
-  static int convertFilterMethodNameToID (const char* const filterMethodName);
-  static const char* convertFilterMethodIDToName (const int idFilterMethod);
-  static const char* convertFilterMethodIDToTitle (const int idFilterMethod);
-
   static const int getDomainCount() {return s_iDomainCount;}
   static const char** getDomainNameArray() {return s_aszDomainName;}
   static const char** getDomainTitleArray() {return s_aszDomainTitle;}
@@ -149,78 +116,50 @@ class SignalFilter {
   static const char* convertDomainIDToName (const int idDomain);
   static const char* convertDomainIDToTitle (const int idDomain);
 
-  static const int getFrequencyFilterCount() {return s_iFrequencyFilterCount;}
-  static const char** getFrequencyFilterNameArray() {return s_aszFrequencyFilterName;}
-  static const char** getFrequencyFilterTitleArray() {return s_aszFrequencyFilterTitle;}
-  static int convertFrequencyFilterNameToID (const char* const ffName);
-  static const char* convertFrequencyFilterIDToName (const int idFF);
-  static const char* convertFrequencyFilterIDToTitle (const int idFF);
-  
+  static double sinc (double x)
+      { return (fabs(x) > F_EPSILON ? (sin (x) / x) : 1.0); }
+
+  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_signalInc;
-    double m_filterMin;
-    double m_filterMax;
-    double m_filterInc;
-    double* m_vecFilter;
-    double* m_vecFourierCosTable;
-    double* m_vecFourierSinTable;
-    complex<double>* m_complexVecFilter;
-#ifdef HAVE_FFTW
-    fftw_real* m_vecRealFftInput, *m_vecRealFftSignal;
-    rfftw_plan m_realPlanForward, m_realPlanBackward;
-    fftw_complex* m_vecComplexFftInput, *m_vecComplexFftSignal;
-    fftw_plan m_complexPlanForward, m_complexPlanBackward;
-#endif
-
-    bool m_fail;
-    string m_failMessage;
-    string m_nameFilter;
-    string m_nameFilterMethod;
-    string m_nameDomain;
-    string m_nameFrequencyFilter;
+    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_idFilterMethod;
-    int m_idFrequencyFilter;
     int m_idDomain;
-    double m_filterParam;
-    int m_traceLevel;
-    int m_zeropad;
-    int m_nOutputPoints;
-    int m_preinterpolationFactor;
+
+    bool m_fail;
+    std::string m_failMessage;
 
     static const char* s_aszFilterName[];
     static const char* s_aszFilterTitle[];
     static const int s_iFilterCount;
-    static const char* s_aszFilterMethodName[];
-    static const char* s_aszFilterMethodTitle[];
-    static const int s_iFilterMethodCount;
     static const char* s_aszDomainName[];
     static const char* s_aszDomainTitle[];
     static const int s_iDomainCount;
-    static const char* s_aszFrequencyFilterName[];
-    static const char* s_aszFrequencyFilterTitle[];
-    static const int s_iFrequencyFilterCount;
-
     static int N_INTEGRAL;
 
     static const bool haveAnalyticSpatial (const int filterID);
 
-    void init (const int filt_type, const int filterMethod, double bw, double signalIncrement, int n, double param, const int domain, const int frequencyFilter, const int zeropad, const int preInterpScale);
-
-    double spatialResponseCalc (double x, double param) 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;
-
-    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); }
+    void createFrequencyFilter (double* x) const;
+    void createSpatialFilter (double* x) const;
 
-    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