GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
probe_avg_mag_sqrd_c.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#ifndef INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_C_H
23#define INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_C_H
24
25#include <gnuradio/analog/api.h>
26#include <gnuradio/sync_block.h>
27
28namespace gr {
29namespace analog {
30
31/*!
32 * \brief compute avg magnitude squared.
33 * \ingroup measurement_tools_blk
34 *
35 * \details
36 * Input stream 0: complex
37 *
38 * Compute a running average of the magnitude squared of the the
39 * input. The level and indication as to whether the level exceeds
40 * threshold can be retrieved with the level and unmuted
41 * accessors.
42 */
44{
45public:
46 // gr::analog::probe_avg_mag_sqrd_c::sptr
47 typedef boost::shared_ptr<probe_avg_mag_sqrd_c> sptr;
48
49 /*!
50 * \brief Make a complex sink that computes avg magnitude squared.
51 *
52 * \param threshold_db Threshold for muting.
53 * \param alpha Gain parameter for the running average filter.
54 */
55 static sptr make(double threshold_db, double alpha = 0.0001);
56
57 virtual bool unmuted() const = 0;
58 virtual double level() const = 0;
59 virtual double threshold() const = 0;
60
61 virtual void set_alpha(double alpha) = 0;
62 virtual void set_threshold(double decibels) = 0;
63 virtual void reset() = 0;
64};
65
66} /* namespace analog */
67} /* namespace gr */
68
69#endif /* INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_C_H */
compute avg magnitude squared.
Definition probe_avg_mag_sqrd_c.h:44
virtual void set_threshold(double decibels)=0
virtual void set_alpha(double alpha)=0
virtual double level() const =0
virtual double threshold() const =0
boost::shared_ptr< probe_avg_mag_sqrd_c > sptr
Definition probe_avg_mag_sqrd_c.h:47
static sptr make(double threshold_db, double alpha=0.0001)
Make a complex sink that computes avg magnitude squared.
virtual bool unmuted() const =0
synchronous 1:1 input to output with history
Definition sync_block.h:38
#define ANALOG_API
Definition gr-analog/include/gnuradio/analog/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46