<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: gr_probe_avg_mag_sqrd_cf.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('gr__probe__avg__mag__sqrd__cf_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_probe_avg_mag_sqrd_cf.h</h1> </div>
</div>
<div class="contents">
<a href="gr__probe__avg__mag__sqrd__cf_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2005,2006 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <gr_sync_block.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <gr_single_pole_iir.h></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classgr__probe__avg__mag__sqrd__cf.html" title="compute avg magnitude squared.input: gr_complex output: gr_float">gr_probe_avg_mag_sqrd_cf</a>;
<a name="l00029"></a>00029 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_probe_avg_mag_sqrd_cf></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_probe_avg_mag_sqrd_cf_sptr</a>;
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_probe_avg_mag_sqrd_cf_sptr</a>
<a name="l00032"></a>00032 <a class="code" href="gr__probe__avg__mag__sqrd__cf_8h.html#accf6c17ebe45d8e20d67cc37fd871d38">gr_make_probe_avg_mag_sqrd_cf</a> (<span class="keywordtype">double</span> threshold_db, <span class="keywordtype">double</span> alpha = 0.0001);
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/*!</span>
<a name="l00035"></a>00035 <span class="comment"> * \brief compute avg magnitude squared.</span>
<a name="l00036"></a>00036 <span class="comment"> * \ingroup sink_blk</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> * input: gr_complex</span>
<a name="l00039"></a>00039 <span class="comment"> * output: gr_float</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * Compute a running average of the magnitude squared of the the input.</span>
<a name="l00042"></a>00042 <span class="comment"> * The level and indication as to whether the level exceeds threshold</span>
<a name="l00043"></a>00043 <span class="comment"> * can be retrieved with the level and unmuted accessors.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a><a class="code" href="classgr__probe__avg__mag__sqrd__cf.html">00046</a> <span class="keyword">class </span><a class="code" href="classgr__probe__avg__mag__sqrd__cf.html" title="compute avg magnitude squared.input: gr_complex output: gr_float">gr_probe_avg_mag_sqrd_cf</a> : <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a>
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keywordtype">double</span> d_threshold;
<a name="l00049"></a>00049 <a class="code" href="classgr__single__pole__iir.html">gr_single_pole_iir<double,double,double></a> d_iir;
<a name="l00050"></a>00050 <span class="keywordtype">bool</span> d_unmuted;
<a name="l00051"></a>00051 <span class="keywordtype">double</span> d_level;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_probe_avg_mag_sqrd_cf_sptr</a>
<a name="l00054"></a>00054 <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#a3abea2e051e19bf2cb027f02db3269bb">gr_make_probe_avg_mag_sqrd_cf</a> (<span class="keywordtype">double</span> threshold_db, <span class="keywordtype">double</span> alpha);
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html" title="compute avg magnitude squared.input: gr_complex output: gr_float">gr_probe_avg_mag_sqrd_cf</a> (<span class="keywordtype">double</span> threshold_db, <span class="keywordtype">double</span> alpha);
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keyword">public</span>:
<a name="l00059"></a>00059 <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#af550354cc81b47a1225d83761b472edd">~gr_probe_avg_mag_sqrd_cf</a> ();
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keywordtype">int</span> <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#ae64e63b6c5132a8904cf10688c9e29f8" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a> (<span class="keywordtype">int</span> noutput_items,
<a name="l00062"></a>00062 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00063"></a>00063 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items);
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">// ACCESSORS</span>
<a name="l00066"></a><a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#ab8d2699993b2de1ae399532f636ccbaa">00066</a> <span class="keywordtype">bool</span> <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#ab8d2699993b2de1ae399532f636ccbaa">unmuted</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_unmuted; }
<a name="l00067"></a><a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#a087d2145efcd7355675dee8d442d40f6">00067</a> <span class="keywordtype">double</span> <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#a087d2145efcd7355675dee8d442d40f6">level</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_level; }
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordtype">double</span> <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#a5bb55d9824f880ee3d2a818c47059310">threshold</a>() <span class="keyword">const</span>;
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">// SETTERS</span>
<a name="l00072"></a>00072 <span class="keywordtype">void</span> <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#a44965bec0c94c7397495453482c188a5">set_alpha</a> (<span class="keywordtype">double</span> alpha);
<a name="l00073"></a>00073 <span class="keywordtype">void</span> <a class="code" href="classgr__probe__avg__mag__sqrd__cf.html#a373de466f29510c65d7a8d5ed9a0d0f6">set_threshold</a> (<span class="keywordtype">double</span> decibels);
<a name="l00074"></a>00074 };
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_PROBE_AVG_MAG_SQRD_CF_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__probe__avg__mag__sqrd__cf_8h.html">gr_probe_avg_mag_sqrd_cf.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
4978
