classutil_1_1Visualizer.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  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: util::Visualizer 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>util</b></li><li class="navelem"><a class="el" href="classutil_1_1Visualizer.html">Visualizer</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="classutil_1_1Visualizer-members.html">List of all members</a> </div>
  91. <div class="headertitle">
  92. <div class="title">util::Visualizer Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="Visualizer_8h_source.html">Visualizer.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:a5168d3347dd28217a0e9bb6541fa38f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Visualizer.html#a5168d3347dd28217a0e9bb6541fa38f3">Display</a> (std::vector&lt; core::TrackletPtr &gt; &amp;tracks, size_t frame_offset, std::string image_folder, bool output, std::string output_path, std::string title=&quot;Visualizer&quot;, size_t first_frame=0, int play_fps=24, bool show_grid=false, int grid_width=0, int grid_height=0)</td></tr>
  100. <tr class="separator:a5168d3347dd28217a0e9bb6541fa38f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table>
  102. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  103. <div class="textblock"><p>Utility class for visualizing detection sequences or tracks. </p>
  104. </div><h2 class="groupheader">Member Function Documentation</h2>
  105. <a class="anchor" id="a5168d3347dd28217a0e9bb6541fa38f3"></a>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname">void util::Visualizer::Display </td>
  111. <td>(</td>
  112. <td class="paramtype">std::vector&lt; core::TrackletPtr &gt; &amp;&#160;</td>
  113. <td class="paramname"><em>tracks</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="paramkey"></td>
  117. <td></td>
  118. <td class="paramtype">size_t&#160;</td>
  119. <td class="paramname"><em>frame_offset</em>, </td>
  120. </tr>
  121. <tr>
  122. <td class="paramkey"></td>
  123. <td></td>
  124. <td class="paramtype">std::string&#160;</td>
  125. <td class="paramname"><em>image_folder</em>, </td>
  126. </tr>
  127. <tr>
  128. <td class="paramkey"></td>
  129. <td></td>
  130. <td class="paramtype">bool&#160;</td>
  131. <td class="paramname"><em>output</em>, </td>
  132. </tr>
  133. <tr>
  134. <td class="paramkey"></td>
  135. <td></td>
  136. <td class="paramtype">std::string&#160;</td>
  137. <td class="paramname"><em>output_path</em>, </td>
  138. </tr>
  139. <tr>
  140. <td class="paramkey"></td>
  141. <td></td>
  142. <td class="paramtype">std::string&#160;</td>
  143. <td class="paramname"><em>title</em> = <code>&quot;Visualizer&quot;</code>, </td>
  144. </tr>
  145. <tr>
  146. <td class="paramkey"></td>
  147. <td></td>
  148. <td class="paramtype">size_t&#160;</td>
  149. <td class="paramname"><em>first_frame</em> = <code>0</code>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">int&#160;</td>
  155. <td class="paramname"><em>play_fps</em> = <code>24</code>, </td>
  156. </tr>
  157. <tr>
  158. <td class="paramkey"></td>
  159. <td></td>
  160. <td class="paramtype">bool&#160;</td>
  161. <td class="paramname"><em>show_grid</em> = <code>false</code>, </td>
  162. </tr>
  163. <tr>
  164. <td class="paramkey"></td>
  165. <td></td>
  166. <td class="paramtype">int&#160;</td>
  167. <td class="paramname"><em>grid_width</em> = <code>0</code>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">int&#160;</td>
  173. <td class="paramname"><em>grid_height</em> = <code>0</code>&#160;</td>
  174. </tr>
  175. <tr>
  176. <td></td>
  177. <td>)</td>
  178. <td></td><td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Displays the given tracks in an window. Use D for next frame, A for previous frame, F to toggle auto play and ESC to exit. If a grid size greater zero is specified a grid will be drawn.</p>
  183. <dl class="params"><dt>Parameters</dt><dd>
  184. <table class="params">
  185. <tr><td class="paramname">tracks</td><td>The tracks to display </td></tr>
  186. <tr><td class="paramname">frame_offset</td><td>The offset of the first frame </td></tr>
  187. <tr><td class="paramname">image_folder</td><td>The images to use </td></tr>
  188. <tr><td class="paramname">output</td><td>If the frames with the visualized tracks should be stored </td></tr>
  189. <tr><td class="paramname">output_path</td><td>The path to store the images into (will need an images folder) </td></tr>
  190. <tr><td class="paramname">title</td><td>The window title </td></tr>
  191. <tr><td class="paramname">first_frame</td><td>The frame to start at </td></tr>
  192. <tr><td class="paramname">play_fps</td><td>The FPS to use when auto play is activated </td></tr>
  193. <tr><td class="paramname">show_grid</td><td>If a grid should be shown </td></tr>
  194. <tr><td class="paramname">grid_width</td><td>The number of cells in a row </td></tr>
  195. <tr><td class="paramname">grid_height</td><td>The number of cells in a column </td></tr>
  196. </table>
  197. </dd>
  198. </dl>
  199. </div>
  200. </div>
  201. <hr/>The documentation for this class was generated from the following files:<ul>
  202. <li>util/<a class="el" href="Visualizer_8h_source.html">Visualizer.h</a></li>
  203. <li>util/Visualizer.cpp</li>
  204. </ul>
  205. </div><!-- contents -->
  206. <!-- start footer part -->
  207. <hr class="footer"/><address class="footer"><small>
  208. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  209. <img class="footer" src="doxygen.png" alt="doxygen"/>
  210. </a> 1.8.12
  211. </small></address>
  212. </body>
  213. </html>