classcore_1_1DetectionSequence.html 15 KB

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