| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|---|
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
|---|
| 3 | <title>mixpp: itpp::MA_Filter< T1, T2, T3 > Class Template Reference</title> |
|---|
| 4 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
|---|
| 5 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
|---|
| 6 | </head><body> |
|---|
| 7 | <!-- Generated by Doxygen 1.5.8 --> |
|---|
| 8 | <script type="text/javascript"> |
|---|
| 9 | <!-- |
|---|
| 10 | function changeDisplayState (e){ |
|---|
| 11 | var num=this.id.replace(/[^[0-9]/g,''); |
|---|
| 12 | var button=this.firstChild; |
|---|
| 13 | var sectionDiv=document.getElementById('dynsection'+num); |
|---|
| 14 | if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){ |
|---|
| 15 | sectionDiv.style.display='block'; |
|---|
| 16 | button.src='open.gif'; |
|---|
| 17 | }else{ |
|---|
| 18 | sectionDiv.style.display='none'; |
|---|
| 19 | button.src='closed.gif'; |
|---|
| 20 | } |
|---|
| 21 | } |
|---|
| 22 | function initDynSections(){ |
|---|
| 23 | var divs=document.getElementsByTagName('div'); |
|---|
| 24 | var sectionCounter=1; |
|---|
| 25 | for(var i=0;i<divs.length-1;i++){ |
|---|
| 26 | if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){ |
|---|
| 27 | var header=divs[i]; |
|---|
| 28 | var section=divs[i+1]; |
|---|
| 29 | var button=header.firstChild; |
|---|
| 30 | if (button!='IMG'){ |
|---|
| 31 | divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild); |
|---|
| 32 | button=document.createElement('img'); |
|---|
| 33 | divs[i].insertBefore(button,divs[i].firstChild); |
|---|
| 34 | } |
|---|
| 35 | header.style.cursor='pointer'; |
|---|
| 36 | header.onclick=changeDisplayState; |
|---|
| 37 | header.id='dynheader'+sectionCounter; |
|---|
| 38 | button.src='closed.gif'; |
|---|
| 39 | section.id='dynsection'+sectionCounter; |
|---|
| 40 | section.style.display='none'; |
|---|
| 41 | section.style.marginLeft='14px'; |
|---|
| 42 | sectionCounter++; |
|---|
| 43 | } |
|---|
| 44 | } |
|---|
| 45 | } |
|---|
| 46 | window.onload = initDynSections; |
|---|
| 47 | --> |
|---|
| 48 | </script> |
|---|
| 49 | <div class="navigation" id="top"> |
|---|
| 50 | <div class="tabs"> |
|---|
| 51 | <ul> |
|---|
| 52 | <li><a href="main.html"><span>Main Page</span></a></li> |
|---|
| 53 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
|---|
| 54 | <li><a href="modules.html"><span>Modules</span></a></li> |
|---|
| 55 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
|---|
| 56 | <li><a href="files.html"><span>Files</span></a></li> |
|---|
| 57 | </ul> |
|---|
| 58 | </div> |
|---|
| 59 | <div class="tabs"> |
|---|
| 60 | <ul> |
|---|
| 61 | <li><a href="annotated.html"><span>Class List</span></a></li> |
|---|
| 62 | <li><a href="classes.html"><span>Class Index</span></a></li> |
|---|
| 63 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
|---|
| 64 | <li><a href="functions.html"><span>Class Members</span></a></li> |
|---|
| 65 | </ul> |
|---|
| 66 | </div> |
|---|
| 67 | <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1MA__Filter.html">MA_Filter</a> |
|---|
| 68 | </div> |
|---|
| 69 | </div> |
|---|
| 70 | <div class="contents"> |
|---|
| 71 | <h1>itpp::MA_Filter< T1, T2, T3 > Class Template Reference<br> |
|---|
| 72 | <small> |
|---|
| 73 | [<a class="el" href="group__filters.html">Filtering</a>]</small> |
|---|
| 74 | </h1><!-- doxytag: class="itpp::MA_Filter" --><!-- doxytag: inherits="Filter< T1, T2, T3 >" -->Moving Average <a class="el" href="classitpp_1_1Filter.html" title="Virtual Filter Base Class.The class is templated as follows:.">Filter</a> Base Class.<p> |
|---|
| 75 | This class implements a moving average (MA) filter according to <p class="formulaDsp"> |
|---|
| 76 | <img class="formulaDsp" alt="\[ y(n) = b(0)*x(n) + b(1)*x(n-1) + ... + b(N)*x(n-N) \]" src="form_344.png"> |
|---|
| 77 | <p> |
|---|
| 78 | where <em>b</em> is the filter coefficients, <em>x</em> is the input and <em>y</em> is the output. |
|---|
| 79 | <a href="#_details">More...</a> |
|---|
| 80 | <p> |
|---|
| 81 | <code>#include <<a class="el" href="filter_8h-source.html">filter.h</a>></code> |
|---|
| 82 | <p> |
|---|
| 83 | |
|---|
| 84 | <p> |
|---|
| 85 | <a href="classitpp_1_1MA__Filter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
|---|
| 86 | <tr><td></td></tr> |
|---|
| 87 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
|---|
| 88 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="93e6273a66c2f7354e30eb6e3ea3e540"></a><!-- doxytag: member="itpp::MA_Filter::MA_Filter" ref="93e6273a66c2f7354e30eb6e3ea3e540" args="()" --> |
|---|
| 89 | </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#93e6273a66c2f7354e30eb6e3ea3e540">MA_Filter</a> ()</td></tr> |
|---|
| 90 | |
|---|
| 91 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Class default constructor. <br></td></tr> |
|---|
| 92 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4018c0b29e9825dc98e84ee0ccb81f2"></a><!-- doxytag: member="itpp::MA_Filter::MA_Filter" ref="b4018c0b29e9825dc98e84ee0ccb81f2" args="(const Vec< T2 > &b)" --> |
|---|
| 93 | </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#b4018c0b29e9825dc98e84ee0ccb81f2">MA_Filter</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>< T2 > &b)</td></tr> |
|---|
| 94 | |
|---|
| 95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor setting the coefficients in the filter. <br></td></tr> |
|---|
| 96 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcd8dbe827a3cde067470f9b23634719"></a><!-- doxytag: member="itpp::MA_Filter::~MA_Filter" ref="bcd8dbe827a3cde067470f9b23634719" args="()" --> |
|---|
| 97 | virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#bcd8dbe827a3cde067470f9b23634719">~MA_Filter</a> ()</td></tr> |
|---|
| 98 | |
|---|
| 99 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr> |
|---|
| 100 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0afe9bb8e3115ec0d7fa613fb60c591"></a><!-- doxytag: member="itpp::MA_Filter::get_coeffs" ref="f0afe9bb8e3115ec0d7fa613fb60c591" args="() const " --> |
|---|
| 101 | <a class="el" href="classitpp_1_1Vec.html">Vec</a>< T2 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#f0afe9bb8e3115ec0d7fa613fb60c591">get_coeffs</a> () const </td></tr> |
|---|
| 102 | |
|---|
| 103 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classitpp_1_1Filter.html" title="Virtual Filter Base Class.The class is templated as follows:.">Filter</a> coefficient access function. <br></td></tr> |
|---|
| 104 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a8b88c583ea3d944e0fe96d2d8f236c"></a><!-- doxytag: member="itpp::MA_Filter::set_coeffs" ref="5a8b88c583ea3d944e0fe96d2d8f236c" args="(const Vec< T2 > &b)" --> |
|---|
| 105 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#5a8b88c583ea3d944e0fe96d2d8f236c">set_coeffs</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>< T2 > &b)</td></tr> |
|---|
| 106 | |
|---|
| 107 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the filter coefficients. <br></td></tr> |
|---|
| 108 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd9611f51af7dbab081188574a35ca29"></a><!-- doxytag: member="itpp::MA_Filter::clear" ref="fd9611f51af7dbab081188574a35ca29" args="()" --> |
|---|
| 109 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#fd9611f51af7dbab081188574a35ca29">clear</a> ()</td></tr> |
|---|
| 110 | |
|---|
| 111 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Clears the filter memory. <br></td></tr> |
|---|
| 112 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34e0b767db049a36de8437954e9c1347"></a><!-- doxytag: member="itpp::MA_Filter::get_state" ref="34e0b767db049a36de8437954e9c1347" args="() const " --> |
|---|
| 113 | <a class="el" href="classitpp_1_1Vec.html">Vec</a>< T3 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#34e0b767db049a36de8437954e9c1347">get_state</a> () const </td></tr> |
|---|
| 114 | |
|---|
| 115 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get state of filter. <br></td></tr> |
|---|
| 116 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8be206733d8c920df446ebdf44ce176c"></a><!-- doxytag: member="itpp::MA_Filter::set_state" ref="8be206733d8c920df446ebdf44ce176c" args="(const Vec< T3 > &state)" --> |
|---|
| 117 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1MA__Filter.html#8be206733d8c920df446ebdf44ce176c">set_state</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>< T3 > &state)</td></tr> |
|---|
| 118 | |
|---|
| 119 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set state of filter. <br></td></tr> |
|---|
| 120 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea7eed601d6c4e32da3b1cd038aa9328"></a><!-- doxytag: member="itpp::MA_Filter::operator()" ref="ea7eed601d6c4e32da3b1cd038aa9328" args="(const T1Sample)" --> |
|---|
| 121 | virtual T3 </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Filter.html#ea7eed601d6c4e32da3b1cd038aa9328">operator()</a> (const T1Sample)</td></tr> |
|---|
| 122 | |
|---|
| 123 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Filter a single sample. <br></td></tr> |
|---|
| 124 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="188d1c2e11dc544c5d88218d61a1f02c"></a><!-- doxytag: member="itpp::MA_Filter::operator()" ref="188d1c2e11dc544c5d88218d61a1f02c" args="(const Vec< T1 > &v)" --> |
|---|
| 125 | virtual <a class="el" href="classitpp_1_1Vec.html">Vec</a>< T3 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Filter.html#188d1c2e11dc544c5d88218d61a1f02c">operator()</a> (const <a class="el" href="classitpp_1_1Vec.html">Vec</a>< T1 > &v)</td></tr> |
|---|
| 126 | |
|---|
| 127 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Filter a vector. <br></td></tr> |
|---|
| 128 | </table> |
|---|
| 129 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
|---|
| 130 | <h3>template<class T1, class T2, class T3><br> |
|---|
| 131 | class itpp::MA_Filter< T1, T2, T3 ></h3> |
|---|
| 132 | |
|---|
| 133 | Moving Average <a class="el" href="classitpp_1_1Filter.html" title="Virtual Filter Base Class.The class is templated as follows:.">Filter</a> Base Class.<p> |
|---|
| 134 | This class implements a moving average (MA) filter according to <p class="formulaDsp"> |
|---|
| 135 | <img class="formulaDsp" alt="\[ y(n) = b(0)*x(n) + b(1)*x(n-1) + ... + b(N)*x(n-N) \]" src="form_344.png"> |
|---|
| 136 | <p> |
|---|
| 137 | where <em>b</em> is the filter coefficients, <em>x</em> is the input and <em>y</em> is the output. |
|---|
| 138 | <p> |
|---|
| 139 | When filtering a vector, the length of the output vector equals the length of the input vector. Internal states are kept in a filter memory. The first time the filter is used the internal states have been set to zero.<p> |
|---|
| 140 | The class is templated as follows: <ul> |
|---|
| 141 | <li> |
|---|
| 142 | <code>T1</code> is the type of the input samples </li> |
|---|
| 143 | <li> |
|---|
| 144 | <code>T2</code> is the type of the filter coefficients </li> |
|---|
| 145 | <li> |
|---|
| 146 | <code>T3</code> is the type of the output samples </li> |
|---|
| 147 | </ul> |
|---|
| 148 | <hr>The documentation for this class was generated from the following file:<ul> |
|---|
| 149 | <li><a class="el" href="filter_8h-source.html">filter.h</a></ul> |
|---|
| 150 | </div> |
|---|
| 151 | <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by |
|---|
| 152 | <a href="http://www.doxygen.org/index.html"> |
|---|
| 153 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
|---|
| 154 | </body> |
|---|
| 155 | </html> |
|---|
