GNU Radio 3.6.4.1 C++ API
gr_probe_avg_mag_sqrd_cf.h
Go to the documentation of this file.
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_core_api.h>
26 #include <gr_sync_block.h>
27 #include <gr_single_pole_iir.h>
28 
31 
33 gr_make_probe_avg_mag_sqrd_cf (double threshold_db, double alpha = 0.0001);
34 
35 /*!
36  * \brief compute avg magnitude squared.
37  * \ingroup sink_blk
38  *
39  * input: gr_complex
40  * output: gr_float
41  *
42  * Compute a running average of the magnitude squared of the the input.
43  * The level and indication as to whether the level exceeds threshold
44  * can be retrieved with the level and unmuted accessors.
45  *
46  */
48 {
49  double d_threshold;
51  bool d_unmuted;
52  double d_level;
53 
55  gr_make_probe_avg_mag_sqrd_cf (double threshold_db, double alpha);
56 
57  gr_probe_avg_mag_sqrd_cf (double threshold_db, double alpha);
58 
59 public:
61 
62  int work (int noutput_items,
63  gr_vector_const_void_star &input_items,
64  gr_vector_void_star &output_items);
65 
66  // ACCESSORS
67  bool unmuted () const { return d_unmuted; }
68  double level () const { return d_level; }
69 
70  double threshold() const;
71 
72  // SETTERS
73  void set_alpha (double alpha);
74  void set_threshold (double decibels);
75 };
76 
77 #endif /* INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H */