diff dsp/signalconditioning/FiltFilt.h @ 153:715f779d0b4f

Some docs; remove FiltFiltConfig as it's the same as FilterConfig
author Chris Cannam
date Mon, 21 Oct 2013 11:59:57 +0100
parents e5907ae6de17
children ca658c7215a9
line wrap: on
line diff
--- a/dsp/signalconditioning/FiltFilt.h	Mon Oct 21 11:50:09 2013 +0100
+++ b/dsp/signalconditioning/FiltFilt.h	Mon Oct 21 11:59:57 2013 +0100
@@ -18,23 +18,22 @@
 
 #include "Filter.h"
 
-struct FiltFiltConfig{
-    unsigned int ord;
-    double* ACoeffs;
-    double* BCoeffs;
-};
-
+/**
+ * Zero-phase digital filter, implemented by processing the data
+ * through a filter specified by the given FilterConfig structure (see
+ * Filter) and then processing it again in reverse.
+ */
 class FiltFilt  
 {
 public:
-    FiltFilt( FiltFiltConfig Config );
+    FiltFilt( FilterConfig Config );
     virtual ~FiltFilt();
 
     void reset();
     void process( double* src, double* dst, unsigned int length );
 
 private:
-    void initialise( FiltFiltConfig Config );
+    void initialise( FilterConfig Config );
     void deInitialise();
 
     unsigned int m_ord;