probe_avg_mag_sqrd_f.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2005,2012 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H
#define INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H

#include <gnuradio/analog/api.h>
#include <gnuradio/sync_block.h>

namespace gr {
  namespace analog {

    /*!
     * \brief compute avg magnitude squared.
     * \ingroup measurement_tools_blk
     *
     * \details
     * input stream 0: float
     *
     * Compute a running average of the magnitude squared of the the
     * input. The level and indication as to whether the level exceeds
     * threshold can be retrieved with the level and unmuted
     * accessors.
     */
    class ANALOG_API probe_avg_mag_sqrd_f : virtual public sync_block
    {
    public:
      // gr::analog::probe_avg_mag_sqrd_f::sptr
      typedef boost::shared_ptr<probe_avg_mag_sqrd_f> sptr;

      /*!
       * \brief Make a float sink that computes avg magnitude squared.
       *
       * \param threshold_db Threshold for muting.
       * \param alpha Gain parameter for the running average filter.
       */
      static sptr make(double threshold_db, double alpha = 0.0001);

      virtual bool unmuted() const = 0;
      virtual double level() const = 0;

      virtual double threshold() const = 0;

      virtual void set_alpha (double alpha) = 0;
      virtual void set_threshold (double decibels) = 0;
      virtual void reset() = 0;
    };

  } /* namespace analog */
} /* namespace gr */

#endif /* INCLUDED_ANALOG_PROBE_AVG_MAG_SQRD_F_H */