source: flair-dev/trunk/doc/Flair/classflair_1_1filter_1_1_butterworth_low_pass.html @ 15

Last change on this file since 15 was 15, checked in by Sanahuja Guillaume, 5 years ago

m

File size: 35.6 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
7<title>Flair: flair::filter::ButterworthLowPass Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtree.js"></script>
14<script type="text/javascript">
15  $(document).ready(initResizable);
16  $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21  $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32  <td style="padding-left: 0.5em;">
33   <div id="projectname">Flair
34   </div>
35   <div id="projectbrief">Framework Libre Air</div>
36  </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46  <div id="navrow1" class="tabs">
47    <ul class="tablist">
48      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
51      <li><a href="files.html"><span>Files</span></a></li>
52      <li>
53        <div id="MSearchBox" class="MSearchBoxInactive">
54        <span class="left">
55          <img id="MSearchSelect" src="search/mag_sel.png"
56               onmouseover="return searchBox.OnSearchSelectShow()"
57               onmouseout="return searchBox.OnSearchSelectHide()"
58               alt=""/>
59          <input type="text" id="MSearchField" value="Search" accesskey="S"
60               onfocus="searchBox.OnSearchFieldFocus(true)" 
61               onblur="searchBox.OnSearchFieldFocus(false)" 
62               onkeyup="searchBox.OnSearchFieldChange(event)"/>
63          </span><span class="right">
64            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65          </span>
66        </div>
67      </li>
68    </ul>
69  </div>
70  <div id="navrow2" class="tabs2">
71    <ul class="tablist">
72      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
73      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
74      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
75      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
76    </ul>
77  </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80  <div id="nav-tree">
81    <div id="nav-tree-contents">
82      <div id="nav-sync" class="sync"></div>
83    </div>
84  </div>
85  <div id="splitbar" style="-moz-user-select:none;" 
86       class="ui-resizable-handle">
87  </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('classflair_1_1filter_1_1_butterworth_low_pass.html','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95     onmouseover="return searchBox.OnSearchSelectShow()"
96     onmouseout="return searchBox.OnSearchSelectHide()"
97     onkeydown="return searchBox.OnSearchSelectKey(event)">
98<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0" 
103        name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108  <div class="summary">
109<a href="#pub-methods">Public Member Functions</a> &#124;
110<a href="classflair_1_1filter_1_1_butterworth_low_pass-members.html">List of all members</a>  </div>
111  <div class="headertitle">
112<div class="title">flair::filter::ButterworthLowPass Class Reference</div>  </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Class defining a Butterworth low pass filter. 
117 <a href="classflair_1_1filter_1_1_butterworth_low_pass.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_butterworth_low_pass_8h_source.html">ButterworthLowPass.h</a>&gt;</code></p>
120<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
121  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::filter::ButterworthLowPass:</div>
122<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
123</div>
124<div id="dynsection-0-content" class="dyncontent" style="display:none;">
125 <div class="center">
126  <img src="classflair_1_1filter_1_1_butterworth_low_pass.png" usemap="#flair::filter::ButterworthLowPass_map" alt=""/>
127  <map id="flair::filter::ButterworthLowPass_map" name="flair::filter::ButterworthLowPass_map">
128<area href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. " alt="flair::core::IODevice" shape="rect" coords="0,56,185,80"/>
129<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="0,0,185,24"/>
130</map>
131 </div></div>
132<table class="memberdecls">
133<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
134Public Member Functions</h2></td></tr>
135<tr class="memitem:ad1417a0766eef7efb2edff2ee414088f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#ad1417a0766eef7efb2edff2ee414088f">ButterworthLowPass</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a> *parent, const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name, int order)</td></tr>
136<tr class="memdesc:ad1417a0766eef7efb2edff2ee414088f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad1417a0766eef7efb2edff2ee414088f">More...</a><br /></td></tr>
137<tr class="separator:ad1417a0766eef7efb2edff2ee414088f"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:ad7fe750163ad9241b1e0ba2eef88329c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#ad7fe750163ad9241b1e0ba2eef88329c">ButterworthLowPass</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name, int order)</td></tr>
139<tr class="memdesc:ad7fe750163ad9241b1e0ba2eef88329c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad7fe750163ad9241b1e0ba2eef88329c">More...</a><br /></td></tr>
140<tr class="separator:ad7fe750163ad9241b1e0ba2eef88329c"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:a8d46936fb2781bc74297c1fee29f54b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#a8d46936fb2781bc74297c1fee29f54b7">~ButterworthLowPass</a> ()</td></tr>
142<tr class="memdesc:a8d46936fb2781bc74297c1fee29f54b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a8d46936fb2781bc74297c1fee29f54b7">More...</a><br /></td></tr>
143<tr class="separator:a8d46936fb2781bc74297c1fee29f54b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
144<tr class="memitem:a6575a8015f4b57ea3c4480c713b2dcc7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#a6575a8015f4b57ea3c4480c713b2dcc7">Output</a> (void) const </td></tr>
145<tr class="memdesc:a6575a8015f4b57ea3c4480c713b2dcc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output value.  <a href="#a6575a8015f4b57ea3c4480c713b2dcc7">More...</a><br /></td></tr>
146<tr class="separator:a6575a8015f4b57ea3c4480c713b2dcc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
147<tr class="memitem:a8188ff5562d16d9be80e06c0bf686325"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#a8188ff5562d16d9be80e06c0bf686325">Matrix</a> (void) const </td></tr>
148<tr class="memdesc:a8188ff5562d16d9be80e06c0bf686325"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output matrix.  <a href="#a8188ff5562d16d9be80e06c0bf686325">More...</a><br /></td></tr>
149<tr class="separator:a8188ff5562d16d9be80e06c0bf686325"><td class="memSeparator" colspan="2">&#160;</td></tr>
150<tr class="memitem:a0f33384da8b2278f8b3f6a8235134edc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#a0f33384da8b2278f8b3f6a8235134edc">UpdateFrom</a> (const <a class="el" href="classflair_1_1core_1_1io__data.html">core::io_data</a> *data)</td></tr>
151<tr class="memdesc:a0f33384da8b2278f8b3f6a8235134edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update using provided datas.  <a href="#a0f33384da8b2278f8b3f6a8235134edc">More...</a><br /></td></tr>
152<tr class="separator:a0f33384da8b2278f8b3f6a8235134edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
153<tr class="inherit_header pub_methods_classflair_1_1core_1_1_i_o_device"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_i_o_device')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></td></tr>
154<tr class="memitem:a9693b497752b466891eaafeb34bec4d3 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name)</td></tr>
155<tr class="memdesc:a9693b497752b466891eaafeb34bec4d3 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a9693b497752b466891eaafeb34bec4d3">More...</a><br /></td></tr>
156<tr class="separator:a9693b497752b466891eaafeb34bec4d3 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<tr class="memitem:a05246988b486def40926d8491e1bcc5f inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a05246988b486def40926d8491e1bcc5f">~IODevice</a> ()</td></tr>
158<tr class="memdesc:a05246988b486def40926d8491e1bcc5f inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a05246988b486def40926d8491e1bcc5f">More...</a><br /></td></tr>
159<tr class="separator:a05246988b486def40926d8491e1bcc5f inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
160<tr class="memitem:af7b42de6bb3893df860063228b55c229 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#af7b42de6bb3893df860063228b55c229">AddDeviceToLog</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *device)</td></tr>
161<tr class="memdesc:af7b42de6bb3893df860063228b55c229 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a> to the logs.  <a href="#af7b42de6bb3893df860063228b55c229">More...</a><br /></td></tr>
162<tr class="separator:af7b42de6bb3893df860063228b55c229 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
163<tr class="memitem:a2e0b7af75abdbf39843d8bf2e45f08b9 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a2e0b7af75abdbf39843d8bf2e45f08b9">AddDataToLog</a> (const <a class="el" href="classflair_1_1core_1_1io__data.html">io_data</a> *data)</td></tr>
164<tr class="memdesc:a2e0b7af75abdbf39843d8bf2e45f08b9 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="classflair_1_1core_1_1io__data.html" title="Abstract class for data types. ">io_data</a> to the log.  <a href="#a2e0b7af75abdbf39843d8bf2e45f08b9">More...</a><br /></td></tr>
165<tr class="separator:a2e0b7af75abdbf39843d8bf2e45f08b9 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
166<tr class="memitem:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a12d811c6926fb86da6b47f889109da66">OutputToShMem</a> (bool enabled)</td></tr>
167<tr class="memdesc:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send the output to a shared memory.  <a href="#a12d811c6926fb86da6b47f889109da66">More...</a><br /></td></tr>
168<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
169<tr class="memitem:a75e82ca2ae2fb7c39d973dd3d16bc698 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75e82ca2ae2fb7c39d973dd3d16bc698"></a>
170virtual <a class="el" href="classflair_1_1core_1_1_data_type.html">DataType</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetInputDataType</b> () const </td></tr>
171<tr class="separator:a75e82ca2ae2fb7c39d973dd3d16bc698 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
172<tr class="memitem:aa325be57d48b268006120dde75dd65cc inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa325be57d48b268006120dde75dd65cc"></a>
173virtual <a class="el" href="classflair_1_1core_1_1_data_type.html">DataType</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetOutputDataType</b> () const </td></tr>
174<tr class="separator:aa325be57d48b268006120dde75dd65cc inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
175<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
176<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
177<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
178<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
180<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
181<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
183<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name.  <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
184<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
186<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type.  <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
187<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
189<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent.  <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
190<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
191<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
192<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type.  <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
193<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
194<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
195<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs.  <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
196<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
197<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
198<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information.  <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
199<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
200<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
201<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning.  <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
202<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
203<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
204<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error.  <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
205<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
206<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
207<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
208<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
209</table><table class="memberdecls">
210<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
211Additional Inherited Members</h2></td></tr>
212<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
213<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
214<b>Red</b> = 31,
215<b>Green</b> = 32,
216<b>Orange</b> = 33
217 }</td></tr>
218<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
219<tr class="inherit_header pro_methods_classflair_1_1core_1_1_i_o_device"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classflair_1_1core_1_1_i_o_device')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></td></tr>
220<tr class="memitem:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a3df9057ae23eb34f1b1dae8e7a4a9efc">ProcessUpdate</a> (<a class="el" href="classflair_1_1core_1_1io__data.html">io_data</a> *data)</td></tr>
221<tr class="memdesc:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process the childs of type <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>, and log if needed.  <a href="#a3df9057ae23eb34f1b1dae8e7a4a9efc">More...</a><br /></td></tr>
222<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
223</table>
224<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
225<div class="textblock"><p>Class defining a Butterworth low pass filter. </p>
226</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
227<a class="anchor" id="ad1417a0766eef7efb2edff2ee414088f"></a>
228<div class="memitem">
229<div class="memproto">
230      <table class="memname">
231        <tr>
232          <td class="memname">flair::filter::ButterworthLowPass::ButterworthLowPass </td>
233          <td>(</td>
234          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a> *&#160;</td>
235          <td class="paramname"><em>parent</em>, </td>
236        </tr>
237        <tr>
238          <td class="paramkey"></td>
239          <td></td>
240          <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *&#160;</td>
241          <td class="paramname"><em>position</em>, </td>
242        </tr>
243        <tr>
244          <td class="paramkey"></td>
245          <td></td>
246          <td class="paramtype">std::string&#160;</td>
247          <td class="paramname"><em>name</em>, </td>
248        </tr>
249        <tr>
250          <td class="paramkey"></td>
251          <td></td>
252          <td class="paramtype">int&#160;</td>
253          <td class="paramname"><em>order</em>&#160;</td>
254        </tr>
255        <tr>
256          <td></td>
257          <td>)</td>
258          <td></td><td></td>
259        </tr>
260      </table>
261</div><div class="memdoc">
262
263<p>Constructor. </p>
264<p>Construct a <a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html" title="Class defining a Butterworth low pass filter. ">ButterworthLowPass</a> at position. <br />
265 After calling this function, position will be deleted as it is no longer usefull. <br />
266 The filter is automatically updated when parent's IODevice::ProcessUpdate is called.</p>
267<dl class="params"><dt>Parameters</dt><dd>
268  <table class="params">
269    <tr><td class="paramname">parent</td><td>parent </td></tr>
270    <tr><td class="paramname">position</td><td>position to display settings </td></tr>
271    <tr><td class="paramname">name</td><td>name </td></tr>
272    <tr><td class="paramname">order</td><td>order of the filter </td></tr>
273  </table>
274  </dd>
275</dl>
276
277</div>
278</div>
279<a class="anchor" id="ad7fe750163ad9241b1e0ba2eef88329c"></a>
280<div class="memitem">
281<div class="memproto">
282      <table class="memname">
283        <tr>
284          <td class="memname">flair::filter::ButterworthLowPass::ButterworthLowPass </td>
285          <td>(</td>
286          <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *&#160;</td>
287          <td class="paramname"><em>position</em>, </td>
288        </tr>
289        <tr>
290          <td class="paramkey"></td>
291          <td></td>
292          <td class="paramtype">std::string&#160;</td>
293          <td class="paramname"><em>name</em>, </td>
294        </tr>
295        <tr>
296          <td class="paramkey"></td>
297          <td></td>
298          <td class="paramtype">int&#160;</td>
299          <td class="paramname"><em>order</em>&#160;</td>
300        </tr>
301        <tr>
302          <td></td>
303          <td>)</td>
304          <td></td><td></td>
305        </tr>
306      </table>
307</div><div class="memdoc">
308
309<p>Constructor. </p>
310<p>Construct a <a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html" title="Class defining a Butterworth low pass filter. ">ButterworthLowPass</a> at position. <br />
311 The <a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html" title="Class defining a Butterworth low pass filter. ">ButterworthLowPass</a> will automatically be child of position-&gt;getLayout() Layout. After calling this function, position will be deleted as it is no longer usefull. <br />
312 The filter is updated manually with UpdateFrom method. <br />
313 </p><dl class="params"><dt>Parameters</dt><dd>
314  <table class="params">
315    <tr><td class="paramname">position</td><td>position to display settings </td></tr>
316    <tr><td class="paramname">name</td><td>name </td></tr>
317    <tr><td class="paramname">order</td><td>order of the filter </td></tr>
318  </table>
319  </dd>
320</dl>
321
322</div>
323</div>
324<a class="anchor" id="a8d46936fb2781bc74297c1fee29f54b7"></a>
325<div class="memitem">
326<div class="memproto">
327      <table class="memname">
328        <tr>
329          <td class="memname">flair::filter::ButterworthLowPass::~ButterworthLowPass </td>
330          <td>(</td>
331          <td class="paramname"></td><td>)</td>
332          <td></td>
333        </tr>
334      </table>
335</div><div class="memdoc">
336
337<p>Destructor. </p>
338
339</div>
340</div>
341<h2 class="groupheader">Member Function Documentation</h2>
342<a class="anchor" id="a6575a8015f4b57ea3c4480c713b2dcc7"></a>
343<div class="memitem">
344<div class="memproto">
345      <table class="memname">
346        <tr>
347          <td class="memname">float flair::filter::ButterworthLowPass::Output </td>
348          <td>(</td>
349          <td class="paramtype">void&#160;</td>
350          <td class="paramname"></td><td>)</td>
351          <td> const</td>
352        </tr>
353      </table>
354</div><div class="memdoc">
355
356<p>Output value. </p>
357<dl class="section return"><dt>Returns</dt><dd>filtered output </dd></dl>
358
359</div>
360</div>
361<a class="anchor" id="a8188ff5562d16d9be80e06c0bf686325"></a>
362<div class="memitem">
363<div class="memproto">
364      <table class="memname">
365        <tr>
366          <td class="memname"><a class="el" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a>* flair::filter::ButterworthLowPass::Matrix </td>
367          <td>(</td>
368          <td class="paramtype">void&#160;</td>
369          <td class="paramname"></td><td>)</td>
370          <td> const</td>
371        </tr>
372      </table>
373</div><div class="memdoc">
374
375<p>Output matrix. </p>
376<dl class="section return"><dt>Returns</dt><dd>filtered output </dd></dl>
377
378</div>
379</div>
380<a class="anchor" id="a0f33384da8b2278f8b3f6a8235134edc"></a>
381<div class="memitem">
382<div class="memproto">
383<table class="mlabels">
384  <tr>
385  <td class="mlabels-left">
386      <table class="memname">
387        <tr>
388          <td class="memname">void flair::filter::ButterworthLowPass::UpdateFrom </td>
389          <td>(</td>
390          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1io__data.html">core::io_data</a> *&#160;</td>
391          <td class="paramname"><em>data</em></td><td>)</td>
392          <td></td>
393        </tr>
394      </table>
395  </td>
396  <td class="mlabels-right">
397<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
398  </tr>
399</table>
400</div><div class="memdoc">
401
402<p>Update using provided datas. </p>
403<p>Reimplemented from IODevice.</p>
404<dl class="params"><dt>Parameters</dt><dd>
405  <table class="params">
406    <tr><td class="paramname">data</td><td>data from the parent to process </td></tr>
407  </table>
408  </dd>
409</dl>
410
411<p>Implements <a class="el" href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a>.</p>
412
413</div>
414</div>
415</div><!-- contents -->
416</div><!-- doc-content -->
417<!-- start footer part -->
418<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
419  <ul>
420    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1filter.html">filter</a></li><li class="navelem"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html">ButterworthLowPass</a></li>
421    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
422    <a href="http://www.doxygen.org/index.html">
423    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
424  </ul>
425</div>
426</body>
427</html>
Note: See TracBrowser for help on using the repository browser.