Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 4926

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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_peak_detector_ib.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__peak__detector__ib_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gr_peak_detector_ib.h</h1>  </div>
</div>
<div class="contents">
<a href="gr__peak__detector__ib_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 2007 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 
<a name="l00023"></a>00023 <span class="comment">// WARNING: this file is machine generated.  Edits will be over written</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef INCLUDED_GR_PEAK_DETECTOR_IB_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_PEAK_DETECTOR_IB_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;gr_sync_block.h&gt;</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classgr__peak__detector__ib.html" title="Detect the peak of a signalIf a peak is detected, this block outputs a 1, or it outputs 0&amp;#39;s...">gr_peak_detector_ib</a>;
<a name="l00031"></a>00031 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr&lt;gr_peak_detector_ib&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_peak_detector_ib_sptr</a>;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_peak_detector_ib_sptr</a> <a class="code" href="gr__peak__detector__ib_8h.html#aad12ae357255b67f836982e3ed3f0f5d">gr_make_peak_detector_ib</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a16cccafdfe9de755a679e851c41e2c7c" title="Get the threshold factor value for the rise time.">threshold_factor_rise</a> = 0.25,
<a name="l00034"></a>00034                                  <span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a8ed69f2548b5325a39b9b731c3b8bee2" title="Get the threshold factor value for the fall time.">threshold_factor_fall</a> = 0.40,
<a name="l00035"></a>00035                                  <span class="keywordtype">int</span> <a class="code" href="classgr__peak__detector__ib.html#ad13fcd580c7e78039110ddd225651066" title="Get the look-ahead factor value.">look_ahead</a> = 10,
<a name="l00036"></a>00036                                  <span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a47b1a8139b256051bd333ee42d1a445d" title="Get the alpha value of the running average.">alpha</a> = 0.001);
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/*!</span>
<a name="l00039"></a>00039 <span class="comment"> * \brief Detect the peak of a signal</span>
<a name="l00040"></a>00040 <span class="comment"> * \ingroup level_blk</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * If a peak is detected, this block outputs a 1, </span>
<a name="l00043"></a>00043 <span class="comment"> * or it outputs 0&#39;s.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * \param threshold_factor_rise The threshold factor determins when a peak</span>
<a name="l00046"></a>00046 <span class="comment"> *        has started. An average of the signal is calculated and when the </span>
<a name="l00047"></a>00047 <span class="comment"> *        value of the signal goes over threshold_factor_rise*average, we</span>
<a name="l00048"></a>00048 <span class="comment"> *        start looking for a peak.</span>
<a name="l00049"></a>00049 <span class="comment"> * \param threshold_factor_fall The threshold factor determins when a peak</span>
<a name="l00050"></a>00050 <span class="comment"> *        has ended. An average of the signal is calculated and when the </span>
<a name="l00051"></a>00051 <span class="comment"> *        value of the signal goes bellow threshold_factor_fall*average, we </span>
<a name="l00052"></a>00052 <span class="comment"> *        stop looking for a peak.</span>
<a name="l00053"></a>00053 <span class="comment"> * \param look_ahead The look-ahead value is used when the threshold is</span>
<a name="l00054"></a>00054 <span class="comment"> *        found to look if there another peak within this step range.</span>
<a name="l00055"></a>00055 <span class="comment"> *        If there is a larger value, we set that as the peak and look ahead</span>
<a name="l00056"></a>00056 <span class="comment"> *        again. This is continued until the highest point is found with</span>
<a name="l00057"></a>00057 <span class="comment"> *        This look-ahead range.</span>
<a name="l00058"></a>00058 <span class="comment"> * \param alpha The gain value of a moving average filter</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a><a class="code" href="classgr__peak__detector__ib.html">00060</a> <span class="keyword">class </span><a class="code" href="classgr__peak__detector__ib.html" title="Detect the peak of a signalIf a peak is detected, this block outputs a 1, or it outputs 0&amp;#39;s...">gr_peak_detector_ib</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="l00061"></a>00061 {
<a name="l00062"></a>00062   <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_peak_detector_ib_sptr</a> <a class="code" href="classgr__peak__detector__ib.html#a22adb1eb6863a3402df3c7250ff162c5">gr_make_peak_detector_ib</a> (<span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a16cccafdfe9de755a679e851c41e2c7c" title="Get the threshold factor value for the rise time.">threshold_factor_rise</a>,
<a name="l00063"></a>00063                                           <span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a8ed69f2548b5325a39b9b731c3b8bee2" title="Get the threshold factor value for the fall time.">threshold_factor_fall</a>,
<a name="l00064"></a>00064                                           <span class="keywordtype">int</span> <a class="code" href="classgr__peak__detector__ib.html#ad13fcd580c7e78039110ddd225651066" title="Get the look-ahead factor value.">look_ahead</a>, <span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a47b1a8139b256051bd333ee42d1a445d" title="Get the alpha value of the running average.">alpha</a>);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066   <a class="code" href="classgr__peak__detector__ib.html" title="Detect the peak of a signalIf a peak is detected, this block outputs a 1, or it outputs 0&amp;#39;s...">gr_peak_detector_ib</a> (<span class="keywordtype">float</span> threshold_factor_rise, 
<a name="l00067"></a>00067           <span class="keywordtype">float</span> threshold_factor_fall,
<a name="l00068"></a>00068           <span class="keywordtype">int</span> look_ahead, <span class="keywordtype">float</span> alpha);
<a name="l00069"></a>00069 
<a name="l00070"></a>00070  <span class="keyword">private</span>:
<a name="l00071"></a>00071   <span class="keywordtype">float</span> d_threshold_factor_rise;
<a name="l00072"></a>00072   <span class="keywordtype">float</span> d_threshold_factor_fall;
<a name="l00073"></a>00073   <span class="keywordtype">int</span> d_look_ahead;
<a name="l00074"></a>00074   <span class="keywordtype">float</span> d_avg_alpha;
<a name="l00075"></a>00075   <span class="keywordtype">float</span> d_avg;
<a name="l00076"></a>00076   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> d_found;
<a name="l00077"></a>00077 
<a name="l00078"></a>00078  <span class="keyword">public</span>:
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">  /*! \brief Set the threshold factor value for the rise time</span>
<a name="l00081"></a>00081 <span class="comment">   *  \param thr new threshold factor</span>
<a name="l00082"></a>00082 <span class="comment">   */</span>
<a name="l00083"></a><a class="code" href="classgr__peak__detector__ib.html#ac726371694c6d8b9e77fc3e92ecb3d77">00083</a>   <span class="keywordtype">void</span> <a class="code" href="classgr__peak__detector__ib.html#ac726371694c6d8b9e77fc3e92ecb3d77" title="Set the threshold factor value for the rise time.">set_threshold_factor_rise</a>(<span class="keywordtype">float</span> thr) { d_threshold_factor_rise = thr; }
<a name="l00084"></a>00084 <span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment">  /*! \brief Set the threshold factor value for the fall time</span>
<a name="l00086"></a>00086 <span class="comment">   *  \param thr new threshold factor</span>
<a name="l00087"></a>00087 <span class="comment">   */</span>
<a name="l00088"></a><a class="code" href="classgr__peak__detector__ib.html#a4ef44ee51e8a0ed9129b7870aabfd574">00088</a>   <span class="keywordtype">void</span> <a class="code" href="classgr__peak__detector__ib.html#a4ef44ee51e8a0ed9129b7870aabfd574" title="Set the threshold factor value for the fall time.">set_threshold_factor_fall</a>(<span class="keywordtype">float</span> thr) { d_threshold_factor_fall = thr; }
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">  /*! \brief Set the look-ahead factor</span>
<a name="l00091"></a>00091 <span class="comment">   *  \param look new look-ahead factor</span>
<a name="l00092"></a>00092 <span class="comment">   */</span>
<a name="l00093"></a><a class="code" href="classgr__peak__detector__ib.html#a80cf9f8c4d639e3ec9882e84a8ebda02">00093</a>   <span class="keywordtype">void</span> <a class="code" href="classgr__peak__detector__ib.html#a80cf9f8c4d639e3ec9882e84a8ebda02" title="Set the look-ahead factor.">set_look_ahead</a>(<span class="keywordtype">int</span> look) { d_look_ahead = look; }
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">  /*! \brief Set the running average alpha</span>
<a name="l00096"></a>00096 <span class="comment">   *  \param alpha new alpha for running average</span>
<a name="l00097"></a>00097 <span class="comment">   */</span>
<a name="l00098"></a><a class="code" href="classgr__peak__detector__ib.html#af9ad814ac46e88c40512ecf132bb819c">00098</a>   <span class="keywordtype">void</span> <a class="code" href="classgr__peak__detector__ib.html#af9ad814ac46e88c40512ecf132bb819c" title="Set the running average alpha.">set_alpha</a>(<span class="keywordtype">int</span> alpha) { d_avg_alpha = <a class="code" href="classgr__peak__detector__ib.html#a47b1a8139b256051bd333ee42d1a445d" title="Get the alpha value of the running average.">alpha</a>; }
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment">  /*! \brief Get the threshold factor value for the rise time</span>
<a name="l00101"></a>00101 <span class="comment">   *  \return threshold factor</span>
<a name="l00102"></a>00102 <span class="comment">   */</span>
<a name="l00103"></a><a class="code" href="classgr__peak__detector__ib.html#a16cccafdfe9de755a679e851c41e2c7c">00103</a>   <span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a16cccafdfe9de755a679e851c41e2c7c" title="Get the threshold factor value for the rise time.">threshold_factor_rise</a>() { <span class="keywordflow">return</span> d_threshold_factor_rise; }
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment">  /*! \brief Get the threshold factor value for the fall time</span>
<a name="l00106"></a>00106 <span class="comment">   *  \return threshold factor</span>
<a name="l00107"></a>00107 <span class="comment">   */</span>
<a name="l00108"></a><a class="code" href="classgr__peak__detector__ib.html#a8ed69f2548b5325a39b9b731c3b8bee2">00108</a>   <span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a8ed69f2548b5325a39b9b731c3b8bee2" title="Get the threshold factor value for the fall time.">threshold_factor_fall</a>() { <span class="keywordflow">return</span> d_threshold_factor_fall; }
<a name="l00109"></a>00109 <span class="comment"></span>
<a name="l00110"></a>00110 <span class="comment">  /*! \brief Get the look-ahead factor value</span>
<a name="l00111"></a>00111 <span class="comment">   *  \return look-ahead factor</span>
<a name="l00112"></a>00112 <span class="comment">   */</span>
<a name="l00113"></a><a class="code" href="classgr__peak__detector__ib.html#ad13fcd580c7e78039110ddd225651066">00113</a>   <span class="keywordtype">int</span> <a class="code" href="classgr__peak__detector__ib.html#ad13fcd580c7e78039110ddd225651066" title="Get the look-ahead factor value.">look_ahead</a>() { <span class="keywordflow">return</span> d_look_ahead; }
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">  /*! \brief Get the alpha value of the running average</span>
<a name="l00116"></a>00116 <span class="comment">   *  \return alpha</span>
<a name="l00117"></a>00117 <span class="comment">   */</span>
<a name="l00118"></a><a class="code" href="classgr__peak__detector__ib.html#a47b1a8139b256051bd333ee42d1a445d">00118</a>   <span class="keywordtype">float</span> <a class="code" href="classgr__peak__detector__ib.html#a47b1a8139b256051bd333ee42d1a445d" title="Get the alpha value of the running average.">alpha</a>() { <span class="keywordflow">return</span> d_avg_alpha; }
<a name="l00119"></a>00119 
<a name="l00120"></a>00120   <span class="keywordtype">int</span> <a class="code" href="classgr__peak__detector__ib.html#ad6e0eed7edf68ace59b559c442e9cd07" 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="l00121"></a>00121             <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items,
<a name="l00122"></a>00122             <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items);
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124 
<a name="l00125"></a>00125 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gr__peak__detector__ib_8h.html">gr_peak_detector_ib.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional