classcore_1_1ObjectData.tex 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. \hypertarget{classcore_1_1ObjectData}{}\section{core\+:\+:Object\+Data Class Reference}
  2. \label{classcore_1_1ObjectData}\index{core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  3. {\ttfamily \#include $<$Object\+Data.\+h$>$}
  4. Inheritance diagram for core\+:\+:Object\+Data\+:\begin{figure}[H]
  5. \begin{center}
  6. \leavevmode
  7. \includegraphics[height=2.000000cm]{classcore_1_1ObjectData}
  8. \end{center}
  9. \end{figure}
  10. \subsection*{Public Member Functions}
  11. \begin{DoxyCompactItemize}
  12. \item
  13. \hyperlink{classcore_1_1ObjectData_a7f47a396a3b9e8c12a1557c8156b8ff9}{Object\+Data} ()
  14. \item
  15. \hyperlink{classcore_1_1ObjectData_af4333a52b012841a6ba73b25aeaae71b}{Object\+Data} (std\+::size\+\_\+t frame\+\_\+index)
  16. \item
  17. std\+::size\+\_\+t \hyperlink{classcore_1_1ObjectData_a1151e9215baf315f4b98f696f4271162}{Get\+Frame\+Index} () const
  18. \item
  19. bool \hyperlink{classcore_1_1ObjectData_a2880d710cfa520e9c0453e2a6729c0e2}{Is\+Virtual} () const
  20. \item
  21. virtual double \hyperlink{classcore_1_1ObjectData_a01f04d64b1e62f567d819a8fcbe38319}{Compare\+To} (\hyperlink{classcore_1_1ObjectData}{Object\+Data} $\ast$obj)
  22. \end{DoxyCompactItemize}
  23. \subsection*{Protected Member Functions}
  24. \begin{DoxyCompactItemize}
  25. \item
  26. virtual void \hyperlink{classcore_1_1ObjectData_aa26949b0456068d67802d9f6067aa657}{Print} (std\+::ostream \&os) const
  27. \end{DoxyCompactItemize}
  28. \subsection*{Protected Attributes}
  29. \begin{DoxyCompactItemize}
  30. \item
  31. std\+::size\+\_\+t \hyperlink{classcore_1_1ObjectData_ade1423dbad9323431d22750121fa59e5}{frame\+\_\+index\+\_\+}
  32. \end{DoxyCompactItemize}
  33. \subsection*{Friends}
  34. \begin{DoxyCompactItemize}
  35. \item
  36. std\+::ostream \& \hyperlink{classcore_1_1ObjectData_a56fc9b6184428bf4d80826bbb9fe4c6f}{operator$<$$<$} (std\+::ostream \&os, const \hyperlink{classcore_1_1ObjectData}{Object\+Data} \&obj)
  37. \end{DoxyCompactItemize}
  38. \subsection{Detailed Description}
  39. Base class for all detected objects. Stores the corresponding frame index.
  40. \subsection{Constructor \& Destructor Documentation}
  41. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Object\+Data@{Object\+Data}}
  42. \index{Object\+Data@{Object\+Data}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  43. \subsubsection[{\texorpdfstring{Object\+Data()}{ObjectData()}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data\+::\+Object\+Data (
  44. \begin{DoxyParamCaption}
  45. {}
  46. \end{DoxyParamCaption}
  47. )}\hypertarget{classcore_1_1ObjectData_a7f47a396a3b9e8c12a1557c8156b8ff9}{}\label{classcore_1_1ObjectData_a7f47a396a3b9e8c12a1557c8156b8ff9}
  48. Creates a new empty \hyperlink{classcore_1_1ObjectData}{Object\+Data} (e.\+g. for virtual objects) \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Object\+Data@{Object\+Data}}
  49. \index{Object\+Data@{Object\+Data}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  50. \subsubsection[{\texorpdfstring{Object\+Data(std\+::size\+\_\+t frame\+\_\+index)}{ObjectData(std::size\_t frame\_index)}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data\+::\+Object\+Data (
  51. \begin{DoxyParamCaption}
  52. \item[{std\+::size\+\_\+t}]{frame\+\_\+index}
  53. \end{DoxyParamCaption}
  54. )}\hypertarget{classcore_1_1ObjectData_af4333a52b012841a6ba73b25aeaae71b}{}\label{classcore_1_1ObjectData_af4333a52b012841a6ba73b25aeaae71b}
  55. Creates a new \hyperlink{classcore_1_1ObjectData}{Object\+Data} with the given frame index
  56. \begin{DoxyParams}{Parameters}
  57. {\em frame\+\_\+index} & the index in which the object was detected \\
  58. \hline
  59. \end{DoxyParams}
  60. \subsection{Member Function Documentation}
  61. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Compare\+To@{Compare\+To}}
  62. \index{Compare\+To@{Compare\+To}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  63. \subsubsection[{\texorpdfstring{Compare\+To(\+Object\+Data $\ast$obj)}{CompareTo(ObjectData *obj)}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+::\+Compare\+To (
  64. \begin{DoxyParamCaption}
  65. \item[{{\bf Object\+Data} $\ast$}]{obj}
  66. \end{DoxyParamCaption}
  67. )\hspace{0.3cm}{\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData_a01f04d64b1e62f567d819a8fcbe38319}{}\label{classcore_1_1ObjectData_a01f04d64b1e62f567d819a8fcbe38319}
  68. Compares this object with the given object.
  69. \begin{DoxyParams}{Parameters}
  70. {\em obj} & A pointer to the object to compare this object to \\
  71. \hline
  72. \end{DoxyParams}
  73. \begin{DoxyReturn}{Returns}
  74. A double value indicating the comparison result
  75. \end{DoxyReturn}
  76. Reimplemented in \hyperlink{classcore_1_1ObjectDataMap_ad00d1998652e4d2ffa2629128c9c2947}{core\+::\+Object\+Data\+Map}, and \hyperlink{classcore_1_1Tracklet_ab45f28ba6abde0944820ac614560ea89}{core\+::\+Tracklet}.
  77. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Get\+Frame\+Index@{Get\+Frame\+Index}}
  78. \index{Get\+Frame\+Index@{Get\+Frame\+Index}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  79. \subsubsection[{\texorpdfstring{Get\+Frame\+Index() const}{GetFrameIndex() const}}]{\setlength{\rightskip}{0pt plus 5cm}std\+::size\+\_\+t core\+::\+Object\+Data\+::\+Get\+Frame\+Index (
  80. \begin{DoxyParamCaption}
  81. {}
  82. \end{DoxyParamCaption}
  83. ) const}\hypertarget{classcore_1_1ObjectData_a1151e9215baf315f4b98f696f4271162}{}\label{classcore_1_1ObjectData_a1151e9215baf315f4b98f696f4271162}
  84. Getter for the frame index \begin{DoxyReturn}{Returns}
  85. The frame index
  86. \end{DoxyReturn}
  87. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Is\+Virtual@{Is\+Virtual}}
  88. \index{Is\+Virtual@{Is\+Virtual}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  89. \subsubsection[{\texorpdfstring{Is\+Virtual() const}{IsVirtual() const}}]{\setlength{\rightskip}{0pt plus 5cm}bool core\+::\+Object\+Data\+::\+Is\+Virtual (
  90. \begin{DoxyParamCaption}
  91. {}
  92. \end{DoxyParamCaption}
  93. ) const}\hypertarget{classcore_1_1ObjectData_a2880d710cfa520e9c0453e2a6729c0e2}{}\label{classcore_1_1ObjectData_a2880d710cfa520e9c0453e2a6729c0e2}
  94. Is this node considered a virtual node \begin{DoxyReturn}{Returns}
  95. Whether this node is virtual
  96. \end{DoxyReturn}
  97. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Print@{Print}}
  98. \index{Print@{Print}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  99. \subsubsection[{\texorpdfstring{Print(std\+::ostream \&os) const}{Print(std::ostream \&os) const}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+::\+Print (
  100. \begin{DoxyParamCaption}
  101. \item[{std\+::ostream \&}]{os}
  102. \end{DoxyParamCaption}
  103. ) const\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData_aa26949b0456068d67802d9f6067aa657}{}\label{classcore_1_1ObjectData_aa26949b0456068d67802d9f6067aa657}
  104. Used in the $<$$<$ operator
  105. \begin{DoxyParams}{Parameters}
  106. {\em os} & The stream to write to \\
  107. \hline
  108. \end{DoxyParams}
  109. Reimplemented in \hyperlink{classcore_1_1ObjectDataMap_a16fbcc2b99feb1545e1a66f828680b1a}{core\+::\+Object\+Data\+Map}.
  110. \subsection{Friends And Related Function Documentation}
  111. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!operator$<$$<$@{operator$<$$<$}}
  112. \index{operator$<$$<$@{operator$<$$<$}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  113. \subsubsection[{\texorpdfstring{operator$<$$<$}{operator<<}}]{\setlength{\rightskip}{0pt plus 5cm}std\+::ostream\& operator$<$$<$ (
  114. \begin{DoxyParamCaption}
  115. \item[{std\+::ostream \&}]{os, }
  116. \item[{const {\bf Object\+Data} \&}]{obj}
  117. \end{DoxyParamCaption}
  118. )\hspace{0.3cm}{\ttfamily [friend]}}\hypertarget{classcore_1_1ObjectData_a56fc9b6184428bf4d80826bbb9fe4c6f}{}\label{classcore_1_1ObjectData_a56fc9b6184428bf4d80826bbb9fe4c6f}
  119. Overrides the $<$$<$ operator for easy output. Calls the print method.
  120. \begin{DoxyParams}{Parameters}
  121. {\em os} & The stream to write to \\
  122. \hline
  123. {\em obj} & The object to write into the stream \\
  124. \hline
  125. \end{DoxyParams}
  126. \begin{DoxyReturn}{Returns}
  127. The stream written to
  128. \end{DoxyReturn}
  129. \subsection{Member Data Documentation}
  130. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!frame\+\_\+index\+\_\+@{frame\+\_\+index\+\_\+}}
  131. \index{frame\+\_\+index\+\_\+@{frame\+\_\+index\+\_\+}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  132. \subsubsection[{\texorpdfstring{frame\+\_\+index\+\_\+}{frame\_index\_}}]{\setlength{\rightskip}{0pt plus 5cm}std\+::size\+\_\+t core\+::\+Object\+Data\+::frame\+\_\+index\+\_\+\hspace{0.3cm}{\ttfamily [protected]}}\hypertarget{classcore_1_1ObjectData_ade1423dbad9323431d22750121fa59e5}{}\label{classcore_1_1ObjectData_ade1423dbad9323431d22750121fa59e5}
  133. The frame the object was detected in
  134. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  135. \item
  136. core/Object\+Data.\+h\item
  137. core/Object\+Data.\+cpp\end{DoxyCompactItemize}