From 81a085c352109ec7af0939427b3fccc6d1ca96fa Mon Sep 17 00:00:00 2001
From: Dimitrios Symeonidis
Date: Thu, 11 Aug 2011 11:28:54 +0200
Subject: [PATCH 08/11] grc documentation for filters
---
grc/blocks/blks2_analysis_filterbank.xml | 5 +++++
grc/blocks/blks2_pfb_arb_resampler.xml | 3 +++
grc/blocks/blks2_pfb_channelizer.xml | 3 +++
grc/blocks/blks2_synthesis_filterbank.xml | 5 +++++
grc/blocks/gr_channel_model.xml | 3 +++
grc/blocks/gr_cma_equalizer_cc.xml | 3 +++
grc/blocks/gr_dc_blocker.xml | 5 +++++
grc/blocks/gr_fft_filter_xxx.xml | 3 +++
grc/blocks/gr_filter_delay_fc.xml | 5 +++++
grc/blocks/gr_fir_filter_xxx.xml | 3 +++
grc/blocks/gr_fractional_interpolator_xx.xml | 3 +++
grc/blocks/gr_freq_xlating_fir_filter_xxx.xml | 3 +++
grc/blocks/gr_goertzel_fc.xml | 3 +++
grc/blocks/gr_hilbert_fc.xml | 6 ++++++
grc/blocks/gr_iir_filter_ffd.xml | 5 +++++
grc/blocks/gr_interp_fir_filter_xxx.xml | 3 +++
grc/blocks/gr_keep_one_in_n.xml | 3 +++
grc/blocks/gr_moving_average_xx.xml | 6 ++++++
grc/blocks/gr_pfb_synthesis_filterbank.xml | 3 +++
grc/blocks/gr_rational_resampler_base_xxx.xml | 3 +++
grc/blocks/gr_single_pole_iir_filter_xx.xml | 5 +++++
21 files changed, 81 insertions(+), 0 deletions(-)
diff --git a/grc/blocks/blks2_analysis_filterbank.xml b/grc/blocks/blks2_analysis_filterbank.xml
index 93cfa30..6ffef1a 100644
--- a/grc/blocks/blks2_analysis_filterbank.xml
+++ b/grc/blocks/blks2_analysis_filterbank.xml
@@ -29,4 +29,9 @@
complex
$mpoints
+
+Uniformly modulated polyphase DFT filter bank: analysis
+
+See http://cnx.org/content/m10424/latest
+
diff --git a/grc/blocks/blks2_pfb_arb_resampler.xml b/grc/blocks/blks2_pfb_arb_resampler.xml
index b4e0979..853664e 100644
--- a/grc/blocks/blks2_pfb_arb_resampler.xml
+++ b/grc/blocks/blks2_pfb_arb_resampler.xml
@@ -42,4 +42,7 @@
out
complex
+
+Polyphase filterbank arbitrary resampler
+
diff --git a/grc/blocks/blks2_pfb_channelizer.xml b/grc/blocks/blks2_pfb_channelizer.xml
index aee9dd5..1b46ef3 100644
--- a/grc/blocks/blks2_pfb_channelizer.xml
+++ b/grc/blocks/blks2_pfb_channelizer.xml
@@ -50,4 +50,7 @@
complex
$nchans
+
+Polyphase filterbank channelizer
+
diff --git a/grc/blocks/blks2_synthesis_filterbank.xml b/grc/blocks/blks2_synthesis_filterbank.xml
index 5979ed3..c97474c 100644
--- a/grc/blocks/blks2_synthesis_filterbank.xml
+++ b/grc/blocks/blks2_synthesis_filterbank.xml
@@ -29,4 +29,9 @@
out
complex
+
+Uniformly modulated polyphase DFT filter bank: synthesis
+
+See http://cnx.org/content/m10424/latest
+
diff --git a/grc/blocks/gr_channel_model.xml b/grc/blocks/gr_channel_model.xml
index e23062d..44ba090 100644
--- a/grc/blocks/gr_channel_model.xml
+++ b/grc/blocks/gr_channel_model.xml
@@ -58,4 +58,7 @@
out
complex
+
+Channel simulator
+
diff --git a/grc/blocks/gr_cma_equalizer_cc.xml b/grc/blocks/gr_cma_equalizer_cc.xml
index 142fb6d..8247e3c 100644
--- a/grc/blocks/gr_cma_equalizer_cc.xml
+++ b/grc/blocks/gr_cma_equalizer_cc.xml
@@ -33,4 +33,7 @@
out
complex
+
+Implements constant modulus adaptive filter on complex stream
+
diff --git a/grc/blocks/gr_dc_blocker.xml b/grc/blocks/gr_dc_blocker.xml
index e5aeeb0..a3e8d2a 100644
--- a/grc/blocks/gr_dc_blocker.xml
+++ b/grc/blocks/gr_dc_blocker.xml
@@ -48,4 +48,9 @@
out
$type.output
+
+a computationally efficient controllabel DC blocker
+
+This block implements a computationally efficient DC blocker that produces a tigher notch filter around DC for a smaller group delay than an equivalent FIR filter or using a single pole IIR filter (though the IIR filter is computationally cheaper).
+
diff --git a/grc/blocks/gr_fft_filter_xxx.xml b/grc/blocks/gr_fft_filter_xxx.xml
index c163309..e6dfef4 100644
--- a/grc/blocks/gr_fft_filter_xxx.xml
+++ b/grc/blocks/gr_fft_filter_xxx.xml
@@ -49,4 +49,7 @@
out
$type.output
+
+Fast FFT filter
+
diff --git a/grc/blocks/gr_filter_delay_fc.xml b/grc/blocks/gr_filter_delay_fc.xml
index 30d65bf..2ccc1b2 100644
--- a/grc/blocks/gr_filter_delay_fc.xml
+++ b/grc/blocks/gr_filter_delay_fc.xml
@@ -28,4 +28,9 @@
out
complex
+
+Filter-Delay Combination Block.
+
+The block takes one or two float stream and outputs a complex stream. If only one float stream is input, the real output is a delayed version of this input and the imaginary output is the filtered output. If two floats are connected to the input, then the real output is the delayed version of the first input, and the imaginary output is the filtered output. The delay in the real path accounts for the group delay introduced by the filter in the imaginary path. The filter taps needs to be calculated before initializing this block.
+
diff --git a/grc/blocks/gr_fir_filter_xxx.xml b/grc/blocks/gr_fir_filter_xxx.xml
index c4de8f5..bd56530 100644
--- a/grc/blocks/gr_fir_filter_xxx.xml
+++ b/grc/blocks/gr_fir_filter_xxx.xml
@@ -77,4 +77,7 @@
out
$type.output
+
+FIR filter
+
diff --git a/grc/blocks/gr_fractional_interpolator_xx.xml b/grc/blocks/gr_fractional_interpolator_xx.xml
index 8d65ff8..05fd140 100644
--- a/grc/blocks/gr_fractional_interpolator_xx.xml
+++ b/grc/blocks/gr_fractional_interpolator_xx.xml
@@ -43,4 +43,7 @@
out
$type
+
+Interpolating mmse filter
+
diff --git a/grc/blocks/gr_freq_xlating_fir_filter_xxx.xml b/grc/blocks/gr_freq_xlating_fir_filter_xxx.xml
index e3ee669..4d8683f 100644
--- a/grc/blocks/gr_freq_xlating_fir_filter_xxx.xml
+++ b/grc/blocks/gr_freq_xlating_fir_filter_xxx.xml
@@ -90,4 +90,7 @@
out
$type.output
+
+FIR filter combined with frequency translation
+
diff --git a/grc/blocks/gr_goertzel_fc.xml b/grc/blocks/gr_goertzel_fc.xml
index f27d958..ce07145 100644
--- a/grc/blocks/gr_goertzel_fc.xml
+++ b/grc/blocks/gr_goertzel_fc.xml
@@ -34,4 +34,7 @@
out
complex
+
+Goertzel single-bin DFT calculation
+
diff --git a/grc/blocks/gr_hilbert_fc.xml b/grc/blocks/gr_hilbert_fc.xml
index 165e8da..264ab48 100644
--- a/grc/blocks/gr_hilbert_fc.xml
+++ b/grc/blocks/gr_hilbert_fc.xml
@@ -23,4 +23,10 @@
out
complex
+
+Hilbert transformer.
+
+real output is input appropriately delayed.
+imaginary output is hilbert filtered (90 degree phase shift) version of input.
+
diff --git a/grc/blocks/gr_iir_filter_ffd.xml b/grc/blocks/gr_iir_filter_ffd.xml
index 9799150..0ec203c 100644
--- a/grc/blocks/gr_iir_filter_ffd.xml
+++ b/grc/blocks/gr_iir_filter_ffd.xml
@@ -28,4 +28,9 @@
out
float
+
+IIR filter
+
+This filter uses the Direct Form I implementation, where fftaps contains the feed-forward taps, and fbtaps the feedback ones.
+
diff --git a/grc/blocks/gr_interp_fir_filter_xxx.xml b/grc/blocks/gr_interp_fir_filter_xxx.xml
index 55375ae..8738503 100644
--- a/grc/blocks/gr_interp_fir_filter_xxx.xml
+++ b/grc/blocks/gr_interp_fir_filter_xxx.xml
@@ -77,4 +77,7 @@
out
$type.output
+
+Interpolating FIR filter
+
diff --git a/grc/blocks/gr_keep_one_in_n.xml b/grc/blocks/gr_keep_one_in_n.xml
index 21595b7..162eeb6 100644
--- a/grc/blocks/gr_keep_one_in_n.xml
+++ b/grc/blocks/gr_keep_one_in_n.xml
@@ -64,4 +64,7 @@
$type
$vlen
+
+decimate a stream, keeping one item out of every n
+
diff --git a/grc/blocks/gr_moving_average_xx.xml b/grc/blocks/gr_moving_average_xx.xml
index b70943c..af98315 100644
--- a/grc/blocks/gr_moving_average_xx.xml
+++ b/grc/blocks/gr_moving_average_xx.xml
@@ -65,4 +65,10 @@
out
$type
+
+output is the moving sum of the last N samples, scaled by the scale factor
+
+max_iter limits how long we go without flushing the accumulator
+This is necessary to avoid numerical instability for float and complex.
+
diff --git a/grc/blocks/gr_pfb_synthesis_filterbank.xml b/grc/blocks/gr_pfb_synthesis_filterbank.xml
index a8b944c..34ba048 100644
--- a/grc/blocks/gr_pfb_synthesis_filterbank.xml
+++ b/grc/blocks/gr_pfb_synthesis_filterbank.xml
@@ -40,4 +40,7 @@
out
complex
+
+Polyphase synthesis filterbank
+
diff --git a/grc/blocks/gr_rational_resampler_base_xxx.xml b/grc/blocks/gr_rational_resampler_base_xxx.xml
index 4b77201..41005e1 100644
--- a/grc/blocks/gr_rational_resampler_base_xxx.xml
+++ b/grc/blocks/gr_rational_resampler_base_xxx.xml
@@ -83,4 +83,7 @@
out
$type.output
+
+Rational Resampling Polyphase FIR filter
+
diff --git a/grc/blocks/gr_single_pole_iir_filter_xx.xml b/grc/blocks/gr_single_pole_iir_filter_xx.xml
index 50cf4a8..d5f55ba 100644
--- a/grc/blocks/gr_single_pole_iir_filter_xx.xml
+++ b/grc/blocks/gr_single_pole_iir_filter_xx.xml
@@ -48,4 +48,9 @@
$type
$vlen
+
+IIR filter
+
+This filter uses the Direct Form I implementation, where fftaps contains the feed-forward taps, and fbtaps the feedback ones.
+
--
1.7.4.1