git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2005,2006 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22 #ifndef INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H
  23 #define INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H
  24
  25 #include <gr_sync_block.h>
  26 #include <gr_single_pole_iir.h>
  27
  28 class gr_probe_avg_mag_sqrd_cf;
  29 typedef boost::shared_ptr<gr_probe_avg_mag_sqrd_cf> gr_probe_avg_mag_sqrd_cf_sptr;
  30
  31 gr_probe_avg_mag_sqrd_cf_sptr
  32 gr_make_probe_avg_mag_sqrd_cf (double threshold_db, double alpha = 0.0001);
  33
  34 /*!
  35  * \brief compute avg magnitude squared.
  36  * \ingroup sink_blk
  37  *
  38  * input: gr_complex
  39  * output: gr_float
  40  *
  41  * Compute a running average of the magnitude squared of the the input.
  42  * The level and indication as to whether the level exceeds threshold
  43  * can be retrieved with the level and unmuted accessors.
  44  *
  45  */
  46 class gr_probe_avg_mag_sqrd_cf : public gr_sync_block
  47 {
  48   double                                        d_threshold;
  49   gr_single_pole_iir<double,double,double>      d_iir;
  50   bool                                          d_unmuted;
  51   double                                        d_level;
  52
  53   friend gr_probe_avg_mag_sqrd_cf_sptr
  54   gr_make_probe_avg_mag_sqrd_cf (double threshold_db, double alpha);
  55
  56   gr_probe_avg_mag_sqrd_cf (double threshold_db, double alpha);
  57
  58 public:
  59   ~gr_probe_avg_mag_sqrd_cf ();
  60
  61   int work (int noutput_items,
  62             gr_vector_const_void_star &input_items,
  63             gr_vector_void_star &output_items);
  64
  65   // ACCESSORS
  66   bool unmuted () const { return d_unmuted; }
  67   double level () const { return d_level; }
  68
  69   double threshold() const;
  70
  71   // SETTERS
  72   void set_alpha (double alpha);
  73   void set_threshold (double decibels);
  74 };
  75
  76 #endif /* INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H */