You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
libsdr/classsdr_1_1_frac_sub_sampl...

438 lines
21 KiB
HTML

<!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.9.1"/>
<title>libsdr: sdr::FracSubSampleBase&lt; Scalar &gt; Class Template Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">libsdr
&#160;<span id="projectnumber">0.1.0</span>
</div>
<div id="projectbrief">A simple SDR library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>sdr</b></li><li class="navelem"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html">FracSubSampleBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classsdr_1_1_frac_sub_sample_base-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::FracSubSampleBase&lt; Scalar &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implements a fractional sub-sampler.
<a href="classsdr_1_1_frac_sub_sample_base.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="subsample_8hh_source.html">subsample.hh</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac10da92570b7c169095388951a90282b"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classsdr_1_1_traits.html">Traits</a>&lt; Scalar &gt;::<a class="el" href="classsdr_1_1_frac_sub_sample_base.html#ac10da92570b7c169095388951a90282b">SScalar</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#ac10da92570b7c169095388951a90282b">SScalar</a></td></tr>
<tr class="memdesc:ac10da92570b7c169095388951a90282b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The input &amp; output type super-scalar. <a href="#ac10da92570b7c169095388951a90282b">More...</a><br /></td></tr>
<tr class="separator:ac10da92570b7c169095388951a90282b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9541f45940779515077e41542939bdca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a9541f45940779515077e41542939bdca">FracSubSampleBase</a> (double <a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a7b7b81715160de41b57aaa2b082d4419">frac</a>)</td></tr>
<tr class="memdesc:a9541f45940779515077e41542939bdca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a9541f45940779515077e41542939bdca">More...</a><br /></td></tr>
<tr class="separator:a9541f45940779515077e41542939bdca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5bd940285973e73db71859509fcf223"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#ad5bd940285973e73db71859509fcf223">~FracSubSampleBase</a> ()</td></tr>
<tr class="memdesc:ad5bd940285973e73db71859509fcf223"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#ad5bd940285973e73db71859509fcf223">More...</a><br /></td></tr>
<tr class="separator:ad5bd940285973e73db71859509fcf223"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36217a949cfea7fe5b096cc98aa2e113"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a36217a949cfea7fe5b096cc98aa2e113">setFrac</a> (double <a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a7b7b81715160de41b57aaa2b082d4419">frac</a>)</td></tr>
<tr class="memdesc:a36217a949cfea7fe5b096cc98aa2e113"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the sample rate fraction. <a href="#a36217a949cfea7fe5b096cc98aa2e113">More...</a><br /></td></tr>
<tr class="separator:a36217a949cfea7fe5b096cc98aa2e113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b7b81715160de41b57aaa2b082d4419"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a7b7b81715160de41b57aaa2b082d4419">frac</a> () const </td></tr>
<tr class="memdesc:a7b7b81715160de41b57aaa2b082d4419"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the effective sub-sample fraction. <a href="#a7b7b81715160de41b57aaa2b082d4419">More...</a><br /></td></tr>
<tr class="separator:a7b7b81715160de41b57aaa2b082d4419"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c642f90899d44706f6d1ded63ecf1d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a8c642f90899d44706f6d1ded63ecf1d8">reset</a> ()</td></tr>
<tr class="memdesc:a8c642f90899d44706f6d1ded63ecf1d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset sample counter. <a href="#a8c642f90899d44706f6d1ded63ecf1d8">More...</a><br /></td></tr>
<tr class="separator:a8c642f90899d44706f6d1ded63ecf1d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9570de3fda6677931072581264d33db1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a9570de3fda6677931072581264d33db1">subsample</a> (const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;in, const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;out)</td></tr>
<tr class="memdesc:a9570de3fda6677931072581264d33db1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the sub-sampling. <a href="#a9570de3fda6677931072581264d33db1">More...</a><br /></td></tr>
<tr class="separator:a9570de3fda6677931072581264d33db1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a115e6e3fd14cabc4669fa63d0f47c4d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#ac10da92570b7c169095388951a90282b">SScalar</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a115e6e3fd14cabc4669fa63d0f47c4d5">_avg</a></td></tr>
<tr class="memdesc:a115e6e3fd14cabc4669fa63d0f47c4d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The average. <a href="#a115e6e3fd14cabc4669fa63d0f47c4d5">More...</a><br /></td></tr>
<tr class="separator:a115e6e3fd14cabc4669fa63d0f47c4d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3908cb97d6b862c99a10b34ef84ae817"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a3908cb97d6b862c99a10b34ef84ae817">_sample_count</a></td></tr>
<tr class="memdesc:a3908cb97d6b862c99a10b34ef84ae817"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of samples collected times (1&lt;&lt;16). <a href="#a3908cb97d6b862c99a10b34ef84ae817">More...</a><br /></td></tr>
<tr class="separator:a3908cb97d6b862c99a10b34ef84ae817"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ed0ad8fe1fbbb652cb11975aa1f9220"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#a3ed0ad8fe1fbbb652cb11975aa1f9220">_period</a></td></tr>
<tr class="memdesc:a3ed0ad8fe1fbbb652cb11975aa1f9220"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sub-sample period. <a href="#a3ed0ad8fe1fbbb652cb11975aa1f9220">More...</a><br /></td></tr>
<tr class="separator:a3ed0ad8fe1fbbb652cb11975aa1f9220"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Scalar&gt;<br />
class sdr::FracSubSampleBase&lt; Scalar &gt;</h3>
<p>Implements a fractional sub-sampler. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="ac10da92570b7c169095388951a90282b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classsdr_1_1_traits.html">Traits</a>&lt;Scalar&gt;::<a class="el" href="classsdr_1_1_frac_sub_sample_base.html#ac10da92570b7c169095388951a90282b">SScalar</a> <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::<a class="el" href="classsdr_1_1_frac_sub_sample_base.html#ac10da92570b7c169095388951a90282b">SScalar</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The input &amp; output type super-scalar. </p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9541f45940779515077e41542939bdca"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::<a class="el" href="classsdr_1_1_frac_sub_sample_base.html">FracSubSampleBase</a> </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>frac</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frac</td><td>Specifies the output sample rate relative to the input sample rate. I.e. 2 means half the input sample rate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad5bd940285973e73db71859509fcf223"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::~<a class="el" href="classsdr_1_1_frac_sub_sample_base.html">FracSubSampleBase</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7b7b81715160de41b57aaa2b082d4419"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::frac </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the effective sub-sample fraction. </p>
</div>
</div>
<a class="anchor" id="a8c642f90899d44706f6d1ded63ecf1d8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset sample counter. </p>
</div>
</div>
<a class="anchor" id="a36217a949cfea7fe5b096cc98aa2e113"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::setFrac </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>frac</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the sample rate fraction. </p>
</div>
</div>
<a class="anchor" id="a9570de3fda6677931072581264d33db1"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt;Scalar&gt; <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::subsample </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;&#160;</td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs the sub-sampling. </p>
<p><code>in</code> and <code>out</code> may refer to the same buffer allowing for an in-place operation. Returns a view on the output buffer containing the sub-samples. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a115e6e3fd14cabc4669fa63d0f47c4d5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_frac_sub_sample_base.html#ac10da92570b7c169095388951a90282b">SScalar</a> <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::_avg</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The average. </p>
</div>
</div>
<a class="anchor" id="a3ed0ad8fe1fbbb652cb11975aa1f9220"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::_period</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The sub-sample period. </p>
</div>
</div>
<a class="anchor" id="a3908cb97d6b862c99a10b34ef84ae817"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classsdr_1_1_frac_sub_sample_base.html">sdr::FracSubSampleBase</a>&lt; Scalar &gt;::_sample_count</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of samples collected times (1&lt;&lt;16). </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="subsample_8hh_source.html">subsample.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:28:38 for libsdr by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>