From d5e887e4b109440f1af434cc052ac373ec2d5da7 Mon Sep 17 00:00:00 2001 From: Dimitrios Symeonidis Date: Wed, 10 Aug 2011 17:32:04 +0200 Subject: [PATCH 7/7] grc documentation for level controls, plus small correction to gr_sample_and_hold_XX.h.t --- .../src/lib/gengen/gr_sample_and_hold_XX.h.t | 2 +- grc/blocks/gr_agc2_xx.xml | 3 +++ grc/blocks/gr_agc_xx.xml | 3 +++ grc/blocks/gr_dpll_bb.xml | 5 +++++ grc/blocks/gr_feedforward_agc_cc.xml | 3 +++ grc/blocks/gr_mute_xx.xml | 3 +++ grc/blocks/gr_peak_detector2_fb.xml | 5 +++++ grc/blocks/gr_peak_detector_xb.xml | 5 +++++ grc/blocks/gr_pwr_squelch_xx.xml | 3 +++ grc/blocks/gr_sample_and_hold_xx.xml | 5 +++++ grc/blocks/gr_simple_squelch_cc.xml | 3 +++ 11 files changed, 39 insertions(+), 1 deletions(-) diff --git a/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t b/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t index b964873..63aa67e 100644 --- a/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t @@ -37,7 +37,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; * \ingroup level_blk * * Samples the data stream (input stream 0) and holds the value - * if the control signal is 1 (intput stream 1). + * if the control signal is 1 (input stream 1). */ class @NAME@ : public gr_sync_block { diff --git a/grc/blocks/gr_agc2_xx.xml b/grc/blocks/gr_agc2_xx.xml index 55b20d4..b991b01 100644 --- a/grc/blocks/gr_agc2_xx.xml +++ b/grc/blocks/gr_agc2_xx.xml @@ -67,4 +67,7 @@ out $type + +high performance Automatic Gain Control class + diff --git a/grc/blocks/gr_agc_xx.xml b/grc/blocks/gr_agc_xx.xml index c87d239..55efbb3 100644 --- a/grc/blocks/gr_agc_xx.xml +++ b/grc/blocks/gr_agc_xx.xml @@ -56,4 +56,7 @@ out $type + +high performance Automatic Gain Control class + diff --git a/grc/blocks/gr_dpll_bb.xml b/grc/blocks/gr_dpll_bb.xml index 044d398..9080d80 100644 --- a/grc/blocks/gr_dpll_bb.xml +++ b/grc/blocks/gr_dpll_bb.xml @@ -27,4 +27,9 @@ out byte + +Detect the peak of a signal + +If a peak is detected, this block outputs a 1, or it outputs 0's. + diff --git a/grc/blocks/gr_feedforward_agc_cc.xml b/grc/blocks/gr_feedforward_agc_cc.xml index 24e8095..d7a6389 100644 --- a/grc/blocks/gr_feedforward_agc_cc.xml +++ b/grc/blocks/gr_feedforward_agc_cc.xml @@ -29,4 +29,7 @@ out complex + +Non-causal AGC which computes required gain based on max absolute value over nsamples + diff --git a/grc/blocks/gr_mute_xx.xml b/grc/blocks/gr_mute_xx.xml index a9a857c..9de4e90 100644 --- a/grc/blocks/gr_mute_xx.xml +++ b/grc/blocks/gr_mute_xx.xml @@ -58,4 +58,7 @@ out $type + +output = input or zero if muted. + diff --git a/grc/blocks/gr_peak_detector2_fb.xml b/grc/blocks/gr_peak_detector2_fb.xml index 128c624..3b0ae92 100644 --- a/grc/blocks/gr_peak_detector2_fb.xml +++ b/grc/blocks/gr_peak_detector2_fb.xml @@ -35,4 +35,9 @@ out byte + +Detect the peak of a signal + +If a peak is detected, this block outputs a 1, or it outputs 0's. A separate debug output may be connected, to view the internal EWMA described below. + diff --git a/grc/blocks/gr_peak_detector_xb.xml b/grc/blocks/gr_peak_detector_xb.xml index 394b069..3e419b4 100644 --- a/grc/blocks/gr_peak_detector_xb.xml +++ b/grc/blocks/gr_peak_detector_xb.xml @@ -61,4 +61,9 @@ out byte + +Detect the peak of a signal + +If a peak is detected, this block outputs a 1, or it outputs 0's. + diff --git a/grc/blocks/gr_pwr_squelch_xx.xml b/grc/blocks/gr_pwr_squelch_xx.xml index 08d6211..dfaf5a5 100644 --- a/grc/blocks/gr_pwr_squelch_xx.xml +++ b/grc/blocks/gr_pwr_squelch_xx.xml @@ -62,4 +62,7 @@ out $type + +gate or zero output when input power below threshold + diff --git a/grc/blocks/gr_sample_and_hold_xx.xml b/grc/blocks/gr_sample_and_hold_xx.xml index 2a036c3..fda13f7 100644 --- a/grc/blocks/gr_sample_and_hold_xx.xml +++ b/grc/blocks/gr_sample_and_hold_xx.xml @@ -46,4 +46,9 @@ out $type + +Sample and hold circuit + +Samples the data stream (input stream 0) and holds the value if the control signal is 1 (input stream 1). + diff --git a/grc/blocks/gr_simple_squelch_cc.xml b/grc/blocks/gr_simple_squelch_cc.xml index 5c0727f..4b39cb4 100644 --- a/grc/blocks/gr_simple_squelch_cc.xml +++ b/grc/blocks/gr_simple_squelch_cc.xml @@ -29,4 +29,7 @@ out complex + +simple squelch block based on average signal power and threshold in dB. + -- 1.7.4.1