GNU Radio v3.6.2-149-ga6d285d9 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 #ifndef INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_C_H 00023 #define INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_C_H 00024 00025 #include <analog/api.h> 00026 #include <gr_sync_block.h> 00027 00028 namespace gr { 00029 namespace analog { 00030 00031 /*! 00032 * \brief compute avg magnitude squared. 00033 * \ingroup sink_blk 00034 * 00035 * Input stream 0: complex 00036 * 00037 * Compute a running average of the magnitude squared of the the 00038 * input. The level and indication as to whether the level exceeds 00039 * threshold can be retrieved with the level and unmuted 00040 * accessors. 00041 */ 00042 class ANALOG_API probe_avg_mag_sqrd_c : virtual public gr_sync_block 00043 { 00044 public: 00045 // gr::analog::probe_avg_mag_sqrd_c::sptr 00046 typedef boost::shared_ptr<probe_avg_mag_sqrd_c> sptr; 00047 00048 /*! 00049 * \brief Make a complex sink that computes avg magnitude squared. 00050 * 00051 * \param threshold_db Threshold for muting. 00052 * \param alpha Gain parameter for the running average filter. 00053 */ 00054 static sptr make(double threshold_db, double alpha = 0.0001); 00055 00056 virtual bool unmuted() const = 0; 00057 virtual double level() const = 0; 00058 virtual double threshold() const = 0; 00059 00060 virtual void set_alpha(double alpha) = 0; 00061 virtual void set_threshold(double decibels) = 0; 00062 }; 00063 00064 } /* namespace analog */ 00065 } /* namespace gr */ 00066 00067 #endif /* INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_C_H */