classcore_1_1DetectionSequence.tex 8.6 KB

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