classcore_1_1DetectionSequence.tex 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. \hypertarget{classcore_1_1DetectionSequence}{}\section{core\+:\+:Detection\+Sequence Class Reference}
  2. \label{classcore_1_1DetectionSequence}\index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  3. {\ttfamily \#include $<$Detection\+Sequence.\+h$>$}
  4. \subsection*{Public Member Functions}
  5. \begin{DoxyCompactItemize}
  6. \item
  7. \hyperlink{classcore_1_1DetectionSequence_aed2967a51334c7b3e9053f2ab0f9990e}{Detection\+Sequence} (std\+::string const \&name=\char`\"{}Detection\+Sequence\char`\"{})
  8. \item
  9. void \hyperlink{classcore_1_1DetectionSequence_a3cc0fdf3281f34985f4762086293db72}{Add\+Object} (Object\+Data\+Ptr object\+\_\+data)
  10. \item
  11. void \hyperlink{classcore_1_1DetectionSequence_ab62569a3e51d58457057deba12ef6892}{Clear} ()
  12. \item
  13. std\+::string \hyperlink{classcore_1_1DetectionSequence_a8a1af3dee89766d06f4a4f74044082ad}{Get\+Name} () const
  14. \item
  15. Object\+Data\+Ptr \hyperlink{classcore_1_1DetectionSequence_a1faac919948e8b10d9112916f3a19bd0}{Get\+Object} (size\+\_\+t frame\+\_\+index, size\+\_\+t object\+\_\+index)
  16. \item
  17. size\+\_\+t \hyperlink{classcore_1_1DetectionSequence_a2417e4f2652a39245d6f2faa0ce19571}{Get\+Frame\+Count} () const
  18. \item
  19. size\+\_\+t \hyperlink{classcore_1_1DetectionSequence_a2c469219ac4f55aa9deacb5f63195de1}{Get\+Frame\+Offset} () const
  20. \item
  21. size\+\_\+t \hyperlink{classcore_1_1DetectionSequence_ad6c77b1224bf5b149b78b60cc62d5564}{Get\+Object\+Count} (size\+\_\+t frame\+\_\+index)
  22. \end{DoxyCompactItemize}
  23. \subsection*{Friends}
  24. \begin{DoxyCompactItemize}
  25. \item
  26. std\+::ostream \& \hyperlink{classcore_1_1DetectionSequence_abc61c6378276573bcb84464d9f0b9e24}{operator$<$$<$} (std\+::ostream \&os, \hyperlink{classcore_1_1DetectionSequence}{Detection\+Sequence} const \&obj)
  27. \end{DoxyCompactItemize}
  28. \subsection{Detailed Description}
  29. Class for storing a full sequence of frame, each with multiple detected objects.
  30. \subsection{Constructor \& Destructor Documentation}
  31. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Detection\+Sequence@{Detection\+Sequence}}
  32. \index{Detection\+Sequence@{Detection\+Sequence}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  33. \subsubsection[{\texorpdfstring{Detection\+Sequence(std\+::string const \&name=""Detection\+Sequence"")}{DetectionSequence(std::string const \&name="DetectionSequence")}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Detection\+Sequence\+::\+Detection\+Sequence (
  34. \begin{DoxyParamCaption}
  35. \item[{std\+::string const \&}]{name = {\ttfamily \char`\"{}DetectionSequence\char`\"{}}}
  36. \end{DoxyParamCaption}
  37. )}\hypertarget{classcore_1_1DetectionSequence_aed2967a51334c7b3e9053f2ab0f9990e}{}\label{classcore_1_1DetectionSequence_aed2967a51334c7b3e9053f2ab0f9990e}
  38. Creates a detection sequence with the given name.
  39. \begin{DoxyParams}{Parameters}
  40. {\em name} & The name of this sequence \\
  41. \hline
  42. \end{DoxyParams}
  43. \subsection{Member Function Documentation}
  44. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Add\+Object@{Add\+Object}}
  45. \index{Add\+Object@{Add\+Object}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  46. \subsubsection[{\texorpdfstring{Add\+Object(\+Object\+Data\+Ptr object\+\_\+data)}{AddObject(ObjectDataPtr object\_data)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Detection\+Sequence\+::\+Add\+Object (
  47. \begin{DoxyParamCaption}
  48. \item[{Object\+Data\+Ptr}]{object\+\_\+data}
  49. \end{DoxyParamCaption}
  50. )}\hypertarget{classcore_1_1DetectionSequence_a3cc0fdf3281f34985f4762086293db72}{}\label{classcore_1_1DetectionSequence_a3cc0fdf3281f34985f4762086293db72}
  51. Adds a new object, creates a new frame vector if the given objects frame index is greater than the current frame vector size.
  52. \begin{DoxyParams}{Parameters}
  53. {\em object\+\_\+data} & The object to add \\
  54. \hline
  55. \end{DoxyParams}
  56. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Clear@{Clear}}
  57. \index{Clear@{Clear}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  58. \subsubsection[{\texorpdfstring{Clear()}{Clear()}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Detection\+Sequence\+::\+Clear (
  59. \begin{DoxyParamCaption}
  60. {}
  61. \end{DoxyParamCaption}
  62. )}\hypertarget{classcore_1_1DetectionSequence_ab62569a3e51d58457057deba12ef6892}{}\label{classcore_1_1DetectionSequence_ab62569a3e51d58457057deba12ef6892}
  63. Removes all objects. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Get\+Frame\+Count@{Get\+Frame\+Count}}
  64. \index{Get\+Frame\+Count@{Get\+Frame\+Count}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  65. \subsubsection[{\texorpdfstring{Get\+Frame\+Count() const}{GetFrameCount() const}}]{\setlength{\rightskip}{0pt plus 5cm}size\+\_\+t core\+::\+Detection\+Sequence\+::\+Get\+Frame\+Count (
  66. \begin{DoxyParamCaption}
  67. {}
  68. \end{DoxyParamCaption}
  69. ) const}\hypertarget{classcore_1_1DetectionSequence_a2417e4f2652a39245d6f2faa0ce19571}{}\label{classcore_1_1DetectionSequence_a2417e4f2652a39245d6f2faa0ce19571}
  70. Gets the frame count.
  71. \begin{DoxyReturn}{Returns}
  72. The frame count
  73. \end{DoxyReturn}
  74. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Get\+Frame\+Offset@{Get\+Frame\+Offset}}
  75. \index{Get\+Frame\+Offset@{Get\+Frame\+Offset}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  76. \subsubsection[{\texorpdfstring{Get\+Frame\+Offset() const}{GetFrameOffset() const}}]{\setlength{\rightskip}{0pt plus 5cm}size\+\_\+t core\+::\+Detection\+Sequence\+::\+Get\+Frame\+Offset (
  77. \begin{DoxyParamCaption}
  78. {}
  79. \end{DoxyParamCaption}
  80. ) const}\hypertarget{classcore_1_1DetectionSequence_a2c469219ac4f55aa9deacb5f63195de1}{}\label{classcore_1_1DetectionSequence_a2c469219ac4f55aa9deacb5f63195de1}
  81. Gets the frame offset.
  82. \begin{DoxyReturn}{Returns}
  83. The Frame offset
  84. \end{DoxyReturn}
  85. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Get\+Name@{Get\+Name}}
  86. \index{Get\+Name@{Get\+Name}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  87. \subsubsection[{\texorpdfstring{Get\+Name() const}{GetName() const}}]{\setlength{\rightskip}{0pt plus 5cm}std\+::string core\+::\+Detection\+Sequence\+::\+Get\+Name (
  88. \begin{DoxyParamCaption}
  89. {}
  90. \end{DoxyParamCaption}
  91. ) const}\hypertarget{classcore_1_1DetectionSequence_a8a1af3dee89766d06f4a4f74044082ad}{}\label{classcore_1_1DetectionSequence_a8a1af3dee89766d06f4a4f74044082ad}
  92. Gets the name of this sequence.
  93. \begin{DoxyReturn}{Returns}
  94. The name
  95. \end{DoxyReturn}
  96. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Get\+Object@{Get\+Object}}
  97. \index{Get\+Object@{Get\+Object}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  98. \subsubsection[{\texorpdfstring{Get\+Object(size\+\_\+t frame\+\_\+index, size\+\_\+t object\+\_\+index)}{GetObject(size\_t frame\_index, size\_t object\_index)}}]{\setlength{\rightskip}{0pt plus 5cm}Object\+Data\+Ptr core\+::\+Detection\+Sequence\+::\+Get\+Object (
  99. \begin{DoxyParamCaption}
  100. \item[{size\+\_\+t}]{frame\+\_\+index, }
  101. \item[{size\+\_\+t}]{object\+\_\+index}
  102. \end{DoxyParamCaption}
  103. )}\hypertarget{classcore_1_1DetectionSequence_a1faac919948e8b10d9112916f3a19bd0}{}\label{classcore_1_1DetectionSequence_a1faac919948e8b10d9112916f3a19bd0}
  104. Gets a pointer to the object in the given frame with the given index.
  105. \begin{DoxyParams}{Parameters}
  106. {\em frame\+\_\+index} & The frame to get the object from \\
  107. \hline
  108. {\em object\+\_\+index} & The objects index in the corresponding frame \\
  109. \hline
  110. \end{DoxyParams}
  111. \begin{DoxyReturn}{Returns}
  112. A pointer to the stored object data
  113. \end{DoxyReturn}
  114. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!Get\+Object\+Count@{Get\+Object\+Count}}
  115. \index{Get\+Object\+Count@{Get\+Object\+Count}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  116. \subsubsection[{\texorpdfstring{Get\+Object\+Count(size\+\_\+t frame\+\_\+index)}{GetObjectCount(size\_t frame\_index)}}]{\setlength{\rightskip}{0pt plus 5cm}size\+\_\+t core\+::\+Detection\+Sequence\+::\+Get\+Object\+Count (
  117. \begin{DoxyParamCaption}
  118. \item[{size\+\_\+t}]{frame\+\_\+index}
  119. \end{DoxyParamCaption}
  120. )}\hypertarget{classcore_1_1DetectionSequence_ad6c77b1224bf5b149b78b60cc62d5564}{}\label{classcore_1_1DetectionSequence_ad6c77b1224bf5b149b78b60cc62d5564}
  121. Gets the object count in the given frame.
  122. \begin{DoxyParams}{Parameters}
  123. {\em frame\+\_\+index} & The frame to get the object count of \\
  124. \hline
  125. \end{DoxyParams}
  126. \begin{DoxyReturn}{Returns}
  127. The number of objects in this frame
  128. \end{DoxyReturn}
  129. \subsection{Friends And Related Function Documentation}
  130. \index{core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}!operator$<$$<$@{operator$<$$<$}}
  131. \index{operator$<$$<$@{operator$<$$<$}!core\+::\+Detection\+Sequence@{core\+::\+Detection\+Sequence}}
  132. \subsubsection[{\texorpdfstring{operator$<$$<$}{operator<<}}]{\setlength{\rightskip}{0pt plus 5cm}std\+::ostream\& operator$<$$<$ (
  133. \begin{DoxyParamCaption}
  134. \item[{std\+::ostream \&}]{os, }
  135. \item[{{\bf Detection\+Sequence} const \&}]{obj}
  136. \end{DoxyParamCaption}
  137. )\hspace{0.3cm}{\ttfamily [friend]}}\hypertarget{classcore_1_1DetectionSequence_abc61c6378276573bcb84464d9f0b9e24}{}\label{classcore_1_1DetectionSequence_abc61c6378276573bcb84464d9f0b9e24}
  138. Overrides the $<$$<$ operator for easy output.
  139. \begin{DoxyParams}{Parameters}
  140. {\em os} & The stream to write to \\
  141. \hline
  142. {\em obj} & The object to write into the stream \\
  143. \hline
  144. \end{DoxyParams}
  145. \begin{DoxyReturn}{Returns}
  146. The stream written to
  147. \end{DoxyReturn}
  148. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  149. \item
  150. core/Detection\+Sequence.\+h\item
  151. core/Detection\+Sequence.\+cpp\end{DoxyCompactItemize}