Mercurial > hg > qm-dsp

diff dsp/rateconversion/Decimator.h @ 150:23558405a7d1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Integrate resampler and tests into build system etc
author Chris Cannam
date Mon, 21 Oct 2013 09:40:22 +0100
parents e5907ae6de17
children 4f092806782b
line wrap: on
line diff
--- a/dsp/rateconversion/Decimator.h	Fri Oct 18 14:57:48 2013 +0100
+++ b/dsp/rateconversion/Decimator.h	Mon Oct 21 09:40:22 2013 +0100
@@ -15,6 +15,12 @@
 #ifndef DECIMATOR_H
 #define DECIMATOR_H
 
+/**
+ * Decimator carries out a fast downsample by a power-of-two
+ * factor. Only a limited number of factors are supported, from two to
+ * whatever getHighestSupportedFactor() returns. This is much faster
+ * than Resampler but has a worse signal-noise ratio.
+ */
 class Decimator  
 {
 public: