** 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.13 2000/07/11 10:32:44 kevin Exp $
+** $Id$
**
** 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
#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_FOURIER_TABLE,
- FILTER_METHOD_FFT,
-#if HAVE_FFTW
- FILTER_METHOD_FFTW,
- FILTER_METHOD_RFFTW,
+#ifdef HAVE_CONFIG_H
+#include "config.h"
#endif
- } 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_FOURIER_TABLE_STR[]="fourier_table";
- static const char FILTER_METHOD_FFT_STR[]= "fft";
-#if HAVE_FFTW
- static const char FILTER_METHOD_FFTW_STR[]= "fftw";
- static const char FILTER_METHOD_RFFTW_STR[]= "rfftw";
+#ifdef HAVE_FFTW
+#include <fftw3.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 signalIncrement, int n, double param, const char* domainName, const int zeropad = 0, const int preinterpolationFactor = 1);
+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_HANNING;
+ 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_HANNING;
+ 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 signalIncrement, int n, double param, const DomainID domain, 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; }
+ { 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[]) const;
- void filterSignal (const float input[], double output[]) const;
+ double response (double x);
- 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);
+ static double spatialResponse (int fType, double bw, double x, double param);
- 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;
+ static double frequencyResponse (int fType, double bw, double u, double param);
- void setTraceLevel (int traceLevel) {m_traceLevel = traceLevel; }
+ static double spatialResponseAnalytic (int fType, double bw, double x, double param);
- bool fail(void) const {return m_fail;}
- const string& failMessage(void) const {return m_failMessage;}
+ static double spatialResponseCalc (int fType, double bw, double x, double param, int nIntegral);
- 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;}
- const double getFilterMin(void) const {return m_filterMin;}
- const double getFilterMax(void) const {return m_filterMax;}
- const double getFilterIncrement(void) const {return m_filterInc;}
-
- double response (double x);
+ static void setNumIntegral(int nIntegral) {N_INTEGRAL = nIntegral;}
- static double spatialResponse (FilterID fType, double bw, double x, double param);
+ static const int getFilterCount() {return s_iFilterCount;}
+ static const int getReconstructFilterCount() { return s_iReconstructFilterCount; }
- static double frequencyResponse (FilterID fType, double bw, double u, double param);
+ static const char* const* getFilterNameArray() {return s_aszFilterName;}
+ static const char* const* 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 spatialResponseAnalytic (FilterID fType, double bw, double x, double param);
+ static const int getDomainCount() {return s_iDomainCount;}
+ static const char* const* getDomainNameArray() {return s_aszDomainName;}
+ static const char* const* 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 nIntegral);
+ static double sinc (double x)
+ { return (fabs(x) > F_EPSILON ? (sin (x) / x) : 1.0); }
- static void setNumIntegral(int nIntegral) {N_INTEGRAL = nIntegral;}
+ 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
+ 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_traceLevel;
- int m_zeropad;
- int m_nOutputPoints;
- int m_preinterpolationFactor;
-
+ std::string m_failMessage;
+
+ static const char* const s_aszFilterName[];
+ static const char* const s_aszFilterTitle[];
+ static const int s_iFilterCount;
+ static const int s_iReconstructFilterCount;
+ static const char* const s_aszDomainName[];
+ static const char* const s_aszDomainTitle[];
+ static const int s_iDomainCount;
static int N_INTEGRAL;
- static const bool haveAnalyticSpatial (const FilterID filterID);
- 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);
-
- void init (const FilterID filt_type, const FilterMethodID filterMethod, double bw, double signalIncrement, int n, double param, const DomainID domain, const int zeropad, const int preInterpScale);
+ static const bool haveAnalyticSpatial (const int filterID);
- 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