classcore_1_1DetectionSequence.tex 9.4 KB

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