1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>iir1: Iir::CascadeStages< MaxStages, StateType > Class Template Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16</head>
17<body>
18<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19<div id="titlearea">
20<table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td id="projectalign" style="padding-left: 0.5em;">
24 <div id="projectname">iir1
25 </div>
26 </td>
27 </tr>
28 </tbody>
29</table>
30</div>
31<!-- end header part -->
32<!-- Generated by Doxygen 1.9.1 -->
33<script type="text/javascript">
34/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
35var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36/* @license-end */
37</script>
38<script type="text/javascript" src="menudata.js"></script>
39<script type="text/javascript" src="menu.js"></script>
40<script type="text/javascript">
41/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
42$(function() {
43 initMenu('',true,false,'search.php','Search');
44 $(document).ready(function() { init_search(); });
45});
46/* @license-end */</script>
47<div id="main-nav"></div>
48<!-- window showing the filter options -->
49<div id="MSearchSelectWindow"
50 onmouseover="return searchBox.OnSearchSelectShow()"
51 onmouseout="return searchBox.OnSearchSelectHide()"
52 onkeydown="return searchBox.OnSearchSelectKey(event)">
53</div>
54
55<!-- iframe showing the search results (closed by default) -->
56<div id="MSearchResultsWindow">
57<iframe src="javascript:void(0)" frameborder="0"
58 name="MSearchResults" id="MSearchResults">
59</iframe>
60</div>
61
62<div id="nav-path" class="navpath">
63 <ul>
64<li class="navelem"><a class="el" href="namespaceIir.html">Iir</a></li><li class="navelem"><a class="el" href="classIir_1_1CascadeStages.html">CascadeStages</a></li> </ul>
65</div>
…lines 66–76 unchanged (11 lines)
77<div class="dynheader">
78Inheritance diagram for Iir::CascadeStages< MaxStages, StateType >:</div>
79<div class="dyncontent">
80 <div class="center">
81 <img src="classIir_1_1CascadeStages.png" usemap="#Iir::CascadeStages_3C_20MaxStages_2C_20StateType_20_3E_map" alt=""/>
82 <map id="Iir::CascadeStages_3C_20MaxStages_2C_20StateType_20_3E_map" name="Iir::CascadeStages_3C_20MaxStages_2C_20StateType_20_3E_map">
83<area href="structIir_1_1PoleFilter.html" alt="Iir::PoleFilter< BandPassBase, DirectFormII, 4, 4 *2 >" shape="rect" coords="0,56,322,80"/>
84<area href="structIir_1_1PoleFilter.html" alt="Iir::PoleFilter< BandShelfBase, DirectFormII, 4, 4 *2 >" shape="rect" coords="664,56,986,80"/>
85<area href="structIir_1_1PoleFilter.html" alt="Iir::PoleFilter< LowPassBase, DirectFormII, 4 >" shape="rect" coords="1328,56,1650,80"/>
86<area href="structIir_1_1PoleFilter.html" alt="Iir::PoleFilter< LowShelfBase, DirectFormII, 4 >" shape="rect" coords="1992,56,2314,80"/>
87<area href="structIir_1_1PoleFilter.html" alt="Iir::PoleFilter< BandStopBase, DirectFormII, 4, 4 *2 >" shape="rect" coords="2656,56,2978,80"/>
88<area href="structIir_1_1PoleFilter.html" alt="Iir::PoleFilter< HighShelfBase, DirectFormII, 4 >" shape="rect" coords="3320,56,3642,80"/>
89<area href="structIir_1_1PoleFilter.html" alt="Iir::PoleFilter< HighPassBase, DirectFormII, 4 >" shape="rect" coords="3984,56,4306,80"/>
90<area href="structIir_1_1Butterworth_1_1BandPass.html" alt="Iir::Butterworth::BandPass< FilterOrder, StateType >" shape="rect" coords="332,112,654,136"/>
91<area href="structIir_1_1ChebyshevI_1_1BandPass.html" alt="Iir::ChebyshevI::BandPass< FilterOrder, StateType >" shape="rect" coords="332,168,654,192"/>
92<area href="structIir_1_1ChebyshevII_1_1BandPass.html" alt="Iir::ChebyshevII::BandPass< FilterOrder, StateType >" shape="rect" coords="332,224,654,248"/>
93<area href="structIir_1_1Butterworth_1_1BandShelf.html" alt="Iir::Butterworth::BandShelf< FilterOrder, StateType >" shape="rect" coords="996,112,1318,136"/>
94<area href="structIir_1_1ChebyshevI_1_1BandShelf.html" alt="Iir::ChebyshevI::BandShelf< FilterOrder, StateType >" shape="rect" coords="996,168,1318,192"/>
95<area href="structIir_1_1ChebyshevII_1_1BandShelf.html" alt="Iir::ChebyshevII::BandShelf< FilterOrder, StateType >" shape="rect" coords="996,224,1318,248"/>
96<area href="structIir_1_1Butterworth_1_1LowPass.html" alt="Iir::Butterworth::LowPass< FilterOrder, StateType >" shape="rect" coords="1660,112,1982,136"/>
97<area href="structIir_1_1ChebyshevI_1_1LowPass.html" alt="Iir::ChebyshevI::LowPass< FilterOrder, StateType >" shape="rect" coords="1660,168,1982,192"/>
98<area href="structIir_1_1ChebyshevII_1_1LowPass.html" alt="Iir::ChebyshevII::LowPass< FilterOrder, StateType >" shape="rect" coords="1660,224,1982,248"/>
99<area href="structIir_1_1Butterworth_1_1LowShelf.html" alt="Iir::Butterworth::LowShelf< FilterOrder, StateType >" shape="rect" coords="2324,112,2646,136"/>
100<area href="structIir_1_1ChebyshevI_1_1LowShelf.html" alt="Iir::ChebyshevI::LowShelf< FilterOrder, StateType >" shape="rect" coords="2324,168,2646,192"/>
101<area href="structIir_1_1ChebyshevII_1_1LowShelf.html" alt="Iir::ChebyshevII::LowShelf< FilterOrder, StateType >" shape="rect" coords="2324,224,2646,248"/>
102<area href="structIir_1_1Butterworth_1_1BandStop.html" alt="Iir::Butterworth::BandStop< FilterOrder, StateType >" shape="rect" coords="2988,112,3310,136"/>
103<area href="structIir_1_1ChebyshevI_1_1BandStop.html" alt="Iir::ChebyshevI::BandStop< FilterOrder, StateType >" shape="rect" coords="2988,168,3310,192"/>
104<area href="structIir_1_1ChebyshevII_1_1BandStop.html" alt="Iir::ChebyshevII::BandStop< FilterOrder, StateType >" shape="rect" coords="2988,224,3310,248"/>
105<area href="structIir_1_1Butterworth_1_1HighShelf.html" alt="Iir::Butterworth::HighShelf< FilterOrder, StateType >" shape="rect" coords="3652,112,3974,136"/>
106<area href="structIir_1_1ChebyshevI_1_1HighShelf.html" alt="Iir::ChebyshevI::HighShelf< FilterOrder, StateType >" shape="rect" coords="3652,168,3974,192"/>
107<area href="structIir_1_1ChebyshevII_1_1HighShelf.html" alt="Iir::ChebyshevII::HighShelf< FilterOrder, StateType >" shape="rect" coords="3652,224,3974,248"/>
108<area href="structIir_1_1Butterworth_1_1HighPass.html" alt="Iir::Butterworth::HighPass< FilterOrder, StateType >" shape="rect" coords="4316,112,4638,136"/>
109<area href="structIir_1_1ChebyshevI_1_1HighPass.html" alt="Iir::ChebyshevI::HighPass< FilterOrder, StateType >" shape="rect" coords="4316,168,4638,192"/>
110<area href="structIir_1_1ChebyshevII_1_1HighPass.html" alt="Iir::ChebyshevII::HighPass< FilterOrder, StateType >" shape="rect" coords="4316,224,4638,248"/>
111 </map>
112</div></div>
113<table class="memberdecls">
114<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
115Public Member Functions</h2></td></tr>
116<tr class="memitem:ae5253fde0be7ccfa459a3f70fe8e3e31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIir_1_1CascadeStages.html#ae5253fde0be7ccfa459a3f70fe8e3e31">reset</a> ()</td></tr>
117<tr class="separator:ae5253fde0be7ccfa459a3f70fe8e3e31"><td class="memSeparator" colspan="2"> </td></tr>
118<tr class="memitem:a56d24da4cf09f898b534b1b05578244d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIir_1_1CascadeStages.html#a56d24da4cf09f898b534b1b05578244d">setup</a> (const double(&sosCoefficients)[MaxStages][6])</td></tr>
119<tr class="separator:a56d24da4cf09f898b534b1b05578244d"><td class="memSeparator" colspan="2"> </td></tr>
120<tr class="memitem:aa18e9abcaac65fd21be31ee859add3bb"><td class="memTemplParams" colspan="2">template<typename Sample > </td></tr>
121<tr class="memitem:aa18e9abcaac65fd21be31ee859add3bb"><td class="memTemplItemLeft" align="right" valign="top">Sample </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classIir_1_1CascadeStages.html#aa18e9abcaac65fd21be31ee859add3bb">filter</a> (const Sample in)</td></tr>
122<tr class="separator:aa18e9abcaac65fd21be31ee859add3bb"><td class="memSeparator" colspan="2"> </td></tr>
123<tr class="memitem:a034a9be8ae590b814c8499898a93987a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structIir_1_1Cascade_1_1Storage.html">Cascade::Storage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIir_1_1CascadeStages.html#a034a9be8ae590b814c8499898a93987a">getCascadeStorage</a> ()</td></tr>
124<tr class="separator:a034a9be8ae590b814c8499898a93987a"><td class="memSeparator" colspan="2"> </td></tr>
125</table>
126<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127<div class="textblock"><h3>template<int MaxStages, class StateType><br />
128class Iir::CascadeStages< MaxStages, StateType ></h3>
129
130<p>Storage for <a class="el" href="classIir_1_1Cascade.html">Cascade</a>: This holds a chain of 2nd order filters with its coefficients. </p>
131</div><h2 class="groupheader">Member Function Documentation</h2>
132<a id="aa18e9abcaac65fd21be31ee859add3bb"></a>
133<h2 class="memtitle"><span class="permalink"><a href="#aa18e9abcaac65fd21be31ee859add3bb">◆ </a></span>filter()</h2>
134
135<div class="memitem">
136<div class="memproto">
137<div class="memtemplate">
138template<int MaxStages, class StateType > </div>
139<div class="memtemplate">
…lines 140–162 unchanged (23 lines)
163 </dd>
164</dl>
165<dl class="section return"><dt>Returns</dt><dd>filtered sample </dd></dl>
166
167</div>
168</div>
169<a id="a034a9be8ae590b814c8499898a93987a"></a>
170<h2 class="memtitle"><span class="permalink"><a href="#a034a9be8ae590b814c8499898a93987a">◆ </a></span>getCascadeStorage()</h2>
171
172<div class="memitem">
173<div class="memproto">
174<div class="memtemplate">
175template<int MaxStages, class StateType > </div>
176<table class="mlabels">
…lines 177–190 unchanged (14 lines)
191</table>
192</div><div class="memdoc">
193<p>Returns the coefficients of the entire <a class="el" href="classIir_1_1Biquad.html">Biquad</a> chain </p>
194
195</div>
196</div>
197<a id="ae5253fde0be7ccfa459a3f70fe8e3e31"></a>
198<h2 class="memtitle"><span class="permalink"><a href="#ae5253fde0be7ccfa459a3f70fe8e3e31">◆ </a></span>reset()</h2>
199
200<div class="memitem">
201<div class="memproto">
202<div class="memtemplate">
203template<int MaxStages, class StateType > </div>
204<table class="mlabels">
…lines 205–218 unchanged (14 lines)
219</table>
220</div><div class="memdoc">
221<p>Resets all biquads (i.e. the delay lines but not the coefficients) </p>
222
223</div>
224</div>
225<a id="a56d24da4cf09f898b534b1b05578244d"></a>
226<h2 class="memtitle"><span class="permalink"><a href="#a56d24da4cf09f898b534b1b05578244d">◆ </a></span>setup()</h2>
227
228<div class="memitem">
229<div class="memproto">
230<div class="memtemplate">
231template<int MaxStages, class StateType > </div>
232<table class="mlabels">
…lines 233–258 unchanged (26 lines)
259<hr/>The documentation for this class was generated from the following file:<ul>
260<li>iir/<a class="el" href="Cascade_8h_source.html">Cascade.h</a></li>
261</ul>
262</div><!-- contents -->
263<!-- start footer part -->
264<hr class="footer"/><address class="footer"><small>
265Generated on Fri Jan 6 2023 23:53:33 for iir1 by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
266</small></address>
267</body>
268</html>
269