classcore_1_1ObjectDataBox.tex 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. \hypertarget{classcore_1_1ObjectDataBox}{}\section{core\+:\+:Object\+Data\+Box Class Reference}
  2. \label{classcore_1_1ObjectDataBox}\index{core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}}
  3. {\ttfamily \#include $<$Object\+Data\+Box.\+h$>$}
  4. Inheritance diagram for core\+:\+:Object\+Data\+Box\+:\begin{figure}[H]
  5. \begin{center}
  6. \leavevmode
  7. \includegraphics[height=3.000000cm]{classcore_1_1ObjectDataBox}
  8. \end{center}
  9. \end{figure}
  10. \subsection*{Public Member Functions}
  11. \begin{DoxyCompactItemize}
  12. \item
  13. \hyperlink{classcore_1_1ObjectDataBox_a9a1ee3e1e603c1e55adc58a1a58efad2}{Object\+Data\+Box} (size\+\_\+t frame\+\_\+index, cv\+::\+Point2d anchor, cv\+::\+Point2d size)
  14. \item
  15. cv\+::\+Point2d \hyperlink{classcore_1_1ObjectDataBox_a76e9f48dfb685d16de868a129c1f3918}{Get\+Size} () const
  16. \item
  17. virtual double \hyperlink{classcore_1_1ObjectDataBox_a163c57338778f957ce514611c509558a}{Compare\+To} (Object\+Data\+Ptr obj) const override
  18. \item
  19. virtual Object\+Data\+Ptr \hyperlink{classcore_1_1ObjectDataBox_ab2816bceb771dd7442e6c29193dfe267}{Interpolate} (Object\+Data\+Ptr obj, double fraction) const override
  20. \item
  21. virtual void \hyperlink{classcore_1_1ObjectDataBox_ab29bacb20c258ba572d0372469ec5523}{Visualize} (cv\+::\+Mat \&image, cv\+::\+Scalar \&color) const override
  22. \end{DoxyCompactItemize}
  23. \subsection{Detailed Description}
  24. Class for storing an object detection with an bounding box.
  25. \subsection{Constructor \& Destructor Documentation}
  26. \index{core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}!Object\+Data\+Box@{Object\+Data\+Box}}
  27. \index{Object\+Data\+Box@{Object\+Data\+Box}!core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}}
  28. \subsubsection[{\texorpdfstring{Object\+Data\+Box(size\+\_\+t frame\+\_\+index, cv\+::\+Point2d anchor, cv\+::\+Point2d size)}{ObjectDataBox(size\_t frame\_index, cv::Point2d anchor, cv::Point2d size)}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data\+Box\+::\+Object\+Data\+Box (
  29. \begin{DoxyParamCaption}
  30. \item[{size\+\_\+t}]{frame\+\_\+index, }
  31. \item[{cv\+::\+Point2d}]{anchor, }
  32. \item[{cv\+::\+Point2d}]{size}
  33. \end{DoxyParamCaption}
  34. )}\hypertarget{classcore_1_1ObjectDataBox_a9a1ee3e1e603c1e55adc58a1a58efad2}{}\label{classcore_1_1ObjectDataBox_a9a1ee3e1e603c1e55adc58a1a58efad2}
  35. Creates a new detection with an bounding box of the given size.
  36. \begin{DoxyParams}{Parameters}
  37. {\em frame\+\_\+index} & The frame index of the detection \\
  38. \hline
  39. {\em anchor} & The top left corner of the bounding box \\
  40. \hline
  41. {\em size} & The size of the bounding box \\
  42. \hline
  43. \end{DoxyParams}
  44. \subsection{Member Function Documentation}
  45. \index{core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}!Compare\+To@{Compare\+To}}
  46. \index{Compare\+To@{Compare\+To}!core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}}
  47. \subsubsection[{\texorpdfstring{Compare\+To(\+Object\+Data\+Ptr obj) const override}{CompareTo(ObjectDataPtr obj) const override}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Box\+::\+Compare\+To (
  48. \begin{DoxyParamCaption}
  49. \item[{Object\+Data\+Ptr}]{obj}
  50. \end{DoxyParamCaption}
  51. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataBox_a163c57338778f957ce514611c509558a}{}\label{classcore_1_1ObjectDataBox_a163c57338778f957ce514611c509558a}
  52. Compares this object with the given object.
  53. \begin{DoxyParams}{Parameters}
  54. {\em obj} & A pointer to the object to compare this object to \\
  55. \hline
  56. \end{DoxyParams}
  57. \begin{DoxyReturn}{Returns}
  58. A double value indicating the comparison result
  59. \end{DoxyReturn}
  60. Reimplemented from \hyperlink{classcore_1_1ObjectData2D_a68d56bd5f26a41830a87ae32eabf9126}{core\+::\+Object\+Data2D}.
  61. \index{core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}!Get\+Size@{Get\+Size}}
  62. \index{Get\+Size@{Get\+Size}!core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}}
  63. \subsubsection[{\texorpdfstring{Get\+Size() const}{GetSize() const}}]{\setlength{\rightskip}{0pt plus 5cm}cv\+::\+Point2d core\+::\+Object\+Data\+Box\+::\+Get\+Size (
  64. \begin{DoxyParamCaption}
  65. {}
  66. \end{DoxyParamCaption}
  67. ) const}\hypertarget{classcore_1_1ObjectDataBox_a76e9f48dfb685d16de868a129c1f3918}{}\label{classcore_1_1ObjectDataBox_a76e9f48dfb685d16de868a129c1f3918}
  68. Gets the size of the bounding box.
  69. \begin{DoxyReturn}{Returns}
  70. The size of the bounding box
  71. \end{DoxyReturn}
  72. \index{core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}!Interpolate@{Interpolate}}
  73. \index{Interpolate@{Interpolate}!core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}}
  74. \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\+Box\+::\+Interpolate (
  75. \begin{DoxyParamCaption}
  76. \item[{Object\+Data\+Ptr}]{obj, }
  77. \item[{double}]{fraction}
  78. \end{DoxyParamCaption}
  79. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataBox_ab2816bceb771dd7442e6c29193dfe267}{}\label{classcore_1_1ObjectDataBox_ab2816bceb771dd7442e6c29193dfe267}
  80. Linearly interpolates between this and the given object. Creates a new object to fit between the two objects.
  81. \begin{DoxyParams}{Parameters}
  82. {\em obj} & A pointer to the target object \\
  83. \hline
  84. {\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. \\
  85. \hline
  86. \end{DoxyParams}
  87. \begin{DoxyReturn}{Returns}
  88. The interpolated object
  89. \end{DoxyReturn}
  90. Reimplemented from \hyperlink{classcore_1_1ObjectData2D_a59b974e09f74f0a2640e3152893fe79f}{core\+::\+Object\+Data2D}.
  91. \index{core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}!Visualize@{Visualize}}
  92. \index{Visualize@{Visualize}!core\+::\+Object\+Data\+Box@{core\+::\+Object\+Data\+Box}}
  93. \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\+Box\+::\+Visualize (
  94. \begin{DoxyParamCaption}
  95. \item[{cv\+::\+Mat \&}]{image, }
  96. \item[{cv\+::\+Scalar \&}]{color}
  97. \end{DoxyParamCaption}
  98. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataBox_ab29bacb20c258ba572d0372469ec5523}{}\label{classcore_1_1ObjectDataBox_ab29bacb20c258ba572d0372469ec5523}
  99. Visualizes the object in the given image with the given color. This method does nothing, it needs to be overwritten to visualize something.
  100. \begin{DoxyParams}{Parameters}
  101. {\em image} & The image to write into \\
  102. \hline
  103. {\em color} & The color to use \\
  104. \hline
  105. \end{DoxyParams}
  106. Reimplemented from \hyperlink{classcore_1_1ObjectData2D_aff4e8539559f4ce50a7f43b733d6c512}{core\+::\+Object\+Data2D}.
  107. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  108. \item
  109. core/Object\+Data\+Box.\+h\item
  110. core/Object\+Data\+Box.\+cpp\end{DoxyCompactItemize}