GNU Radio 3.6.5 C++ API

probe_avg_mag_sqrd_f.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,2012 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H
00024 #define INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H
00025 
00026 #include <analog/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace analog {
00031     
00032     /*!
00033      * \brief compute avg magnitude squared.
00034      * \ingroup measurement_tools_blk
00035      *
00036      * \details
00037      * input stream 0: float
00038      *
00039      * Compute a running average of the magnitude squared of the the
00040      * input. The level and indication as to whether the level exceeds
00041      * threshold can be retrieved with the level and unmuted
00042      * accessors.
00043      */
00044     class ANALOG_API probe_avg_mag_sqrd_f : virtual public gr_sync_block
00045     {
00046     public:
00047       // gr::analog::probe_avg_mag_sqrd_f::sptr
00048       typedef boost::shared_ptr<probe_avg_mag_sqrd_f> sptr;
00049 
00050       /*!
00051        * \brief Make a float sink that computes avg magnitude squared.
00052        *
00053        * \param threshold_db Threshold for muting.
00054        * \param alpha Gain parameter for the running average filter.
00055        */
00056       static sptr make(double threshold_db, double alpha = 0.0001);
00057 
00058       virtual bool unmuted() const = 0;
00059       virtual double level() const = 0;
00060 
00061       virtual double threshold() const = 0;
00062 
00063       virtual void set_alpha (double alpha) = 0;
00064       virtual void set_threshold (double decibels) = 0;
00065     };
00066 
00067   } /* namespace analog */
00068 } /* namespace gr */
00069 
00070 #endif /* INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H */