classcore_1_1ObjectDataMap.tex 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. \hypertarget{classcore_1_1ObjectDataMap}{}\section{core\+:\+:Object\+Data\+Map Class Reference}
  2. \label{classcore_1_1ObjectDataMap}\index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  3. {\ttfamily \#include $<$Object\+Data\+Map.\+h$>$}
  4. Inheritance diagram for core\+:\+:Object\+Data\+Map\+:\begin{figure}[H]
  5. \begin{center}
  6. \leavevmode
  7. \includegraphics[height=2.000000cm]{classcore_1_1ObjectDataMap}
  8. \end{center}
  9. \end{figure}
  10. \subsection*{Public Member Functions}
  11. \begin{DoxyCompactItemize}
  12. \item
  13. \hyperlink{classcore_1_1ObjectDataMap_ac6df34682a715db6845667f7dda1c795}{Object\+Data\+Map} (size\+\_\+t frame\+\_\+index)
  14. \item
  15. \hyperlink{classcore_1_1ObjectDataMap_a573add8d73646e6c5f183a9a0c159596}{Object\+Data\+Map} (size\+\_\+t frame\+\_\+index, std\+::vector$<$ std\+::string $>$ keys, std\+::vector$<$ double $>$ value\+\_\+list)
  16. \item
  17. \hyperlink{classcore_1_1ObjectDataMap_a5727c237d73f3f16c94a748c1b9b0c74}{Object\+Data\+Map} (size\+\_\+t frame\+\_\+index, std\+::vector$<$ std\+::string $>$ keys, std\+::vector$<$ double $>$ value\+\_\+list, std\+::vector$<$ double $>$ weight\+\_\+list)
  18. \item
  19. \hyperlink{classcore_1_1ObjectDataMap_ad2af0de7438ed72be68348ac992568b6}{Object\+Data\+Map} (size\+\_\+t frame\+\_\+index, std\+::vector$<$ std\+::string $>$ keys, std\+::vector$<$ std\+::pair$<$ double, double $>$$>$ value\+\_\+weight\+\_\+list)
  20. \item
  21. double \hyperlink{classcore_1_1ObjectDataMap_a276c89da6f3318d2baa2e9678e9508f7}{Get\+Value} (std\+::string key)
  22. \item
  23. double \hyperlink{classcore_1_1ObjectDataMap_a4cd92ab91559063b4e6ab12fec53cc05}{Get\+Weight} (std\+::string key)
  24. \item
  25. void \hyperlink{classcore_1_1ObjectDataMap_a2d104f34385edf8c3fdfda7390c28bf5}{Put} (std\+::string key, double value, double weight)
  26. \item
  27. void \hyperlink{classcore_1_1ObjectDataMap_a5cdd71b9124b5ca41419a0049fbbdaa1}{Put} (std\+::string key, std\+::pair$<$ double, double $>$ value\+\_\+weight)
  28. \item
  29. virtual double \hyperlink{classcore_1_1ObjectDataMap_a7fcc9ef5b684f14d33711348610d9b74}{Compare\+To} (Object\+Data\+Ptr obj) const override
  30. \item
  31. virtual Object\+Data\+Ptr \hyperlink{classcore_1_1ObjectDataMap_ac6a739ea0509371929dbe7cbac601a3e}{Interpolate} (Object\+Data\+Ptr obj, double fraction) const override
  32. \item
  33. virtual void \hyperlink{classcore_1_1ObjectDataMap_a8a0f71318dd58e0d527a63b904c6afac}{Visualize} (cv\+::\+Mat \&image, cv\+::\+Scalar \&color) const override
  34. \end{DoxyCompactItemize}
  35. \subsection{Detailed Description}
  36. Stores a map of key-\/value-\/weight pairs. The weight is used to compare this object with other objects.
  37. \subsection{Constructor \& Destructor Documentation}
  38. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  39. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  40. \subsubsection[{\texorpdfstring{Object\+Data\+Map(size\+\_\+t frame\+\_\+index)}{ObjectDataMap(size\_t frame\_index)}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data\+Map\+::\+Object\+Data\+Map (
  41. \begin{DoxyParamCaption}
  42. \item[{size\+\_\+t}]{frame\+\_\+index}
  43. \end{DoxyParamCaption}
  44. )}\hypertarget{classcore_1_1ObjectDataMap_ac6df34682a715db6845667f7dda1c795}{}\label{classcore_1_1ObjectDataMap_ac6df34682a715db6845667f7dda1c795}
  45. Creates a new empty object data map.
  46. \begin{DoxyParams}{Parameters}
  47. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  48. \hline
  49. \end{DoxyParams}
  50. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  51. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  52. \subsubsection[{\texorpdfstring{Object\+Data\+Map(size\+\_\+t frame\+\_\+index, std\+::vector$<$ std\+::string $>$ keys, std\+::vector$<$ double $>$ value\+\_\+list)}{ObjectDataMap(size\_t frame\_index, std::vector< std::string > keys, std::vector< double > value\_list)}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data\+Map\+::\+Object\+Data\+Map (
  53. \begin{DoxyParamCaption}
  54. \item[{size\+\_\+t}]{frame\+\_\+index, }
  55. \item[{std\+::vector$<$ std\+::string $>$}]{keys, }
  56. \item[{std\+::vector$<$ double $>$}]{value\+\_\+list}
  57. \end{DoxyParamCaption}
  58. )}\hypertarget{classcore_1_1ObjectDataMap_a573add8d73646e6c5f183a9a0c159596}{}\label{classcore_1_1ObjectDataMap_a573add8d73646e6c5f183a9a0c159596}
  59. Creates a object data map with the given keys and values and an equal weight for every value.
  60. \begin{DoxyParams}{Parameters}
  61. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  62. \hline
  63. {\em keys} & The keys for the values to store \\
  64. \hline
  65. {\em value\+\_\+list} & The values to store with the given keys \\
  66. \hline
  67. \end{DoxyParams}
  68. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  69. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  70. \subsubsection[{\texorpdfstring{Object\+Data\+Map(size\+\_\+t frame\+\_\+index, std\+::vector$<$ std\+::string $>$ keys, std\+::vector$<$ double $>$ value\+\_\+list, std\+::vector$<$ double $>$ weight\+\_\+list)}{ObjectDataMap(size\_t frame\_index, std::vector< std::string > keys, std::vector< double > value\_list, std::vector< double > weight\_list)}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data\+Map\+::\+Object\+Data\+Map (
  71. \begin{DoxyParamCaption}
  72. \item[{size\+\_\+t}]{frame\+\_\+index, }
  73. \item[{std\+::vector$<$ std\+::string $>$}]{keys, }
  74. \item[{std\+::vector$<$ double $>$}]{value\+\_\+list, }
  75. \item[{std\+::vector$<$ double $>$}]{weight\+\_\+list}
  76. \end{DoxyParamCaption}
  77. )}\hypertarget{classcore_1_1ObjectDataMap_a5727c237d73f3f16c94a748c1b9b0c74}{}\label{classcore_1_1ObjectDataMap_a5727c237d73f3f16c94a748c1b9b0c74}
  78. Creates a object data map with the given keys and values and an given weight for the corresponding key-\/value pair.
  79. \begin{DoxyParams}{Parameters}
  80. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  81. \hline
  82. {\em keys} & The keys for the values to store \\
  83. \hline
  84. {\em value\+\_\+list} & The values to store with the given keys \\
  85. \hline
  86. {\em weight\+\_\+list} & The weights to store with the given key-\/value pairs \\
  87. \hline
  88. \end{DoxyParams}
  89. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  90. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  91. \subsubsection[{\texorpdfstring{Object\+Data\+Map(size\+\_\+t frame\+\_\+index, std\+::vector$<$ std\+::string $>$ keys, std\+::vector$<$ std\+::pair$<$ double, double $>$$>$ value\+\_\+weight\+\_\+list)}{ObjectDataMap(size\_t frame\_index, std::vector< std::string > keys, std::vector< std::pair< double, double >> value\_weight\_list)}}]{\setlength{\rightskip}{0pt plus 5cm}core\+::\+Object\+Data\+Map\+::\+Object\+Data\+Map (
  92. \begin{DoxyParamCaption}
  93. \item[{size\+\_\+t}]{frame\+\_\+index, }
  94. \item[{std\+::vector$<$ std\+::string $>$}]{keys, }
  95. \item[{std\+::vector$<$ std\+::pair$<$ double, double $>$$>$}]{value\+\_\+weight\+\_\+list}
  96. \end{DoxyParamCaption}
  97. )}\hypertarget{classcore_1_1ObjectDataMap_ad2af0de7438ed72be68348ac992568b6}{}\label{classcore_1_1ObjectDataMap_ad2af0de7438ed72be68348ac992568b6}
  98. Creates a object data map with the given keys and value-\/weight pairs.
  99. \begin{DoxyParams}{Parameters}
  100. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  101. \hline
  102. {\em keys} & The keys for the values to store \\
  103. \hline
  104. {\em value\+\_\+weight\+\_\+list} & The value-\/weight-\/pairs to store with the keys \\
  105. \hline
  106. \end{DoxyParams}
  107. \subsection{Member Function Documentation}
  108. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Compare\+To@{Compare\+To}}
  109. \index{Compare\+To@{Compare\+To}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  110. \subsubsection[{\texorpdfstring{Compare\+To(\+Object\+Data\+Ptr obj) const override}{CompareTo(ObjectDataPtr obj) const override}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Map\+::\+Compare\+To (
  111. \begin{DoxyParamCaption}
  112. \item[{Object\+Data\+Ptr}]{obj}
  113. \end{DoxyParamCaption}
  114. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataMap_a7fcc9ef5b684f14d33711348610d9b74}{}\label{classcore_1_1ObjectDataMap_a7fcc9ef5b684f14d33711348610d9b74}
  115. Compares this object with the given object.
  116. \begin{DoxyParams}{Parameters}
  117. {\em obj} & A pointer to the object to compare this object to \\
  118. \hline
  119. \end{DoxyParams}
  120. \begin{DoxyReturn}{Returns}
  121. A double value indicating the comparison result
  122. \end{DoxyReturn}
  123. Reimplemented from \hyperlink{classcore_1_1ObjectData_afbf7a1e87235f1b204d4d2eb8a37a9a6}{core\+::\+Object\+Data}.
  124. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Get\+Value@{Get\+Value}}
  125. \index{Get\+Value@{Get\+Value}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  126. \subsubsection[{\texorpdfstring{Get\+Value(std\+::string key)}{GetValue(std::string key)}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Map\+::\+Get\+Value (
  127. \begin{DoxyParamCaption}
  128. \item[{std\+::string}]{key}
  129. \end{DoxyParamCaption}
  130. )}\hypertarget{classcore_1_1ObjectDataMap_a276c89da6f3318d2baa2e9678e9508f7}{}\label{classcore_1_1ObjectDataMap_a276c89da6f3318d2baa2e9678e9508f7}
  131. Gets the value of the given key.
  132. \begin{DoxyParams}{Parameters}
  133. {\em key} & The key for the value \\
  134. \hline
  135. \end{DoxyParams}
  136. \begin{DoxyReturn}{Returns}
  137. The value
  138. \end{DoxyReturn}
  139. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Get\+Weight@{Get\+Weight}}
  140. \index{Get\+Weight@{Get\+Weight}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  141. \subsubsection[{\texorpdfstring{Get\+Weight(std\+::string key)}{GetWeight(std::string key)}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Map\+::\+Get\+Weight (
  142. \begin{DoxyParamCaption}
  143. \item[{std\+::string}]{key}
  144. \end{DoxyParamCaption}
  145. )}\hypertarget{classcore_1_1ObjectDataMap_a4cd92ab91559063b4e6ab12fec53cc05}{}\label{classcore_1_1ObjectDataMap_a4cd92ab91559063b4e6ab12fec53cc05}
  146. Gets the weight of the given key.
  147. \begin{DoxyParams}{Parameters}
  148. {\em key} & The key for the value \\
  149. \hline
  150. \end{DoxyParams}
  151. \begin{DoxyReturn}{Returns}
  152. The weight
  153. \end{DoxyReturn}
  154. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Interpolate@{Interpolate}}
  155. \index{Interpolate@{Interpolate}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  156. \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\+Map\+::\+Interpolate (
  157. \begin{DoxyParamCaption}
  158. \item[{Object\+Data\+Ptr}]{obj, }
  159. \item[{double}]{fraction}
  160. \end{DoxyParamCaption}
  161. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataMap_ac6a739ea0509371929dbe7cbac601a3e}{}\label{classcore_1_1ObjectDataMap_ac6a739ea0509371929dbe7cbac601a3e}
  162. Linearly interpolates between this and the given object. Creates a new object to fit between the two objects.
  163. \begin{DoxyParams}{Parameters}
  164. {\em obj} & A pointer to the target object \\
  165. \hline
  166. {\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. \\
  167. \hline
  168. \end{DoxyParams}
  169. \begin{DoxyReturn}{Returns}
  170. The interpolated object
  171. \end{DoxyReturn}
  172. Reimplemented from \hyperlink{classcore_1_1ObjectData_ad681915317decab76c384a635fc8444e}{core\+::\+Object\+Data}.
  173. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Put@{Put}}
  174. \index{Put@{Put}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  175. \subsubsection[{\texorpdfstring{Put(std\+::string key, double value, double weight)}{Put(std::string key, double value, double weight)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+Map\+::\+Put (
  176. \begin{DoxyParamCaption}
  177. \item[{std\+::string}]{key, }
  178. \item[{double}]{value, }
  179. \item[{double}]{weight}
  180. \end{DoxyParamCaption}
  181. )}\hypertarget{classcore_1_1ObjectDataMap_a2d104f34385edf8c3fdfda7390c28bf5}{}\label{classcore_1_1ObjectDataMap_a2d104f34385edf8c3fdfda7390c28bf5}
  182. Stores the given value-\/weight pair with the given key. If the key is already stored it will be overridden with the new pair.
  183. \begin{DoxyParams}{Parameters}
  184. {\em key} & The key to store the value-\/weight pair at \\
  185. \hline
  186. {\em value} & The value of the value-\/weight pair \\
  187. \hline
  188. {\em weight} & The weight of the value-\/weight pair \\
  189. \hline
  190. \end{DoxyParams}
  191. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Put@{Put}}
  192. \index{Put@{Put}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  193. \subsubsection[{\texorpdfstring{Put(std\+::string key, std\+::pair$<$ double, double $>$ value\+\_\+weight)}{Put(std::string key, std::pair< double, double > value\_weight)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+Map\+::\+Put (
  194. \begin{DoxyParamCaption}
  195. \item[{std\+::string}]{key, }
  196. \item[{std\+::pair$<$ double, double $>$}]{value\+\_\+weight}
  197. \end{DoxyParamCaption}
  198. )}\hypertarget{classcore_1_1ObjectDataMap_a5cdd71b9124b5ca41419a0049fbbdaa1}{}\label{classcore_1_1ObjectDataMap_a5cdd71b9124b5ca41419a0049fbbdaa1}
  199. Stores the given value-\/weight pair with the given key. If the key is already stored it will be overridden with the new pair.
  200. \begin{DoxyParams}{Parameters}
  201. {\em key} & The key to store the value-\/weight pair at \\
  202. \hline
  203. {\em value\+\_\+weight} & The value-\/weight pair \\
  204. \hline
  205. \end{DoxyParams}
  206. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Visualize@{Visualize}}
  207. \index{Visualize@{Visualize}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  208. \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\+Map\+::\+Visualize (
  209. \begin{DoxyParamCaption}
  210. \item[{cv\+::\+Mat \&}]{image, }
  211. \item[{cv\+::\+Scalar \&}]{color}
  212. \end{DoxyParamCaption}
  213. ) const\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataMap_a8a0f71318dd58e0d527a63b904c6afac}{}\label{classcore_1_1ObjectDataMap_a8a0f71318dd58e0d527a63b904c6afac}
  214. Visualizes the object in the given image with the given color. This method does nothing, it needs to be overwritten to visualize something.
  215. \begin{DoxyParams}{Parameters}
  216. {\em image} & The image to write into \\
  217. \hline
  218. {\em color} & The color to use \\
  219. \hline
  220. \end{DoxyParams}
  221. Reimplemented from \hyperlink{classcore_1_1ObjectData_aae2c4fceddc529570dbe8909309f9961}{core\+::\+Object\+Data}.
  222. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  223. \item
  224. core/Object\+Data\+Map.\+h\item
  225. core/Object\+Data\+Map.\+cpp\end{DoxyCompactItemize}