st-mems-ispu/docs/structispu__fir__decimate__instance__f32.html at master · STMicroelectronics/st-mems-ispu · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ISPU DSP: ispu_fir_decimate_instance_f32 Struct Reference</title>
<link rel="icon" href="ST_icon.svg" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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>
<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 id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="ST_logo.svg" height="55px"/></td>
  <td id="projectalign">
   <div id="projectname">ISPU DSP
   </div>
   <div id="projectbrief">ISPU DSP library for IIS3DWB10IS device</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(function(){initNavTree('structispu__fir__decimate__instance__f32.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">ispu_fir_decimate_instance_f32 Struct Reference<div class="ingroups"><a class="el" href="group__filtering.html">Filtering</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Floating-point FIR decimator instance structure.
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ispu__dsp_8h_source.html">ispu_dsp.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a0894d6680f9391efc3ff82850284fb32" id="r_a0894d6680f9391efc3ff82850284fb32"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0894d6680f9391efc3ff82850284fb32">dec</a></td></tr>
<tr class="memitem:ae216e09ee994f28909ef2f0855748cb4" id="r_ae216e09ee994f28909ef2f0855748cb4"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae216e09ee994f28909ef2f0855748cb4">num_taps</a></td></tr>
<tr class="memitem:abb8ee22651219a91339be81f366a1945" id="r_abb8ee22651219a91339be81f366a1945"><td class="memItemLeft" align="right" valign="top">float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb8ee22651219a91339be81f366a1945">state</a></td></tr>
<tr class="memitem:af3959c35b1b74aef15ef85c8f72a51ae" id="r_af3959c35b1b74aef15ef85c8f72a51ae"><td class="memItemLeft" align="right" valign="top">const float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af3959c35b1b74aef15ef85c8f72a51ae">coeffs</a></td></tr>
<tr class="memitem:adce4775f06d72ec0be71f725335a0a18" id="r_adce4775f06d72ec0be71f725335a0a18"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adce4775f06d72ec0be71f725335a0a18">impl</a> )(const struct <a class="el" href="structispu__fir__decimate__instance__f32.html">ispu_fir_decimate_instance_f32</a> *inst, const float *src, float *dst, uint32_t block_size)</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Floating-point FIR decimator instance structure. </p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a0894d6680f9391efc3ff82850284fb32" name="a0894d6680f9391efc3ff82850284fb32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0894d6680f9391efc3ff82850284fb32">&#9670;&#160;</a></span>dec</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ispu_fir_decimate_instance_f32::dec</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Decimation factor (must be an integer divisor of block_size). </p>

</div>
</div>
<a id="ae216e09ee994f28909ef2f0855748cb4" name="ae216e09ee994f28909ef2f0855748cb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae216e09ee994f28909ef2f0855748cb4">&#9670;&#160;</a></span>num_taps</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t ispu_fir_decimate_instance_f32::num_taps</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Number of taps/coefficients. </p>

</div>
</div>
<a id="abb8ee22651219a91339be81f366a1945" name="abb8ee22651219a91339be81f366a1945"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb8ee22651219a91339be81f366a1945">&#9670;&#160;</a></span>state</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float* ispu_fir_decimate_instance_f32::state</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Pointer to the state array (length must be num_taps + block_size - 1). </p>

</div>
</div>
<a id="af3959c35b1b74aef15ef85c8f72a51ae" name="af3959c35b1b74aef15ef85c8f72a51ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3959c35b1b74aef15ef85c8f72a51ae">&#9670;&#160;</a></span>coeffs</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const float* ispu_fir_decimate_instance_f32::coeffs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Pointer to the coefficients array (length must be num_taps). </p>

</div>
</div>
<a id="adce4775f06d72ec0be71f725335a0a18" name="adce4775f06d72ec0be71f725335a0a18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adce4775f06d72ec0be71f725335a0a18">&#9670;&#160;</a></span>impl</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* ispu_fir_decimate_instance_f32::impl) (const struct <a class="el" href="structispu__fir__decimate__instance__f32.html">ispu_fir_decimate_instance_f32</a> *inst, const float *src, float *dst, uint32_t block_size)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Pointer to the implementation function. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>inc/<a class="el" href="ispu__dsp_8h_source.html">ispu_dsp.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="structispu__fir__decimate__instance__f32.html">ispu_fir_decimate_instance_f32</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
  </ul>
</div>
</body>
</html>