GNU Radio 3.6.4.1 C++ API
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 <
analog/api.h
>
26
#include <
gr_sync_block.h
>
27
28
namespace
gr {
29
namespace
analog {
30
31
/*!
32
* \brief compute avg magnitude squared.
33
* \ingroup sink_blk
34
*
35
* Input stream 0: complex
36
*
37
* Compute a running average of the magnitude squared of the the
38
* input. The level and indication as to whether the level exceeds
39
* threshold can be retrieved with the level and unmuted
40
* accessors.
41
*/
42
class
ANALOG_API
probe_avg_mag_sqrd_c
:
virtual
public
gr_sync_block
43
{
44
public
:
45
// gr::analog::probe_avg_mag_sqrd_c::sptr
46
typedef
boost::shared_ptr<probe_avg_mag_sqrd_c>
sptr
;
47
48
/*!
49
* \brief Make a complex sink that computes avg magnitude squared.
50
*
51
* \param threshold_db Threshold for muting.
52
* \param alpha Gain parameter for the running average filter.
53
*/
54
static
sptr
make(
double
threshold_db,
double
alpha = 0.0001);
55
56
virtual
bool
unmuted()
const
= 0;
57
virtual
double
level()
const
= 0;
58
virtual
double
threshold()
const
= 0;
59
60
virtual
void
set_alpha(
double
alpha) = 0;
61
virtual
void
set_threshold(
double
decibels) = 0;
62
};
63
64
}
/* namespace analog */
65
}
/* namespace gr */
66
67
#endif
/* INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_C_H */
gr-analog
include
analog
probe_avg_mag_sqrd_c.h
Generated on Thu Mar 21 2013 15:59:34 for GNU Radio 3.6.4.1 C++ API by
1.8.1.2