classcore_1_1DetectionSequence.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  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.12"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Tracore: core::DetectionSequence Class 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. <script type="text/javascript">
  16. $(document).ready(function() { init_search(); });
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">Tracore
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.12 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><b>core</b></li><li class="navelem"><a class="el" href="classcore_1_1DetectionSequence.html">DetectionSequence</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="#friends">Friends</a> &#124;
  91. <a href="classcore_1_1DetectionSequence-members.html">List of all members</a> </div>
  92. <div class="headertitle">
  93. <div class="title">core::DetectionSequence Class Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p><code>#include &lt;<a class="el" href="DetectionSequence_8h_source.html">DetectionSequence.h</a>&gt;</code></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr class="memitem:aed2967a51334c7b3e9053f2ab0f9990e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#aed2967a51334c7b3e9053f2ab0f9990e">DetectionSequence</a> (std::string const &amp;name=&quot;DetectionSequence&quot;)</td></tr>
  101. <tr class="separator:aed2967a51334c7b3e9053f2ab0f9990e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a3cc0fdf3281f34985f4762086293db72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#a3cc0fdf3281f34985f4762086293db72">AddObject</a> (ObjectDataPtr object_data)</td></tr>
  103. <tr class="separator:a3cc0fdf3281f34985f4762086293db72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ab62569a3e51d58457057deba12ef6892"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#ab62569a3e51d58457057deba12ef6892">Clear</a> ()</td></tr>
  105. <tr class="separator:ab62569a3e51d58457057deba12ef6892"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a8a1af3dee89766d06f4a4f74044082ad"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#a8a1af3dee89766d06f4a4f74044082ad">GetName</a> () const</td></tr>
  107. <tr class="separator:a8a1af3dee89766d06f4a4f74044082ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a1faac919948e8b10d9112916f3a19bd0"><td class="memItemLeft" align="right" valign="top">ObjectDataPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#a1faac919948e8b10d9112916f3a19bd0">GetObject</a> (size_t frame_index, size_t object_index)</td></tr>
  109. <tr class="separator:a1faac919948e8b10d9112916f3a19bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a2417e4f2652a39245d6f2faa0ce19571"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#a2417e4f2652a39245d6f2faa0ce19571">GetFrameCount</a> () const</td></tr>
  111. <tr class="separator:a2417e4f2652a39245d6f2faa0ce19571"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a2c469219ac4f55aa9deacb5f63195de1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#a2c469219ac4f55aa9deacb5f63195de1">GetFrameOffset</a> () const</td></tr>
  113. <tr class="separator:a2c469219ac4f55aa9deacb5f63195de1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ad6c77b1224bf5b149b78b60cc62d5564"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#ad6c77b1224bf5b149b78b60cc62d5564">GetObjectCount</a> (size_t frame_index)</td></tr>
  115. <tr class="separator:ad6c77b1224bf5b149b78b60cc62d5564"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table><table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  118. Friends</h2></td></tr>
  119. <tr class="memitem:abc61c6378276573bcb84464d9f0b9e24"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1DetectionSequence.html#abc61c6378276573bcb84464d9f0b9e24">operator&lt;&lt;</a> (std::ostream &amp;os, <a class="el" href="classcore_1_1DetectionSequence.html">DetectionSequence</a> const &amp;obj)</td></tr>
  120. <tr class="separator:abc61c6378276573bcb84464d9f0b9e24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  123. <div class="textblock"><p>Class for storing a full sequence of frame, each with multiple detected objects. </p>
  124. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  125. <a class="anchor" id="aed2967a51334c7b3e9053f2ab0f9990e"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">core::DetectionSequence::DetectionSequence </td>
  131. <td>(</td>
  132. <td class="paramtype">std::string const &amp;&#160;</td>
  133. <td class="paramname"><em>name</em> = <code>&quot;DetectionSequence&quot;</code></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>Creates a detection sequence with the given name.</p>
  139. <dl class="params"><dt>Parameters</dt><dd>
  140. <table class="params">
  141. <tr><td class="paramname">name</td><td>The name of this sequence </td></tr>
  142. </table>
  143. </dd>
  144. </dl>
  145. </div>
  146. </div>
  147. <h2 class="groupheader">Member Function Documentation</h2>
  148. <a class="anchor" id="a3cc0fdf3281f34985f4762086293db72"></a>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">void core::DetectionSequence::AddObject </td>
  154. <td>(</td>
  155. <td class="paramtype">ObjectDataPtr&#160;</td>
  156. <td class="paramname"><em>object_data</em></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Adds a new object, creates a new frame vector if the given objects frame index is greater than the current frame vector size.</p>
  162. <dl class="params"><dt>Parameters</dt><dd>
  163. <table class="params">
  164. <tr><td class="paramname">object_data</td><td>The object to add </td></tr>
  165. </table>
  166. </dd>
  167. </dl>
  168. </div>
  169. </div>
  170. <a class="anchor" id="ab62569a3e51d58457057deba12ef6892"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void core::DetectionSequence::Clear </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Removes all objects. </p>
  183. </div>
  184. </div>
  185. <a class="anchor" id="a2417e4f2652a39245d6f2faa0ce19571"></a>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">size_t core::DetectionSequence::GetFrameCount </td>
  191. <td>(</td>
  192. <td class="paramname"></td><td>)</td>
  193. <td> const</td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Gets the frame count.</p>
  198. <dl class="section return"><dt>Returns</dt><dd>The frame count </dd></dl>
  199. </div>
  200. </div>
  201. <a class="anchor" id="a2c469219ac4f55aa9deacb5f63195de1"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">size_t core::DetectionSequence::GetFrameOffset </td>
  207. <td>(</td>
  208. <td class="paramname"></td><td>)</td>
  209. <td> const</td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Gets the frame offset.</p>
  214. <dl class="section return"><dt>Returns</dt><dd>The Frame offset </dd></dl>
  215. </div>
  216. </div>
  217. <a class="anchor" id="a8a1af3dee89766d06f4a4f74044082ad"></a>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">std::string core::DetectionSequence::GetName </td>
  223. <td>(</td>
  224. <td class="paramname"></td><td>)</td>
  225. <td> const</td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>Gets the name of this sequence.</p>
  230. <dl class="section return"><dt>Returns</dt><dd>The name </dd></dl>
  231. </div>
  232. </div>
  233. <a class="anchor" id="a1faac919948e8b10d9112916f3a19bd0"></a>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">ObjectDataPtr core::DetectionSequence::GetObject </td>
  239. <td>(</td>
  240. <td class="paramtype">size_t&#160;</td>
  241. <td class="paramname"><em>frame_index</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">size_t&#160;</td>
  247. <td class="paramname"><em>object_index</em>&#160;</td>
  248. </tr>
  249. <tr>
  250. <td></td>
  251. <td>)</td>
  252. <td></td><td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Gets a pointer to the object in the given frame with the given index.</p>
  257. <dl class="params"><dt>Parameters</dt><dd>
  258. <table class="params">
  259. <tr><td class="paramname">frame_index</td><td>The frame to get the object from </td></tr>
  260. <tr><td class="paramname">object_index</td><td>The objects index in the corresponding frame </td></tr>
  261. </table>
  262. </dd>
  263. </dl>
  264. <dl class="section return"><dt>Returns</dt><dd>A pointer to the stored object data </dd></dl>
  265. </div>
  266. </div>
  267. <a class="anchor" id="ad6c77b1224bf5b149b78b60cc62d5564"></a>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">size_t core::DetectionSequence::GetObjectCount </td>
  273. <td>(</td>
  274. <td class="paramtype">size_t&#160;</td>
  275. <td class="paramname"><em>frame_index</em></td><td>)</td>
  276. <td></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>Gets the object count in the given frame.</p>
  281. <dl class="params"><dt>Parameters</dt><dd>
  282. <table class="params">
  283. <tr><td class="paramname">frame_index</td><td>The frame to get the object count of </td></tr>
  284. </table>
  285. </dd>
  286. </dl>
  287. <dl class="section return"><dt>Returns</dt><dd>The number of objects in this frame </dd></dl>
  288. </div>
  289. </div>
  290. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  291. <a class="anchor" id="abc61c6378276573bcb84464d9f0b9e24"></a>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">std::ostream&amp; operator&lt;&lt; </td>
  300. <td>(</td>
  301. <td class="paramtype">std::ostream &amp;&#160;</td>
  302. <td class="paramname"><em>os</em>, </td>
  303. </tr>
  304. <tr>
  305. <td class="paramkey"></td>
  306. <td></td>
  307. <td class="paramtype"><a class="el" href="classcore_1_1DetectionSequence.html">DetectionSequence</a> const &amp;&#160;</td>
  308. <td class="paramname"><em>obj</em>&#160;</td>
  309. </tr>
  310. <tr>
  311. <td></td>
  312. <td>)</td>
  313. <td></td><td></td>
  314. </tr>
  315. </table>
  316. </td>
  317. <td class="mlabels-right">
  318. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. <p>Overrides the &lt;&lt; operator for easy output.</p>
  323. <dl class="params"><dt>Parameters</dt><dd>
  324. <table class="params">
  325. <tr><td class="paramname">os</td><td>The stream to write to </td></tr>
  326. <tr><td class="paramname">obj</td><td>The object to write into the stream </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section return"><dt>Returns</dt><dd>The stream written to </dd></dl>
  331. </div>
  332. </div>
  333. <hr/>The documentation for this class was generated from the following files:<ul>
  334. <li>core/<a class="el" href="DetectionSequence_8h_source.html">DetectionSequence.h</a></li>
  335. <li>core/DetectionSequence.cpp</li>
  336. </ul>
  337. </div><!-- contents -->
  338. <!-- start footer part -->
  339. <hr class="footer"/><address class="footer"><small>
  340. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  341. <img class="footer" src="doxygen.png" alt="doxygen"/>
  342. </a> 1.8.12
  343. </small></address>
  344. </body>
  345. </html>