classcore_1_1ObjectData.tex 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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=3.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. void \hyperlink{classcore_1_1ObjectData_aedfe00fa37d5ac7ef554bda746931148}{Set\+Frame\+Index} (size\+\_\+t index)
  20. \item
  21. void \hyperlink{classcore_1_1ObjectData_a737216c2689aefa216c1c842922d7dd8}{Set\+Detection\+Score} (double score)
  22. \item
  23. double \hyperlink{classcore_1_1ObjectData_ae9208bfeee72238e2d635dfab368c09a}{Get\+Detection\+Score} ()
  24. \item
  25. bool \hyperlink{classcore_1_1ObjectData_a2880d710cfa520e9c0453e2a6729c0e2}{Is\+Virtual} () const
  26. \item
  27. virtual double \hyperlink{classcore_1_1ObjectData_afbf7a1e87235f1b204d4d2eb8a37a9a6}{Compare\+To} (Object\+Data\+Ptr obj) const
  28. \item
  29. virtual Object\+Data\+Ptr \hyperlink{classcore_1_1ObjectData_ad681915317decab76c384a635fc8444e}{Interpolate} (Object\+Data\+Ptr obj, double fraction) const
  30. \item
  31. virtual void \hyperlink{classcore_1_1ObjectData_aae2c4fceddc529570dbe8909309f9961}{Visualize} (cv\+::\+Mat \&image, cv\+::\+Scalar \&color) const
  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 virtual \hyperlink{classcore_1_1ObjectData}{Object\+Data} \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\+Ptr obj) const}{CompareTo(ObjectDataPtr obj) const}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+::\+Compare\+To (
  64. \begin{DoxyParamCaption}
  65. \item[{Object\+Data\+Ptr}]{obj}
  66. \end{DoxyParamCaption}
  67. ) const\hspace{0.3cm}{\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData_afbf7a1e87235f1b204d4d2eb8a37a9a6}{}\label{classcore_1_1ObjectData_afbf7a1e87235f1b204d4d2eb8a37a9a6}
  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_a7fcc9ef5b684f14d33711348610d9b74}{core\+::\+Object\+Data\+Map}, \hyperlink{classcore_1_1Tracklet_a0357f2fa173941800571432dcbc96dc2}{core\+::\+Tracklet}, \hyperlink{classcore_1_1ObjectData3D_abef3e4e7a0dc121d8a403d91964be576}{core\+::\+Object\+Data3D}, and \hyperlink{classcore_1_1ObjectDataAngular_a2932240c6c082b76f2c04723cdf3e4f9}{core\+::\+Object\+Data\+Angular}.
  77. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Get\+Detection\+Score@{Get\+Detection\+Score}}
  78. \index{Get\+Detection\+Score@{Get\+Detection\+Score}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  79. \subsubsection[{\texorpdfstring{Get\+Detection\+Score()}{GetDetectionScore()}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+::\+Get\+Detection\+Score (
  80. \begin{DoxyParamCaption}
  81. {}
  82. \end{DoxyParamCaption}
  83. )}\hypertarget{classcore_1_1ObjectData_ae9208bfeee72238e2d635dfab368c09a}{}\label{classcore_1_1ObjectData_ae9208bfeee72238e2d635dfab368c09a}
  84. Gets the detection score \begin{DoxyReturn}{Returns}
  85. The detection score
  86. \end{DoxyReturn}
  87. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Get\+Frame\+Index@{Get\+Frame\+Index}}
  88. \index{Get\+Frame\+Index@{Get\+Frame\+Index}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  89. \subsubsection[{\texorpdfstring{Get\+Frame\+Index() const}{GetFrameIndex() const}}]{\setlength{\rightskip}{0pt plus 5cm}std\+::size\+\_\+t core\+::\+Object\+Data\+::\+Get\+Frame\+Index (
  90. \begin{DoxyParamCaption}
  91. {}
  92. \end{DoxyParamCaption}
  93. ) const}\hypertarget{classcore_1_1ObjectData_a1151e9215baf315f4b98f696f4271162}{}\label{classcore_1_1ObjectData_a1151e9215baf315f4b98f696f4271162}
  94. Gets the frame index \begin{DoxyReturn}{Returns}
  95. The frame index
  96. \end{DoxyReturn}
  97. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Interpolate@{Interpolate}}
  98. \index{Interpolate@{Interpolate}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  99. \subsubsection[{\texorpdfstring{Interpolate(\+Object\+Data\+Ptr obj, double fraction) const}{Interpolate(ObjectDataPtr obj, double fraction) const}}]{\setlength{\rightskip}{0pt plus 5cm}Object\+Data\+Ptr core\+::\+Object\+Data\+::\+Interpolate (
  100. \begin{DoxyParamCaption}
  101. \item[{Object\+Data\+Ptr}]{obj, }
  102. \item[{double}]{fraction}
  103. \end{DoxyParamCaption}
  104. ) const\hspace{0.3cm}{\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData_ad681915317decab76c384a635fc8444e}{}\label{classcore_1_1ObjectData_ad681915317decab76c384a635fc8444e}
  105. Linearly interpolates between this and the given object. Creates a new object to fit between the two objects.
  106. \begin{DoxyParams}{Parameters}
  107. {\em obj} & A pointer to the target object \\
  108. \hline
  109. {\em fraction} & Describes where the interpolation should be done. A fraction of zero is a clone of this object, a fraction of one is a clone of the target object. \\
  110. \hline
  111. \end{DoxyParams}
  112. \begin{DoxyReturn}{Returns}
  113. The interpolated object
  114. \end{DoxyReturn}
  115. Reimplemented in \hyperlink{classcore_1_1ObjectDataMap_ac6a739ea0509371929dbe7cbac601a3e}{core\+::\+Object\+Data\+Map}, \hyperlink{classcore_1_1Tracklet_a5fb5e6ab9df668c3477e8b52f115b188}{core\+::\+Tracklet}, \hyperlink{classcore_1_1ObjectData3D_ae57a5d8f7a02a403653c82c3b73a73d2}{core\+::\+Object\+Data3D}, and \hyperlink{classcore_1_1ObjectDataAngular_a42962dd1f994b2577133450e755d586e}{core\+::\+Object\+Data\+Angular}.
  116. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Is\+Virtual@{Is\+Virtual}}
  117. \index{Is\+Virtual@{Is\+Virtual}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  118. \subsubsection[{\texorpdfstring{Is\+Virtual() const}{IsVirtual() const}}]{\setlength{\rightskip}{0pt plus 5cm}bool core\+::\+Object\+Data\+::\+Is\+Virtual (
  119. \begin{DoxyParamCaption}
  120. {}
  121. \end{DoxyParamCaption}
  122. ) const}\hypertarget{classcore_1_1ObjectData_a2880d710cfa520e9c0453e2a6729c0e2}{}\label{classcore_1_1ObjectData_a2880d710cfa520e9c0453e2a6729c0e2}
  123. Is this node considered a virtual node \begin{DoxyReturn}{Returns}
  124. True, if this node is virtual
  125. \end{DoxyReturn}
  126. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Set\+Detection\+Score@{Set\+Detection\+Score}}
  127. \index{Set\+Detection\+Score@{Set\+Detection\+Score}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  128. \subsubsection[{\texorpdfstring{Set\+Detection\+Score(double score)}{SetDetectionScore(double score)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+::\+Set\+Detection\+Score (
  129. \begin{DoxyParamCaption}
  130. \item[{double}]{score}
  131. \end{DoxyParamCaption}
  132. )}\hypertarget{classcore_1_1ObjectData_a737216c2689aefa216c1c842922d7dd8}{}\label{classcore_1_1ObjectData_a737216c2689aefa216c1c842922d7dd8}
  133. Sets the detection score
  134. \begin{DoxyParams}{Parameters}
  135. {\em score} & The detection score \\
  136. \hline
  137. \end{DoxyParams}
  138. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Set\+Frame\+Index@{Set\+Frame\+Index}}
  139. \index{Set\+Frame\+Index@{Set\+Frame\+Index}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  140. \subsubsection[{\texorpdfstring{Set\+Frame\+Index(size\+\_\+t index)}{SetFrameIndex(size\_t index)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+::\+Set\+Frame\+Index (
  141. \begin{DoxyParamCaption}
  142. \item[{size\+\_\+t}]{index}
  143. \end{DoxyParamCaption}
  144. )}\hypertarget{classcore_1_1ObjectData_aedfe00fa37d5ac7ef554bda746931148}{}\label{classcore_1_1ObjectData_aedfe00fa37d5ac7ef554bda746931148}
  145. Sets the frame index
  146. \begin{DoxyParams}{Parameters}
  147. {\em index} & The new frame index \\
  148. \hline
  149. \end{DoxyParams}
  150. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!Visualize@{Visualize}}
  151. \index{Visualize@{Visualize}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  152. \subsubsection[{\texorpdfstring{Visualize(cv\+::\+Mat \&image, cv\+::\+Scalar \&color) const}{Visualize(cv::Mat \&image, cv::Scalar \&color) const}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+::\+Visualize (
  153. \begin{DoxyParamCaption}
  154. \item[{cv\+::\+Mat \&}]{image, }
  155. \item[{cv\+::\+Scalar \&}]{color}
  156. \end{DoxyParamCaption}
  157. ) const\hspace{0.3cm}{\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData_aae2c4fceddc529570dbe8909309f9961}{}\label{classcore_1_1ObjectData_aae2c4fceddc529570dbe8909309f9961}
  158. Visualizes the object in the given image with the given color. This method does nothing, it needs to be overwritten to visualize something.
  159. \begin{DoxyParams}{Parameters}
  160. {\em image} & The image to write into \\
  161. \hline
  162. {\em color} & The color to use \\
  163. \hline
  164. \end{DoxyParams}
  165. Reimplemented in \hyperlink{classcore_1_1ObjectDataMap_a8a0f71318dd58e0d527a63b904c6afac}{core\+::\+Object\+Data\+Map}, \hyperlink{classcore_1_1Tracklet_a85f92a4059bf89f24a83f28935675181}{core\+::\+Tracklet}, \hyperlink{classcore_1_1ObjectData3D_a86216fae3dc86f1107eb1b4530b574d2}{core\+::\+Object\+Data3D}, and \hyperlink{classcore_1_1ObjectDataAngular_acb4265f6de511238460df118148bc85c}{core\+::\+Object\+Data\+Angular}.
  166. \subsection{Friends And Related Function Documentation}
  167. \index{core\+::\+Object\+Data@{core\+::\+Object\+Data}!operator$<$$<$@{operator$<$$<$}}
  168. \index{operator$<$$<$@{operator$<$$<$}!core\+::\+Object\+Data@{core\+::\+Object\+Data}}
  169. \subsubsection[{\texorpdfstring{operator$<$$<$}{operator<<}}]{\setlength{\rightskip}{0pt plus 5cm}std\+::ostream\& operator$<$$<$ (
  170. \begin{DoxyParamCaption}
  171. \item[{std\+::ostream \&}]{os, }
  172. \item[{const {\bf Object\+Data} \&}]{obj}
  173. \end{DoxyParamCaption}
  174. )\hspace{0.3cm}{\ttfamily [friend]}}\hypertarget{classcore_1_1ObjectData_a56fc9b6184428bf4d80826bbb9fe4c6f}{}\label{classcore_1_1ObjectData_a56fc9b6184428bf4d80826bbb9fe4c6f}
  175. Overrides the $<$$<$ operator for custom output. Calls the print method.
  176. \begin{DoxyParams}{Parameters}
  177. {\em os} & The stream to write to \\
  178. \hline
  179. {\em obj} & The object to write into the stream \\
  180. \hline
  181. \end{DoxyParams}
  182. \begin{DoxyReturn}{Returns}
  183. The stream written to
  184. \end{DoxyReturn}
  185. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  186. \item
  187. core/Object\+Data.\+h\item
  188. core/Object\+Data.\+cpp\end{DoxyCompactItemize}