Mercurial > hg > qm-dsp

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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/Filter.h	Mon Oct 21 11:50:09 2013 +0100
+++ b/dsp/signalconditioning/Filter.h	Mon Oct 21 11:59:57 2013 +0100
@@ -20,12 +20,21 @@
 #define NULL 0
 #endif
 
+/**
+ * Filter specification. For a filter of order ord, the ACoeffs and
+ * BCoeffs arrays must point to ord+1 values each. ACoeffs provides
+ * the denominator and BCoeffs the numerator coefficients of the
+ * filter.
+ */
 struct FilterConfig{
     unsigned int ord;
     double* ACoeffs;
     double* BCoeffs;
 };
 
+/**
+ * Digital filter specified through FilterConfig structure.
+ */
 class Filter  
 {
 public:
@@ -35,7 +44,6 @@
     void reset();
 
     void process( double *src, double *dst, unsigned int length );
-	
 
 private:
     void initialise( FilterConfig Config );