GNU Radio 3.6.5 C++ API

gr_probe_avg_mag_sqrd_cf.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,2006 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_GR_PROBE_AVG_MAG_SQRD_CF_H
00023 #define INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H
00024 
00025 #include <gr_core_api.h>
00026 #include <gr_sync_block.h>
00027 #include <gr_single_pole_iir.h>
00028 
00029 class gr_probe_avg_mag_sqrd_cf;
00030 typedef boost::shared_ptr<gr_probe_avg_mag_sqrd_cf> gr_probe_avg_mag_sqrd_cf_sptr;
00031 
00032 GR_CORE_API gr_probe_avg_mag_sqrd_cf_sptr
00033 gr_make_probe_avg_mag_sqrd_cf (double threshold_db, double alpha = 0.0001);
00034 
00035 /*!
00036  * \brief compute avg magnitude squared.
00037  *
00038  * input: gr_complex
00039  * output: gr_float
00040  *
00041  * Compute a running average of the magnitude squared of the the input.
00042  * The level and indication as to whether the level exceeds threshold
00043  * can be retrieved with the level and unmuted accessors.
00044  *
00045  */
00046 class GR_CORE_API gr_probe_avg_mag_sqrd_cf : public gr_sync_block
00047 {
00048   double                                        d_threshold;
00049   gr_single_pole_iir<double,double,double>      d_iir;
00050   bool                                          d_unmuted;
00051   double                                        d_level;
00052 
00053   friend GR_CORE_API gr_probe_avg_mag_sqrd_cf_sptr
00054   gr_make_probe_avg_mag_sqrd_cf (double threshold_db, double alpha);
00055 
00056   gr_probe_avg_mag_sqrd_cf (double threshold_db, double alpha);
00057 
00058 public:
00059   ~gr_probe_avg_mag_sqrd_cf ();
00060 
00061   int work (int noutput_items,
00062             gr_vector_const_void_star &input_items,
00063             gr_vector_void_star &output_items);
00064 
00065   // ACCESSORS
00066   bool unmuted () const { return d_unmuted; }
00067   double level () const { return d_level; }
00068 
00069   double threshold() const;
00070 
00071   // SETTERS
00072   void set_alpha (double alpha);
00073   void set_threshold (double decibels);
00074 };
00075 
00076 #endif /* INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H */