-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassifm3d_1_1Frame.html
269 lines (254 loc) · 15.5 KB
/
classifm3d_1_1Frame.html
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ifm3d: ifm3d::Frame Class Reference</title>
<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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ifm3d
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classifm3d_1_1Frame.html',''); initResizable(); });
/* @license-end */
</script>
<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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classifm3d_1_1Frame-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ifm3d::Frame Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="frame_8h_source.html">frame.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a5760e78edff8824b6c34d00d436fc943"><td class="memItemLeft" align="right" valign="top"><a id="a5760e78edff8824b6c34d00d436fc943"></a>
using </td><td class="memItemRight" valign="bottom"><b>Ptr</b> = std::shared_ptr< <a class="el" href="classifm3d_1_1Frame.html">Frame</a> ></td></tr>
<tr class="separator:a5760e78edff8824b6c34d00d436fc943"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aeed8378702c490cace185950792e5007"><td class="memItemLeft" align="right" valign="top"><a id="aeed8378702c490cace185950792e5007"></a>
 </td><td class="memItemRight" valign="bottom"><b>Frame</b> (const std::map< buffer_id, <a class="el" href="classifm3d_1_1Buffer.html">Buffer</a> > &images, const std::vector< TimePointT > timestamps)</td></tr>
<tr class="separator:aeed8378702c490cace185950792e5007"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17377a20079de03dbfd53ef1d49034a2"><td class="memItemLeft" align="right" valign="top"><a id="a17377a20079de03dbfd53ef1d49034a2"></a>
 </td><td class="memItemRight" valign="bottom"><b>Frame</b> (const <a class="el" href="classifm3d_1_1Frame.html">Frame</a> &t)</td></tr>
<tr class="separator:a17377a20079de03dbfd53ef1d49034a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add956b9f533e4945693ef20d54a8d8ae"><td class="memItemLeft" align="right" valign="top"><a id="add956b9f533e4945693ef20d54a8d8ae"></a>
<a class="el" href="classifm3d_1_1Frame.html">Frame</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classifm3d_1_1Frame.html">Frame</a> &t)</td></tr>
<tr class="separator:add956b9f533e4945693ef20d54a8d8ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a470c77b50a3d91a6184601675930aa6d"><td class="memItemLeft" align="right" valign="top"><a id="a470c77b50a3d91a6184601675930aa6d"></a>
 </td><td class="memItemRight" valign="bottom"><b>Frame</b> (<a class="el" href="classifm3d_1_1Frame.html">Frame</a> &&t)</td></tr>
<tr class="separator:a470c77b50a3d91a6184601675930aa6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ec694226f11a764ed241eb2e876fd4e"><td class="memItemLeft" align="right" valign="top"><a id="a0ec694226f11a764ed241eb2e876fd4e"></a>
<a class="el" href="classifm3d_1_1Frame.html">Frame</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classifm3d_1_1Frame.html">Frame</a> &&t)</td></tr>
<tr class="separator:a0ec694226f11a764ed241eb2e876fd4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6501c61f1d9b47003cbac1119477e6e"><td class="memItemLeft" align="right" valign="top">std::vector< TimePointT > </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1Frame.html#af6501c61f1d9b47003cbac1119477e6e">TimeStamps</a> ()</td></tr>
<tr class="memdesc:af6501c61f1d9b47003cbac1119477e6e"><td class="mdescLeft"> </td><td class="mdescRight">Get the timestamps of the frame. <a href="classifm3d_1_1Frame.html#af6501c61f1d9b47003cbac1119477e6e">More...</a><br /></td></tr>
<tr class="separator:af6501c61f1d9b47003cbac1119477e6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13e840f03bc27a443be8ac1e44cefa90"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1Frame.html#a13e840f03bc27a443be8ac1e44cefa90">HasBuffer</a> (buffer_id id)</td></tr>
<tr class="memdesc:a13e840f03bc27a443be8ac1e44cefa90"><td class="mdescLeft"> </td><td class="mdescRight">Check if a image with the given id is available in this frame. <a href="classifm3d_1_1Frame.html#a13e840f03bc27a443be8ac1e44cefa90">More...</a><br /></td></tr>
<tr class="separator:a13e840f03bc27a443be8ac1e44cefa90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4514940165e6a990c82bd4554da05f0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classifm3d_1_1Buffer.html">Buffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1Frame.html#a4514940165e6a990c82bd4554da05f0b">GetBuffer</a> (buffer_id id)</td></tr>
<tr class="memdesc:a4514940165e6a990c82bd4554da05f0b"><td class="mdescLeft"> </td><td class="mdescRight">Get the image with the given id. <a href="classifm3d_1_1Frame.html#a4514940165e6a990c82bd4554da05f0b">More...</a><br /></td></tr>
<tr class="separator:a4514940165e6a990c82bd4554da05f0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d26762e4adcbf7bb61a445b435623af"><td class="memItemLeft" align="right" valign="top">std::vector< buffer_id > </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1Frame.html#a4d26762e4adcbf7bb61a445b435623af">GetBuffers</a> ()</td></tr>
<tr class="memdesc:a4d26762e4adcbf7bb61a445b435623af"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of available buffers. <a href="classifm3d_1_1Frame.html#a4d26762e4adcbf7bb61a445b435623af">More...</a><br /></td></tr>
<tr class="separator:a4d26762e4adcbf7bb61a445b435623af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39a555b9c37524e117eb06a421e15c5e"><td class="memItemLeft" align="right" valign="top"><a id="a39a555b9c37524e117eb06a421e15c5e"></a>
decltype(std::declval< std::map< buffer_id, <a class="el" href="classifm3d_1_1Buffer.html">Buffer</a> >>().begin()) </td><td class="memItemRight" valign="bottom"><b>begin</b> () noexcept</td></tr>
<tr class="separator:a39a555b9c37524e117eb06a421e15c5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0761ead4d43f013b22f4665ce7225a90"><td class="memItemLeft" align="right" valign="top"><a id="a0761ead4d43f013b22f4665ce7225a90"></a>
decltype(std::declval< const std::map< buffer_id, <a class="el" href="classifm3d_1_1Buffer.html">Buffer</a> >>().begin()) </td><td class="memItemRight" valign="bottom"><b>begin</b> () const noexcept</td></tr>
<tr class="separator:a0761ead4d43f013b22f4665ce7225a90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a4265107e9a61010a1c4486db3ab344"><td class="memItemLeft" align="right" valign="top"><a id="a5a4265107e9a61010a1c4486db3ab344"></a>
decltype(std::declval< std::map< buffer_id, <a class="el" href="classifm3d_1_1Buffer.html">Buffer</a> >>().end()) </td><td class="memItemRight" valign="bottom"><b>end</b> () noexcept</td></tr>
<tr class="separator:a5a4265107e9a61010a1c4486db3ab344"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77b932062af65df75ca8161eae857a88"><td class="memItemLeft" align="right" valign="top"><a id="a77b932062af65df75ca8161eae857a88"></a>
decltype(std::declval< const std::map< buffer_id, <a class="el" href="classifm3d_1_1Buffer.html">Buffer</a> >>().end()) </td><td class="memItemRight" valign="bottom"><b>end</b> () const noexcept</td></tr>
<tr class="separator:a77b932062af65df75ca8161eae857a88"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represent a frame of data received from the the device. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4514940165e6a990c82bd4554da05f0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4514940165e6a990c82bd4554da05f0b">◆ </a></span>GetBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classifm3d_1_1Buffer.html">Buffer</a>& ifm3d::Frame::GetBuffer </td>
<td>(</td>
<td class="paramtype">buffer_id </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the image with the given id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>the id of the image to get </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Image& Reference to the requested buffer </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::out_of_range</td><td>if no image with the give id exists </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4d26762e4adcbf7bb61a445b435623af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d26762e4adcbf7bb61a445b435623af">◆ </a></span>GetBuffers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<buffer_id> ifm3d::Frame::GetBuffers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of available buffers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>the id of the image to get </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the list of available buffer_ids </dd></dl>
</div>
</div>
<a id="a13e840f03bc27a443be8ac1e44cefa90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13e840f03bc27a443be8ac1e44cefa90">◆ </a></span>HasBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ifm3d::Frame::HasBuffer </td>
<td>(</td>
<td class="paramtype">buffer_id </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a image with the given id is available in this frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>the id of the image </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if a image with the give id is available </dd>
<dd>
false if no image with the given id is availale </dd></dl>
</div>
</div>
<a id="af6501c61f1d9b47003cbac1119477e6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6501c61f1d9b47003cbac1119477e6e">◆ </a></span>TimeStamps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<TimePointT> ifm3d::Frame::TimeStamps </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the timestamps of the frame. </p>
<dl class="section return"><dt>Returns</dt><dd>the timestamps </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/host/dev/ifm3d/modules/framegrabber/include/ifm3d/fg/<a class="el" href="frame_8h_source.html">frame.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>ifm3d</b></li><li class="navelem"><a class="el" href="classifm3d_1_1Frame.html">Frame</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.9.1 </li>
</ul>
</div>
</body>
</html>