GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
probe_avg_mag_sqrd_cf.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2006,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_CF_H
24 #define INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_CF_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: complex
38  * Output stream 0: float
39  *
40  * Compute a running average of the magnitude squared of the the
41  * input. The level and indication as to whether the level exceeds
42  * threshold can be retrieved with the level and unmuted
43  * accessors.
44  */
46  {
47  public:
48  // gr::analog::probe_avg_mag_sqrd_cf::sptr
49  typedef boost::shared_ptr<probe_avg_mag_sqrd_cf> sptr;
50 
51  /*!
52  * \brief Make a block that computes avg magnitude squared.
53  *
54  * \param threshold_db Threshold for muting.
55  * \param alpha Gain parameter for the running average filter.
56  */
57  static sptr make(double threshold_db, double alpha = 0.0001);
58 
59  virtual bool unmuted() const = 0;
60  virtual double level() const = 0;
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_CF_H */
compute avg magnitude squared.
Definition: probe_avg_mag_sqrd_cf.h:45
Include this header to use the message passing features.
Definition: logger.h:695
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_cf > sptr
Definition: probe_avg_mag_sqrd_cf.h:49
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30