<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>GNU Radio 3.6.4.1 C++ API: digital_probe_mpsk_snr_est_c.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <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.6.4.1 C++ API </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('digital__probe__mpsk__snr__est__c_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">digital_probe_mpsk_snr_est_c.h</div> </div> </div><!--header--> <div class="contents"> <a href="digital__probe__mpsk__snr__est__c_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2011 Free Software Foundation, Inc.</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * </span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * </span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * </span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * </span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef INCLUDED_DIGITAL_PROBE_MPSK_SNR_EST_C_H</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_DIGITAL_PROBE_MPSK_SNR_EST_C_H</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="digital__api_8h.html">digital_api.h</a>></span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="gr__sync__block_8h.html">gr_sync_block.h</a>></span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="digital__impl__mpsk__snr__est_8h.html">digital_impl_mpsk_snr_est.h</a>></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span><a class="code" href="classdigital__probe__mpsk__snr__est__c.html" title="A probe for computing SNR of a signal.">digital_probe_mpsk_snr_est_c</a>;</div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<digital_probe_mpsk_snr_est_c></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">digital_probe_mpsk_snr_est_c_sptr</a>;</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <a class="code" href="digital__api_8h.html#ae14969f36ec69051c4b2f13a0db7e9ba">DIGITAL_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">digital_probe_mpsk_snr_est_c_sptr</a></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <a class="code" href="digital__probe__mpsk__snr__est__c_8h.html#a695e8786610996c07d7e45af397a97ac">digital_make_probe_mpsk_snr_est_c</a>(<a class="code" href="group__snr__blk.html#gad332265a312e8dfe1584460d8859a853" title="Enum for the type of SNR estimator to select.">snr_est_type_t</a> <a class="code" href="classdigital__probe__mpsk__snr__est__c.html#a7c916b326792350a0169dfe1ab0a8afe" title="Return the type of estimator in use.">type</a>,</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">int</span> msg_nsamples=10000,</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">double</span> <a class="code" href="classdigital__probe__mpsk__snr__est__c.html#ac3ec88dfad49c85b12e2f63a9be38f89" title="Get the running-average coefficient.">alpha</a>=0.001);</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">//! \brief A probe for computing SNR of a signal.</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span><span class="comment">/*! \ingroup snr_blk</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * This is a probe block (a sink) that can be used to monitor and</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * retrieve estimations of the signal SNR. This probe is designed for</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * use with M-PSK signals especially. The type of estimator is</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * specified as the \p type parameter in the constructor. The</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * estimators tend to trade off performance for accuracy, although</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * experimentation should be done to figure out the right approach</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * for a given implementation. Further, the current set of estimators</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * are designed and proven theoretically under AWGN conditions; some</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * amount of error should be assumed and/or estimated for real</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * channel conditions.</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> */</span></div> <div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="classdigital__probe__mpsk__snr__est__c.html"> 51</a></span> <span class="keyword">class </span><a class="code" href="digital__api_8h.html#ae14969f36ec69051c4b2f13a0db7e9ba">DIGITAL_API</a> <a class="code" href="classdigital__probe__mpsk__snr__est__c.html" title="A probe for computing SNR of a signal.">digital_probe_mpsk_snr_est_c</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></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="group__snr__blk.html#gad332265a312e8dfe1584460d8859a853" title="Enum for the type of SNR estimator to select.">snr_est_type_t</a> d_type;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> d_nsamples, d_count;</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">double</span> d_alpha;</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classdigital__impl__mpsk__snr__est.html" title="A parent class for SNR estimators, specifically for M-PSK signals in AWGN channels.">digital_impl_mpsk_snr_est</a> *d_snr_est;</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">//d_key is the message name, 'snr'</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> d_key;</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /*! Factory function returning shared pointer of this class</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * Parameters:</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> *</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * \param type: the type of estimator to use \ref ref_snr_est_types</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * "snr_est_type_t" for details about the available types.</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * \param msg_nsamples: [not implemented yet] after this many</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * samples, a message containing the SNR (key='snr') will be sent</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * \param alpha: the update rate of internal running average</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * calculations.</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> */</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">friend</span> <a class="code" href="digital__api_8h.html#ae14969f36ec69051c4b2f13a0db7e9ba">DIGITAL_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">digital_probe_mpsk_snr_est_c_sptr</a></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="digital__probe__mpsk__snr__est__c_8h.html#a695e8786610996c07d7e45af397a97ac">digital_make_probe_mpsk_snr_est_c</a>(<a class="code" href="group__snr__blk.html#gad332265a312e8dfe1584460d8859a853" title="Enum for the type of SNR estimator to select.">snr_est_type_t</a> type, </div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> msg_nsamples,</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">double</span> alpha);</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment"></span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> //! Private constructor</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span> <a class="code" href="classdigital__probe__mpsk__snr__est__c.html" title="A probe for computing SNR of a signal.">digital_probe_mpsk_snr_est_c</a>(<a class="code" href="group__snr__blk.html#gad332265a312e8dfe1584460d8859a853" title="Enum for the type of SNR estimator to select.">snr_est_type_t</a> type,</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">int</span> msg_nsamples,</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">double</span> alpha);</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  ~<a class="code" href="classdigital__probe__mpsk__snr__est__c.html" title="A probe for computing SNR of a signal.">digital_probe_mpsk_snr_est_c</a>();</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">int</span> <a class="code" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117" 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,</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items,</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items);</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> //! Return the estimated signal-to-noise ratio in decibels</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> <span class="keywordtype">double</span> snr();</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> //! Return the type of estimator in use</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> <a class="code" href="group__snr__blk.html#gad332265a312e8dfe1584460d8859a853" title="Enum for the type of SNR estimator to select.">snr_est_type_t</a> type() <span class="keyword">const</span>;</div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> //! Return how many samples between SNR messages</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span> <span class="keywordtype">int</span> msg_nsample() <span class="keyword">const</span>;</div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> //! Get the running-average coefficient</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span> <span class="keywordtype">double</span> alpha() <span class="keyword">const</span>;</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> //! Set type of estimator to use</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span> <span class="keywordtype">void</span> set_type(<a class="code" href="group__snr__blk.html#gad332265a312e8dfe1584460d8859a853" title="Enum for the type of SNR estimator to select.">snr_est_type_t</a> t);</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> //! Set the number of samples between SNR messages</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span> <span class="keywordtype">void</span> set_msg_nsample(<span class="keywordtype">int</span> n);</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> //! Set the running-average coefficient</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span> <span class="keywordtype">void</span> set_alpha(<span class="keywordtype">double</span> alpha);</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> };</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_DIGITAL_PROBE_MPSK_SNR_EST_C_H */</span><span class="preprocessor"></span></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_f7216719ef3afaeb42c046b1c085d582.html">gr-digital</a></li><li class="navelem"><a class="el" href="dir_cd60c432b920e74905d47b61718dc7dc.html">include</a></li><li class="navelem"><a class="el" href="digital__probe__mpsk__snr__est__c_8h.html">digital_probe_mpsk_snr_est_c.h</a></li> <li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li> </ul> </div> </body> </html>