GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
probe_avg_mag_sqrd_f.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2012 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 
23 #ifndef INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H
24 #define INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H
25 
26 #include <gnuradio/analog/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace analog {
31 
32  /*!
33  * \brief compute avg magnitude squared.
34  * \ingroup measurement_tools_blk
35  *
36  * \details
37  * input stream 0: float
38  *
39  * Compute a running average of the magnitude squared of the the
40  * input. The level and indication as to whether the level exceeds
41  * threshold can be retrieved with the level and unmuted
42  * accessors.
43  */
45  {
46  public:
47  // gr::analog::probe_avg_mag_sqrd_f::sptr
48  typedef boost::shared_ptr<probe_avg_mag_sqrd_f> sptr;
49 
50  /*!
51  * \brief Make a float sink that computes avg magnitude squared.
52  *
53  * \param threshold_db Threshold for muting.
54  * \param alpha Gain parameter for the running average filter.
55  */
56  static sptr make(double threshold_db, double alpha = 0.0001);
57 
58  virtual bool unmuted() const = 0;
59  virtual double level() const = 0;
60 
61  virtual double threshold() const = 0;
62 
63  virtual void set_alpha (double alpha) = 0;
64  virtual void set_threshold (double decibels) = 0;
65  virtual void reset() = 0;
66  };
67 
68  } /* namespace analog */
69 } /* namespace gr */
70 
71 #endif /* INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H */
compute avg magnitude squared.
Definition: probe_avg_mag_sqrd_f.h:44
Include this header to use the message passing features.
Definition: logger.h:131
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
boost::shared_ptr< probe_avg_mag_sqrd_f > sptr
Definition: probe_avg_mag_sqrd_f.h:48
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30