GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
rms_ff.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2005,2013 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_BLOCKS_RMS_FF_H
24#define INCLUDED_BLOCKS_RMS_FF_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief RMS average power
34 * \ingroup math_operators_blk
35 */
36class BLOCKS_API rms_ff : virtual public sync_block
37{
38public:
39 // gr::blocks::rms_ff::sptr
40 typedef boost::shared_ptr<rms_ff> sptr;
41
42 /*!
43 * \brief Make an RMS calc. block.
44 * \param alpha gain for running average filter.
45 */
46 static sptr make(double alpha = 0.0001);
47
48 virtual void set_alpha(double alpha) = 0;
49};
50
51} /* namespace blocks */
52} /* namespace gr */
53
54#endif /* INCLUDED_BLOCKS_RMS_FF_H */
RMS average power.
Definition rms_ff.h:37
virtual void set_alpha(double alpha)=0
boost::shared_ptr< rms_ff > sptr
Definition rms_ff.h:40
static sptr make(double alpha=0.0001)
Make an RMS calc. block.
synchronous 1:1 input to output with history
Definition sync_block.h:38
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46