GNU Radio 3.6.4.1 C++ API
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 <
analog/api.h
>
27
#include <
gr_sync_block.h
>
28
29
namespace
gr {
30
namespace
analog {
31
32
/*!
33
* \brief compute avg magnitude squared.
34
* \ingroup sink_blk
35
*
36
* input stream 0: float
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
*/
43
class
ANALOG_API
probe_avg_mag_sqrd_f
:
virtual
public
gr_sync_block
44
{
45
public
:
46
// gr::analog::probe_avg_mag_sqrd_f::sptr
47
typedef
boost::shared_ptr<probe_avg_mag_sqrd_f>
sptr
;
48
49
/*!
50
* \brief Make a float 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
60
virtual
double
threshold()
const
= 0;
61
62
virtual
void
set_alpha (
double
alpha) = 0;
63
virtual
void
set_threshold (
double
decibels) = 0;
64
};
65
66
}
/* namespace analog */
67
}
/* namespace gr */
68
69
#endif
/* INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H */
gr-analog
include
analog
probe_avg_mag_sqrd_f.h
Generated on Thu Mar 21 2013 15:59:34 for GNU Radio 3.6.4.1 C++ API by
1.8.1.2