diff options
Diffstat (limited to 'gr-analog')
29 files changed, 54 insertions, 33 deletions
diff --git a/gr-analog/doc/analog.dox b/gr-analog/doc/analog.dox index d3af364f74..437eb05c74 100644 --- a/gr-analog/doc/analog.dox +++ b/gr-analog/doc/analog.dox @@ -11,7 +11,7 @@ imported as: \endcode See the Doxygen documentation for details about the blocks available -in this package. The relevant blocks are listed in the \ref analog group. +in this package. A quick listing of the details can be found in Python after importing by using: diff --git a/gr-analog/grc/analog_block_tree.xml b/gr-analog/grc/analog_block_tree.xml index 0a01d38cd8..cf58b3696b 100644 --- a/gr-analog/grc/analog_block_tree.xml +++ b/gr-analog/grc/analog_block_tree.xml @@ -29,10 +29,9 @@ <cat> <name></name> <!-- Blank for Root Name --> <cat> - <name>Level Controls</name> + <name>Level Controllers</name> <block>analog_agc_xx</block> <block>analog_agc2_xx</block> - <block>analog_dpll_bb</block> <block>analog_feedforward_agc_cc</block> <block>analog_ctcss_squelch_ff</block> <block>analog_pwr_squelch_xx</block> @@ -57,7 +56,7 @@ <block>analog_fm_preemph</block> </cat> <cat> - <name>Sources</name> + <name>Waveform Generators</name> <block>analog_sig_source_x</block> <block>analog_const_source_x</block> <block>analog_noise_source_x</block> @@ -69,7 +68,11 @@ <block>analog_pll_refout_cc</block> </cat> <cat> - <name>Probes</name> + <name>Peak Detectors</name> + <block>analog_dpll_bb</block> + </cat> + <cat> + <name>Measurement Tools</name> <block>analog_probe_avg_mag_sqrd_x</block> </cat> </cat> diff --git a/gr-analog/include/analog/agc.h b/gr-analog/include/analog/agc.h index c304ba8f3e..9418c1f8fb 100644 --- a/gr-analog/include/analog/agc.h +++ b/gr-analog/include/analog/agc.h @@ -34,6 +34,7 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class for complex signals. * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc_cc diff --git a/gr-analog/include/analog/agc2.h b/gr-analog/include/analog/agc2.h index 8d1958d293..89d4b43694 100644 --- a/gr-analog/include/analog/agc2.h +++ b/gr-analog/include/analog/agc2.h @@ -34,6 +34,7 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc2_cc diff --git a/gr-analog/include/analog/agc2_cc.h b/gr-analog/include/analog/agc2_cc.h index 7f3a7c24bd..82efe914d8 100644 --- a/gr-analog/include/analog/agc2_cc.h +++ b/gr-analog/include/analog/agc2_cc.h @@ -33,8 +33,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class with * attack and decay rates. - * \ingroup level_blk + * \ingroup level_controllers_blk * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc2_cc : virtual public gr_sync_block diff --git a/gr-analog/include/analog/agc2_ff.h b/gr-analog/include/analog/agc2_ff.h index 4bb7b0f646..dd2507e33d 100644 --- a/gr-analog/include/analog/agc2_ff.h +++ b/gr-analog/include/analog/agc2_ff.h @@ -33,8 +33,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class with * attack and decay rates. + * \ingroup level_controllers_blk * - * \ingroup level_blk + * \details * Power is approximated by absolute value */ class ANALOG_API agc2_ff : virtual public gr_sync_block diff --git a/gr-analog/include/analog/agc_cc.h b/gr-analog/include/analog/agc_cc.h index 0e59f8593b..0c2e831b0c 100644 --- a/gr-analog/include/analog/agc_cc.h +++ b/gr-analog/include/analog/agc_cc.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class - * \ingroup level_blk + * \ingroup level_controllers_blk * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc_cc : virtual public gr_sync_block diff --git a/gr-analog/include/analog/agc_ff.h b/gr-analog/include/analog/agc_ff.h index 6046d6f645..ffcafaa642 100644 --- a/gr-analog/include/analog/agc_ff.h +++ b/gr-analog/include/analog/agc_ff.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class - * \ingroup level_blk + * \ingroup level_controllers_blk * + * \details * Power is approximated by absolute value */ class ANALOG_API agc_ff : virtual public gr_sync_block diff --git a/gr-analog/include/analog/cpfsk_bc.h b/gr-analog/include/analog/cpfsk_bc.h index 904730e2b5..8150e0d08f 100644 --- a/gr-analog/include/analog/cpfsk_bc.h +++ b/gr-analog/include/analog/cpfsk_bc.h @@ -30,7 +30,7 @@ namespace gr { /*! * \brief Perform continuous phase 2-level frequency shift keying modulation * on an input stream of unpacked bits. - * \ingroup modulation_blk + * \ingroup modulators_blk */ class ANALOG_API cpfsk_bc : virtual public gr_sync_interpolator { diff --git a/gr-analog/include/analog/cpm.h b/gr-analog/include/analog/cpm.h index aff0dd19eb..43dd0b3729 100644 --- a/gr-analog/include/analog/cpm.h +++ b/gr-analog/include/analog/cpm.h @@ -46,8 +46,9 @@ namespace gr { /*! \brief Return the taps for an interpolating FIR filter * (gr::filter::interp_fir_filter_fff). * - * These taps represent the phase response \f$g(k)\f$ for use in - * a CPM modulator, see also gr_cpmmod_bc. + * \details + * These taps represent the phase response \f$g(k)\f$ for use in a CPM modulator, + * see also gr_cpmmod_bc. * * \param type The CPM type (Rectangular, Raised Cosine, * Spectral Raised Cosine, Tamed FM or Gaussian). diff --git a/gr-analog/include/analog/ctcss_squelch_ff.h b/gr-analog/include/analog/ctcss_squelch_ff.h index b63876714d..f8c551d291 100644 --- a/gr-analog/include/analog/ctcss_squelch_ff.h +++ b/gr-analog/include/analog/ctcss_squelch_ff.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief gate or zero output if CTCSS tone not present - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API ctcss_squelch_ff : public squelch_base_ff, virtual public gr_block diff --git a/gr-analog/include/analog/dpll_bb.h b/gr-analog/include/analog/dpll_bb.h index 78efb8fde9..f25e860b2c 100644 --- a/gr-analog/include/analog/dpll_bb.h +++ b/gr-analog/include/analog/dpll_bb.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Detect the peak of a signal - * \ingroup level_blk + * \ingroup peak_detectors_blk * + * \details * If a peak is detected, this block outputs a 1, * or it outputs 0's. */ diff --git a/gr-analog/include/analog/feedforward_agc_cc.h b/gr-analog/include/analog/feedforward_agc_cc.h index 743b9b3a3b..0a688ccdde 100644 --- a/gr-analog/include/analog/feedforward_agc_cc.h +++ b/gr-analog/include/analog/feedforward_agc_cc.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Non-causal AGC which computes required gain based on max * absolute value over nsamples - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API feedforward_agc_cc : virtual public gr_sync_block { diff --git a/gr-analog/include/analog/fmdet_cf.h b/gr-analog/include/analog/fmdet_cf.h index 6878775e6c..bd26e39226 100644 --- a/gr-analog/include/analog/fmdet_cf.h +++ b/gr-analog/include/analog/fmdet_cf.h @@ -32,6 +32,7 @@ namespace gr { /*! * \brief Implements an IQ slope detector * + * \details * input: stream of complex; output: stream of floats * * This implements a limiting slope detector. The limiter is in diff --git a/gr-analog/include/analog/frequency_modulator_fc.h b/gr-analog/include/analog/frequency_modulator_fc.h index 67be1ff00e..a0d4404729 100644 --- a/gr-analog/include/analog/frequency_modulator_fc.h +++ b/gr-analog/include/analog/frequency_modulator_fc.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Frequency modulator block - * \ingroup modulation_blk + * \ingroup modulators_blk * + * \details * float input; complex baseband output */ class ANALOG_API frequency_modulator_fc : virtual public gr_sync_block diff --git a/gr-analog/include/analog/noise_source_X.h.t b/gr-analog/include/analog/noise_source_X.h.t index 27d20cd072..1a9630dfdf 100644 --- a/gr-analog/include/analog/noise_source_X.h.t +++ b/gr-analog/include/analog/noise_source_X.h.t @@ -35,7 +35,7 @@ namespace gr { /*! * \brief Random number source - * \ingroup source_blk + * \ingroup waveform_generators_blk * * \details * Generate random values from different distributions. @@ -47,11 +47,11 @@ namespace gr { // gr::analog::@BASE_NAME@::sptr typedef boost::shared_ptr<@BASE_NAME@> sptr; - /*! \brief Make a noise source + /*! Build a noise source * \param type the random distribution to use (see analog/noise_type.h) * \param ampl a scaling factor for the output * \param seed seed for random generators. Note that for uniform and - * Gaussian distributions, this should be a negative number. + * Gaussian distributions, this should be a negative number. */ static sptr make(noise_type_t type, float ampl, long seed=0); diff --git a/gr-analog/include/analog/phase_modulator_fc.h b/gr-analog/include/analog/phase_modulator_fc.h index 409de7804b..2ec7c1a3c4 100644 --- a/gr-analog/include/analog/phase_modulator_fc.h +++ b/gr-analog/include/analog/phase_modulator_fc.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Phase modulator block - * \ingroup modulation_blk + * \ingroup modulators_blk * + * \details * output = complex(cos(in*sensitivity), sin(in*sensitivity)) * * Input stream 0: floats diff --git a/gr-analog/include/analog/pll_carriertracking_cc.h b/gr-analog/include/analog/pll_carriertracking_cc.h index 0812d650f0..520a2f57da 100644 --- a/gr-analog/include/analog/pll_carriertracking_cc.h +++ b/gr-analog/include/analog/pll_carriertracking_cc.h @@ -33,8 +33,9 @@ namespace gr { /*! * \brief Implements a PLL which locks to the input frequency and outputs the * input signal mixed with that carrier. - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input stream 0: complex * Output stream 0: complex * diff --git a/gr-analog/include/analog/pll_freqdet_cf.h b/gr-analog/include/analog/pll_freqdet_cf.h index 8ffbc5968e..b33fb909ba 100644 --- a/gr-analog/include/analog/pll_freqdet_cf.h +++ b/gr-analog/include/analog/pll_freqdet_cf.h @@ -33,8 +33,9 @@ namespace gr { /*! * \brief Implements a PLL which locks to the input frequency and outputs * an estimate of that frequency. Useful for FM Demod. - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input stream 0: complex * Output stream 0: float * diff --git a/gr-analog/include/analog/pll_refout_cc.h b/gr-analog/include/analog/pll_refout_cc.h index 1ba907262e..9c713749c7 100644 --- a/gr-analog/include/analog/pll_refout_cc.h +++ b/gr-analog/include/analog/pll_refout_cc.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Implements a PLL which locks to the input frequency and outputs a carrier - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input stream 0: complex * Output stream 0: complex * diff --git a/gr-analog/include/analog/probe_avg_mag_sqrd_c.h b/gr-analog/include/analog/probe_avg_mag_sqrd_c.h index 9e62732a36..2fed4fff0b 100644 --- a/gr-analog/include/analog/probe_avg_mag_sqrd_c.h +++ b/gr-analog/include/analog/probe_avg_mag_sqrd_c.h @@ -30,8 +30,9 @@ namespace gr { /*! * \brief compute avg magnitude squared. - * \ingroup sink_blk + * \ingroup measurement_tools_blk * + * \details * Input stream 0: complex * * Compute a running average of the magnitude squared of the the diff --git a/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h b/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h index b18916ae9b..303670adee 100644 --- a/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h +++ b/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief compute avg magnitude squared. - * \ingroup sink_blk + * \ingroup measurement_tools_blk * + * \details * Input stream 0: complex * Output stream 0: float * diff --git a/gr-analog/include/analog/probe_avg_mag_sqrd_f.h b/gr-analog/include/analog/probe_avg_mag_sqrd_f.h index fe9d27793f..2300f8bca1 100644 --- a/gr-analog/include/analog/probe_avg_mag_sqrd_f.h +++ b/gr-analog/include/analog/probe_avg_mag_sqrd_f.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief compute avg magnitude squared. - * \ingroup sink_blk + * \ingroup measurement_tools_blk * + * \details * input stream 0: float * * Compute a running average of the magnitude squared of the the diff --git a/gr-analog/include/analog/pwr_squelch_cc.h b/gr-analog/include/analog/pwr_squelch_cc.h index e3f6fb67fc..73b89f0db6 100644 --- a/gr-analog/include/analog/pwr_squelch_cc.h +++ b/gr-analog/include/analog/pwr_squelch_cc.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief gate or zero output when input power below threshold - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API pwr_squelch_cc : public squelch_base_cc, virtual public gr_block diff --git a/gr-analog/include/analog/pwr_squelch_ff.h b/gr-analog/include/analog/pwr_squelch_ff.h index f8f7b4aac2..5490827390 100644 --- a/gr-analog/include/analog/pwr_squelch_ff.h +++ b/gr-analog/include/analog/pwr_squelch_ff.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief gate or zero output when input power below threshold - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API pwr_squelch_ff : public squelch_base_ff, virtual public gr_block diff --git a/gr-analog/include/analog/quadrature_demod_cf.h b/gr-analog/include/analog/quadrature_demod_cf.h index fc29e494da..c7682649b8 100644 --- a/gr-analog/include/analog/quadrature_demod_cf.h +++ b/gr-analog/include/analog/quadrature_demod_cf.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief quadrature demodulator: complex in, float out - * \ingroup demodulation_blk + * \ingroup modulators_blk * + * \details * This can be used to demod FM, FSK, GMSK, etc. * The input is complex baseband. */ diff --git a/gr-analog/include/analog/rail_ff.h b/gr-analog/include/analog/rail_ff.h index 120ca2815b..2018017935 100644 --- a/gr-analog/include/analog/rail_ff.h +++ b/gr-analog/include/analog/rail_ff.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief clips input values to min, max - * \ingroup misc + * \ingroup level_controllers_blk */ class ANALOG_API rail_ff : virtual public gr_sync_block { diff --git a/gr-analog/include/analog/sig_source_X.h.t b/gr-analog/include/analog/sig_source_X.h.t index 2915c2abe9..752fe4cd29 100644 --- a/gr-analog/include/analog/sig_source_X.h.t +++ b/gr-analog/include/analog/sig_source_X.h.t @@ -34,7 +34,7 @@ namespace gr { /*! * \brief signal generator with @TYPE@ output. - * \ingroup source_blk + * \ingroup waveform_generators_blk */ class ANALOG_API @BASE_NAME@ : virtual public gr_sync_block { @@ -43,7 +43,7 @@ namespace gr { typedef boost::shared_ptr<@BASE_NAME@> sptr; /*! - * \brief Make a signal source block. + * Build a signal source block. * * \param sampling_freq Sampling rate of signal. * \param waveform wavetform type. diff --git a/gr-analog/include/analog/simple_squelch_cc.h b/gr-analog/include/analog/simple_squelch_cc.h index 1e12646e4e..bf949e3d2e 100644 --- a/gr-analog/include/analog/simple_squelch_cc.h +++ b/gr-analog/include/analog/simple_squelch_cc.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief simple squelch block based on average signal power and threshold in dB. - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API simple_squelch_cc : virtual public gr_sync_block { |