33< head >
44< meta http-equiv ="Content-Type " content ="text/xhtml;charset=UTF-8 "/>
55< meta http-equiv ="X-UA-Compatible " content ="IE=9 "/>
6- < meta name ="generator " content ="Doxygen 1.8.17 "/>
6+ < meta name ="generator " content ="Doxygen 1.9.1 "/>
77< meta name ="viewport " content ="width=device-width, initial-scale=1 "/>
88< title > fir1: Fir1 Class Reference</ title >
99< link href ="tabs.css " rel ="stylesheet " type ="text/css "/>
2929</ table >
3030</ div >
3131<!-- end header part -->
32- <!-- Generated by Doxygen 1.8.17 -->
32+ <!-- Generated by Doxygen 1.9.1 -->
3333< script type ="text/javascript ">
3434/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
35- var searchBox = new SearchBox ( "searchBox" , "search" , false , 'Search' ) ;
35+ var searchBox = new SearchBox ( "searchBox" , "search" , false , 'Search' , '.html' ) ;
3636/* @license -end */
3737</ script >
3838< script type ="text/javascript " src ="menudata.js "> </ script >
7878< tr class ="separator:a8164ab2294cf92979a009362682e2ecd "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
7979< tr class ="memitem:a31b98d0df8a4c15f8c85590a5d49ed1d "> < td class ="memItemLeft " align ="right " valign ="top ">  </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a31b98d0df8a4c15f8c85590a5d49ed1d "> Fir1</ a > (std::vector< double > _coefficients)</ td > </ tr >
8080< tr class ="separator:a31b98d0df8a4c15f8c85590a5d49ed1d "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
81- < tr class ="memitem:a507801740031cd31e91a02346e8fd6ac "> < td class ="memItemLeft " align ="right " valign ="top ">  </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a507801740031cd31e91a02346e8fd6ac "> Fir1</ a > (double *coefficients, unsigned number_of_taps)</ td > </ tr >
82- < tr class ="separator:a507801740031cd31e91a02346e8fd6ac "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
81+ < tr class ="memitem:a8edb996530767bb24a7eb88d4eaaa687 "> < td class ="memItemLeft " align ="right " valign ="top ">  </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a8edb996530767bb24a7eb88d4eaaa687 "> Fir1</ a > (const double *coefficients, const unsigned number_of_taps)</ td > </ tr >
82+ < tr class ="separator:a8edb996530767bb24a7eb88d4eaaa687 "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
8383< tr class ="memitem:a3391ecc885a06e14baf5d5ea8fb50588 "> < td class ="memItemLeft " align ="right " valign ="top ">  </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a3391ecc885a06e14baf5d5ea8fb50588 "> Fir1</ a > (const char *coeffFile, unsigned number_of_taps=0)</ td > </ tr >
8484< tr class ="separator:a3391ecc885a06e14baf5d5ea8fb50588 "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
85- < tr class ="memitem:ad2296bf585406c502f2e4271e9b4427c "> < td class ="memItemLeft " align ="right " valign ="top ">  </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#ad2296bf585406c502f2e4271e9b4427c "> Fir1</ a > (unsigned number_of_taps)</ td > </ tr >
86- < tr class ="separator:ad2296bf585406c502f2e4271e9b4427c "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
85+ < tr class ="memitem:a79f682f484eb3a9c2c97416abb569294 "> < td class ="memItemLeft " align ="right " valign ="top ">  </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a79f682f484eb3a9c2c97416abb569294 "> Fir1</ a > (unsigned number_of_taps, double value=0 )</ td > </ tr >
86+ < tr class ="separator:a79f682f484eb3a9c2c97416abb569294 "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
8787< tr class ="memitem:a86233a005b6a50a461169ff262825970 "> < td class ="memItemLeft " align ="right " valign ="top ">  </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a86233a005b6a50a461169ff262825970 "> ~Fir1</ a > ()</ td > </ tr >
8888< tr class ="separator:a86233a005b6a50a461169ff262825970 "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
8989< tr class ="memitem:a98b5f6c881da9eed30cbc6908fb48158 "> < td class ="memItemLeft " align ="right " valign ="top "> double </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a98b5f6c881da9eed30cbc6908fb48158 "> filter</ a > (double input)</ td > </ tr >
100100< tr class ="separator:add6c80346d4fec6e9a270df55f604456 "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
101101< tr class ="memitem:a5b1970b5d534d61802dfe9109fd48522 "> < td class ="memItemLeft " align ="right " valign ="top "> void </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a5b1970b5d534d61802dfe9109fd48522 "> getCoeff</ a > (double *coeff_data, unsigned number_of_taps) const</ td > </ tr >
102102< tr class ="separator:a5b1970b5d534d61802dfe9109fd48522 "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
103+ < tr class ="memitem:a6e039c10d4e89e4e39a8d7c8f6ef7a02 "> < td class ="memItemLeft " align ="right " valign ="top "> void </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a6e039c10d4e89e4e39a8d7c8f6ef7a02 "> setCoeff</ a > (const double *coeff_data, const unsigned number_of_taps)</ td > </ tr >
104+ < tr class ="memdesc:a6e039c10d4e89e4e39a8d7c8f6ef7a02 "> < td class ="mdescLeft ">  </ td > < td class ="mdescRight "> Externally sets the coefficient array. This is useful when the actually running filter is at a different place as where the updating filter is employed. < a href ="classFir1.html#a6e039c10d4e89e4e39a8d7c8f6ef7a02 "> More...</ a > < br /> </ td > </ tr >
105+ < tr class ="separator:a6e039c10d4e89e4e39a8d7c8f6ef7a02 "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
103106< tr class ="memitem:ad18c498378f7a2affaffddc1b4a238ad "> < td class ="memItemLeft " align ="right " valign ="top "> std::vector< double > </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#ad18c498378f7a2affaffddc1b4a238ad "> getCoeffVector</ a > () const</ td > </ tr >
104107< tr class ="separator:ad18c498378f7a2affaffddc1b4a238ad "> < td class ="memSeparator " colspan ="2 ">  </ td > </ tr >
105108< tr class ="memitem:a83f3a1bd1c3c8cc571962c6b561a9e29 "> < td class ="memItemLeft " align ="right " valign ="top "> unsigned </ td > < td class ="memItemRight " valign ="bottom "> < a class ="el " href ="classFir1.html#a83f3a1bd1c3c8cc571962c6b561a9e29 "> getTaps</ a > ()</ td > </ tr >
@@ -176,22 +179,22 @@ <h2 class="memtitle"><span class="permalink"><a href="#a31b98d0df8a4c15f8c85590a
176179
177180</ div >
178181</ div >
179- < a id ="a507801740031cd31e91a02346e8fd6ac "> </ a >
180- < h2 class ="memtitle "> < span class ="permalink "> < a href ="#a507801740031cd31e91a02346e8fd6ac "> ◆ </ a > </ span > Fir1() < span class ="overload "> [3/5]</ span > </ h2 >
182+ < a id ="a8edb996530767bb24a7eb88d4eaaa687 "> </ a >
183+ < h2 class ="memtitle "> < span class ="permalink "> < a href ="#a8edb996530767bb24a7eb88d4eaaa687 "> ◆ </ a > </ span > Fir1() < span class ="overload "> [3/5]</ span > </ h2 >
181184
182185< div class ="memitem ">
183186< div class ="memproto ">
184187 < table class ="memname ">
185188 < tr >
186189 < td class ="memname "> Fir1::Fir1 </ td >
187190 < td > (</ td >
188- < td class ="paramtype "> double * </ td >
191+ < td class ="paramtype "> const double * </ td >
189192 < td class ="paramname "> < em > coefficients</ em > , </ td >
190193 </ tr >
191194 < tr >
192195 < td class ="paramkey "> </ td >
193196 < td > </ td >
194- < td class ="paramtype "> unsigned </ td >
197+ < td class ="paramtype "> const unsigned </ td >
195198 < td class ="paramname "> < em > number_of_taps</ em >  </ td >
196199 </ tr >
197200 < tr >
@@ -246,8 +249,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3391ecc885a06e14baf5d5ea
246249
247250</ div >
248251</ div >
249- < a id ="ad2296bf585406c502f2e4271e9b4427c "> </ a >
250- < h2 class ="memtitle "> < span class ="permalink "> < a href ="#ad2296bf585406c502f2e4271e9b4427c "> ◆ </ a > </ span > Fir1() < span class ="overload "> [5/5]</ span > </ h2 >
252+ < a id ="a79f682f484eb3a9c2c97416abb569294 "> </ a >
253+ < h2 class ="memtitle "> < span class ="permalink "> < a href ="#a79f682f484eb3a9c2c97416abb569294 "> ◆ </ a > </ span > Fir1() < span class ="overload "> [5/5]</ span > </ h2 >
251254
252255< div class ="memitem ">
253256< div class ="memproto ">
@@ -256,12 +259,22 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad2296bf585406c502f2e4271
256259 < td class ="memname "> Fir1::Fir1 </ td >
257260 < td > (</ td >
258261 < td class ="paramtype "> unsigned </ td >
259- < td class ="paramname "> < em > number_of_taps</ em > </ td > < td > )</ td >
262+ < td class ="paramname "> < em > number_of_taps</ em > , </ td >
263+ </ tr >
264+ < tr >
265+ < td class ="paramkey "> </ td >
260266 < td > </ td >
267+ < td class ="paramtype "> double </ td >
268+ < td class ="paramname "> < em > value</ em > = < code > 0</ code >  </ td >
269+ </ tr >
270+ < tr >
271+ < td > </ td >
272+ < td > )</ td >
273+ < td > </ td > < td > </ td >
261274 </ tr >
262275 </ table >
263276</ div > < div class ="memdoc ">
264- < p > Inits all coefficients and the buffer to zero This is useful for adaptive filters where we start with zero valued coefficients. </ p >
277+ < p > Inits all coefficients and the buffer to a constant value. This is useful for adaptive filters where we start with zero valued coefficients or moving average filters with value = 1.0/number_of_taps . </ p >
265278
266279</ div >
267280</ div >
@@ -509,6 +522,43 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3516709a67439e6fa1ecd3aa
509522</ div > < div class ="memdoc ">
510523< p > Resets the buffer (but not the coefficients) </ p >
511524
525+ </ div >
526+ </ div >
527+ < a id ="a6e039c10d4e89e4e39a8d7c8f6ef7a02 "> </ a >
528+ < h2 class ="memtitle "> < span class ="permalink "> < a href ="#a6e039c10d4e89e4e39a8d7c8f6ef7a02 "> ◆ </ a > </ span > setCoeff()</ h2 >
529+
530+ < div class ="memitem ">
531+ < div class ="memproto ">
532+ < table class ="memname ">
533+ < tr >
534+ < td class ="memname "> void Fir1::setCoeff </ td >
535+ < td > (</ td >
536+ < td class ="paramtype "> const double * </ td >
537+ < td class ="paramname "> < em > coeff_data</ em > , </ td >
538+ </ tr >
539+ < tr >
540+ < td class ="paramkey "> </ td >
541+ < td > </ td >
542+ < td class ="paramtype "> const unsigned </ td >
543+ < td class ="paramname "> < em > number_of_taps</ em >  </ td >
544+ </ tr >
545+ < tr >
546+ < td > </ td >
547+ < td > )</ td >
548+ < td > </ td > < td > </ td >
549+ </ tr >
550+ </ table >
551+ </ div > < div class ="memdoc ">
552+
553+ < p > Externally sets the coefficient array. This is useful when the actually running filter is at a different place as where the updating filter is employed. </ p >
554+ < dl class ="params "> < dt > Parameters</ dt > < dd >
555+ < table class ="params ">
556+ < tr > < td class ="paramname "> coeff_data</ td > < td > New coefficients to set. </ td > </ tr >
557+ < tr > < td class ="paramname "> number_of_taps</ td > < td > Number of taps in the coefficient array. If this is not equal to the number of taps used in this filter, a runtime error is thrown. </ td > </ tr >
558+ </ table >
559+ </ dd >
560+ </ dl >
561+
512562</ div >
513563</ div >
514564< a id ="ae974af5d0263423334fe9ad916a666a2 "> </ a >
@@ -567,9 +617,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#add6c80346d4fec6e9a270df5
567617</ div > <!-- contents -->
568618<!-- start footer part -->
569619< hr class ="footer "/> < address class ="footer "> < small >
570- Generated on Thu Sep 23 2021 22:45:58 for fir1 by  < a href ="http://www.doxygen.org/index.html ">
571- < img class ="footer " src ="doxygen.png " alt ="doxygen "/>
572- </ a > 1.8.17
620+ Generated on Mon Apr 15 2024 14:38:19 for fir1 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
573621</ small > </ address >
574622</ body >
575623</ html >
0 commit comments