classcore_1_1ObjectDataAngular.tex 11 KB

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