GNU Radio 3.7.1 C++ API
|
00001 /* -*- c++ -*- */ 00002 /* 00003 * Copyright 2005,2006,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_CF_H 00024 #define INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_CF_H 00025 00026 #include <gnuradio/analog/api.h> 00027 #include <gnuradio/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: complex 00038 * Output stream 0: float 00039 * 00040 * Compute a running average of the magnitude squared of the the 00041 * input. The level and indication as to whether the level exceeds 00042 * threshold can be retrieved with the level and unmuted 00043 * accessors. 00044 */ 00045 class ANALOG_API probe_avg_mag_sqrd_cf : virtual public sync_block 00046 { 00047 public: 00048 // gr::analog::probe_avg_mag_sqrd_cf::sptr 00049 typedef boost::shared_ptr<probe_avg_mag_sqrd_cf> sptr; 00050 00051 /*! 00052 * \brief Make a block that computes avg magnitude squared. 00053 * 00054 * \param threshold_db Threshold for muting. 00055 * \param alpha Gain parameter for the running average filter. 00056 */ 00057 static sptr make(double threshold_db, double alpha = 0.0001); 00058 00059 virtual bool unmuted() const = 0; 00060 virtual double level() const = 0; 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_CF_H */