Mercurial > hg > qm-dsp

diff dsp/rateconversion/Decimator.h @ 279:c8908cdc8c32

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* First cut at Matthew's downbeat estimator -- untested so far
author Chris Cannam <c.cannam@qmul.ac.uk>
date Tue, 10 Feb 2009 12:52:43 +0000
parents a98a8fe967c0
children 7fe29d8a7eaf
line wrap: on
line diff
--- a/dsp/rateconversion/Decimator.h	Mon Feb 09 16:05:32 2009 +0000
+++ b/dsp/rateconversion/Decimator.h	Tue Feb 10 12:52:43 2009 +0000
@@ -16,6 +16,16 @@
     void process( const double* src, double* dst );
     void doAntiAlias( const double* src, double* dst, unsigned int length );
 
+    /**
+     * Construct a Decimator to operate on input blocks of length
+     * inLength, with decimation factor decFactor.  inLength should be
+     * a multiple of decFactor.  Output blocks will be of length
+     * inLength / decFactor.
+     *
+     * decFactor must be a power of two.  The highest supported factor
+     * is obtained through getHighestSupportedFactor(); for higher
+     * factors, you will need to chain more than one decimator.
+     */
     Decimator( unsigned int inLength, unsigned int decFactor );
     virtual ~Decimator();