classcore_1_1ObjectData3D.tex 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. \hypertarget{classcore_1_1ObjectData3D}{}\section{core\+:\+:Object\+Data3D Class Reference}
  2. \label{classcore_1_1ObjectData3D}\index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  3. {\ttfamily \#include $<$Object\+Data3\+D.\+h$>$}
  4. Inheritance diagram for core\+:\+:Object\+Data3D\+:\begin{figure}[H]
  5. \begin{center}
  6. \leavevmode
  7. \includegraphics[height=3.000000cm]{classcore_1_1ObjectData3D}
  8. \end{center}
  9. \end{figure}
  10. \subsection*{Public Member Functions}
  11. \begin{DoxyCompactItemize}
  12. \item
  13. \hyperlink{classcore_1_1ObjectData3D_a47c967cffcbd109f1366069958a71699}{Object\+Data3D} (size\+\_\+t frame\+\_\+index, cv\+::\+Point3d position)
  14. \item
  15. void \hyperlink{classcore_1_1ObjectData3D_a05eafbd4d963ef14b1068ab5a3818597}{Set\+Temporal\+Weight} (double weight)
  16. \item
  17. void \hyperlink{classcore_1_1ObjectData3D_a94d4c0d90d4e0999eb2b339d37069cd6}{Set\+Spatial\+Weight} (double weight)
  18. \item
  19. cv\+::\+Point3d \hyperlink{classcore_1_1ObjectData3D_a0f4a0dca51eb50fdc5baf9714c4a64f6}{Get\+Position} () const
  20. \item
  21. double \hyperlink{classcore_1_1ObjectData3D_a155e3f4dd2a6adb5d32b61f224092d4b}{Get\+Temporal\+Weight} () const
  22. \item
  23. double \hyperlink{classcore_1_1ObjectData3D_a896607721c9d12b2e2425fe927f06d6f}{Get\+Spatial\+Weight} () const
  24. \item
  25. virtual double \hyperlink{classcore_1_1ObjectData3D_abef3e4e7a0dc121d8a403d91964be576}{Compare\+To} (Object\+Data\+Ptr obj) const override
  26. \item
  27. virtual Object\+Data\+Ptr \hyperlink{classcore_1_1ObjectData3D_ae57a5d8f7a02a403653c82c3b73a73d2}{Interpolate} (Object\+Data\+Ptr obj, double fraction) const override
  28. \item
  29. virtual void \hyperlink{classcore_1_1ObjectData3D_a86216fae3dc86f1107eb1b4530b574d2}{Visualize} (cv\+::\+Mat \&image, cv\+::\+Scalar \&color) const override
  30. \end{DoxyCompactItemize}
  31. \subsection{Detailed Description}
  32. Class for storing a detection in three dimensional space.
  33. \subsection{Constructor \& Destructor Documentation}
  34. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Object\+Data3D@{Object\+Data3D}}
  35. \index{Object\+Data3D@{Object\+Data3D}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  36. \subsubsection[{\texorpdfstring{Object\+Data3\+D(size\+\_\+t frame\+\_\+index, cv\+::\+Point3d position)}{ObjectData3D(size\_t frame\_index, cv::Point3d position)}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data3\+D\+::\+Object\+Data3D (
  37. \begin{DoxyParamCaption}
  38. \item[{size\+\_\+t}]{frame\+\_\+index, }
  39. \item[{cv\+::\+Point3d}]{position}
  40. \end{DoxyParamCaption}
  41. )}\hypertarget{classcore_1_1ObjectData3D_a47c967cffcbd109f1366069958a71699}{}\label{classcore_1_1ObjectData3D_a47c967cffcbd109f1366069958a71699}
  42. Creates a new detection with the given index and position.
  43. \begin{DoxyParams}{Parameters}
  44. {\em frame\+\_\+index} & The frame index \\
  45. \hline
  46. {\em position} & The position in three dimensional space \\
  47. \hline
  48. \end{DoxyParams}
  49. \subsection{Member Function Documentation}
  50. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Compare\+To@{Compare\+To}}
  51. \index{Compare\+To@{Compare\+To}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  52. \subsubsection[{\texorpdfstring{Compare\+To(\+Object\+Data\+Ptr obj) const override}{CompareTo(ObjectDataPtr obj) const override}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data3\+D\+::\+Compare\+To (
  53. \begin{DoxyParamCaption}
  54. \item[{Object\+Data\+Ptr}]{obj}
  55. \end{DoxyParamCaption}
  56. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData3D_abef3e4e7a0dc121d8a403d91964be576}{}\label{classcore_1_1ObjectData3D_abef3e4e7a0dc121d8a403d91964be576}
  57. Compares this object with the given object.
  58. \begin{DoxyParams}{Parameters}
  59. {\em obj} & A pointer to the object to compare this object to \\
  60. \hline
  61. \end{DoxyParams}
  62. \begin{DoxyReturn}{Returns}
  63. A double value indicating the comparison result
  64. \end{DoxyReturn}
  65. Reimplemented from \hyperlink{classcore_1_1ObjectData_afbf7a1e87235f1b204d4d2eb8a37a9a6}{core\+::\+Object\+Data}.
  66. Reimplemented in \hyperlink{classcore_1_1ObjectDataAngular_a2932240c6c082b76f2c04723cdf3e4f9}{core\+::\+Object\+Data\+Angular}.
  67. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Get\+Position@{Get\+Position}}
  68. \index{Get\+Position@{Get\+Position}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  69. \subsubsection[{\texorpdfstring{Get\+Position() const}{GetPosition() const}}]{\setlength{\rightskip}{0pt plus 5cm}cv\+::\+Point3d core\+::\+Object\+Data3\+D\+::\+Get\+Position (
  70. \begin{DoxyParamCaption}
  71. {}
  72. \end{DoxyParamCaption}
  73. ) const}\hypertarget{classcore_1_1ObjectData3D_a0f4a0dca51eb50fdc5baf9714c4a64f6}{}\label{classcore_1_1ObjectData3D_a0f4a0dca51eb50fdc5baf9714c4a64f6}
  74. Gets the position in three dimensional space. \begin{DoxyReturn}{Returns}
  75. The position
  76. \end{DoxyReturn}
  77. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Get\+Spatial\+Weight@{Get\+Spatial\+Weight}}
  78. \index{Get\+Spatial\+Weight@{Get\+Spatial\+Weight}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  79. \subsubsection[{\texorpdfstring{Get\+Spatial\+Weight() const}{GetSpatialWeight() const}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data3\+D\+::\+Get\+Spatial\+Weight (
  80. \begin{DoxyParamCaption}
  81. {}
  82. \end{DoxyParamCaption}
  83. ) const}\hypertarget{classcore_1_1ObjectData3D_a896607721c9d12b2e2425fe927f06d6f}{}\label{classcore_1_1ObjectData3D_a896607721c9d12b2e2425fe927f06d6f}
  84. Gets the spatial weight \begin{DoxyReturn}{Returns}
  85. The spatial weight
  86. \end{DoxyReturn}
  87. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Get\+Temporal\+Weight@{Get\+Temporal\+Weight}}
  88. \index{Get\+Temporal\+Weight@{Get\+Temporal\+Weight}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  89. \subsubsection[{\texorpdfstring{Get\+Temporal\+Weight() const}{GetTemporalWeight() const}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data3\+D\+::\+Get\+Temporal\+Weight (
  90. \begin{DoxyParamCaption}
  91. {}
  92. \end{DoxyParamCaption}
  93. ) const}\hypertarget{classcore_1_1ObjectData3D_a155e3f4dd2a6adb5d32b61f224092d4b}{}\label{classcore_1_1ObjectData3D_a155e3f4dd2a6adb5d32b61f224092d4b}
  94. Gets the temporal weight. \begin{DoxyReturn}{Returns}
  95. The temporal weight
  96. \end{DoxyReturn}
  97. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Interpolate@{Interpolate}}
  98. \index{Interpolate@{Interpolate}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  99. \subsubsection[{\texorpdfstring{Interpolate(\+Object\+Data\+Ptr obj, double fraction) const override}{Interpolate(ObjectDataPtr obj, double fraction) const override}}]{\setlength{\rightskip}{0pt plus 5cm}Object\+Data\+Ptr core\+::\+Object\+Data3\+D\+::\+Interpolate (
  100. \begin{DoxyParamCaption}
  101. \item[{Object\+Data\+Ptr}]{obj, }
  102. \item[{double}]{fraction}
  103. \end{DoxyParamCaption}
  104. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData3D_ae57a5d8f7a02a403653c82c3b73a73d2}{}\label{classcore_1_1ObjectData3D_ae57a5d8f7a02a403653c82c3b73a73d2}
  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 from \hyperlink{classcore_1_1ObjectData_ad681915317decab76c384a635fc8444e}{core\+::\+Object\+Data}.
  116. Reimplemented in \hyperlink{classcore_1_1ObjectDataAngular_a42962dd1f994b2577133450e755d586e}{core\+::\+Object\+Data\+Angular}.
  117. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Set\+Spatial\+Weight@{Set\+Spatial\+Weight}}
  118. \index{Set\+Spatial\+Weight@{Set\+Spatial\+Weight}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  119. \subsubsection[{\texorpdfstring{Set\+Spatial\+Weight(double weight)}{SetSpatialWeight(double weight)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data3\+D\+::\+Set\+Spatial\+Weight (
  120. \begin{DoxyParamCaption}
  121. \item[{double}]{weight}
  122. \end{DoxyParamCaption}
  123. )}\hypertarget{classcore_1_1ObjectData3D_a94d4c0d90d4e0999eb2b339d37069cd6}{}\label{classcore_1_1ObjectData3D_a94d4c0d90d4e0999eb2b339d37069cd6}
  124. Sets the spatial weight
  125. \begin{DoxyParams}{Parameters}
  126. {\em weight} & The spatial weight \\
  127. \hline
  128. \end{DoxyParams}
  129. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Set\+Temporal\+Weight@{Set\+Temporal\+Weight}}
  130. \index{Set\+Temporal\+Weight@{Set\+Temporal\+Weight}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  131. \subsubsection[{\texorpdfstring{Set\+Temporal\+Weight(double weight)}{SetTemporalWeight(double weight)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data3\+D\+::\+Set\+Temporal\+Weight (
  132. \begin{DoxyParamCaption}
  133. \item[{double}]{weight}
  134. \end{DoxyParamCaption}
  135. )}\hypertarget{classcore_1_1ObjectData3D_a05eafbd4d963ef14b1068ab5a3818597}{}\label{classcore_1_1ObjectData3D_a05eafbd4d963ef14b1068ab5a3818597}
  136. Sets the temporal weight.
  137. \begin{DoxyParams}{Parameters}
  138. {\em weight} & The temporal weight \\
  139. \hline
  140. \end{DoxyParams}
  141. \index{core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}!Visualize@{Visualize}}
  142. \index{Visualize@{Visualize}!core\+::\+Object\+Data3D@{core\+::\+Object\+Data3D}}
  143. \subsubsection[{\texorpdfstring{Visualize(cv\+::\+Mat \&image, cv\+::\+Scalar \&color) const override}{Visualize(cv::Mat \&image, cv::Scalar \&color) const override}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data3\+D\+::\+Visualize (
  144. \begin{DoxyParamCaption}
  145. \item[{cv\+::\+Mat \&}]{image, }
  146. \item[{cv\+::\+Scalar \&}]{color}
  147. \end{DoxyParamCaption}
  148. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectData3D_a86216fae3dc86f1107eb1b4530b574d2}{}\label{classcore_1_1ObjectData3D_a86216fae3dc86f1107eb1b4530b574d2}
  149. Visualizes the object in the given image with the given color. This method does nothing, it needs to be overwritten to visualize something.
  150. \begin{DoxyParams}{Parameters}
  151. {\em image} & The image to write into \\
  152. \hline
  153. {\em color} & The color to use \\
  154. \hline
  155. \end{DoxyParams}
  156. Reimplemented from \hyperlink{classcore_1_1ObjectData_aae2c4fceddc529570dbe8909309f9961}{core\+::\+Object\+Data}.
  157. Reimplemented in \hyperlink{classcore_1_1ObjectDataAngular_acb4265f6de511238460df118148bc85c}{core\+::\+Object\+Data\+Angular}.
  158. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  159. \item
  160. core/Object\+Data3\+D.\+h\item
  161. core/Object\+Data3\+D.\+cpp\end{DoxyCompactItemize}