classcore_1_1ObjectDataMap.tex 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  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_a61eb1326be41c3411dc0c1757f360591}{Put\+Value\+Weight} (std\+::string key, double value, double weight)
  26. \item
  27. void \hyperlink{classcore_1_1ObjectDataMap_a8c2ef0cebadf12e4aa67056823020cc3}{Put\+Value\+Weight} (std\+::string key, std\+::pair$<$ double, double $>$ value\+\_\+weight)
  28. \item
  29. virtual double \hyperlink{classcore_1_1ObjectDataMap_ad00d1998652e4d2ffa2629128c9c2947}{Compare\+To} (\hyperlink{classcore_1_1ObjectData}{Object\+Data} $\ast$obj)
  30. \item
  31. virtual double \hyperlink{classcore_1_1ObjectDataMap_a38ec46bab19a5770cecb00533e8d37c3}{Compare\+To} (\hyperlink{classcore_1_1ObjectDataMap}{Object\+Data\+Map} $\ast$obj)
  32. \end{DoxyCompactItemize}
  33. \subsection*{Protected Member Functions}
  34. \begin{DoxyCompactItemize}
  35. \item
  36. virtual void \hyperlink{classcore_1_1ObjectDataMap_a16fbcc2b99feb1545e1a66f828680b1a}{Print} (std\+::ostream \&os) const
  37. \end{DoxyCompactItemize}
  38. \subsection*{Additional Inherited Members}
  39. \subsection{Detailed Description}
  40. Stores a map of key-\/value-\/weight pairs. The weight is used to compare this object with other objects.
  41. \subsection{Constructor \& Destructor Documentation}
  42. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  43. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  44. \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 (
  45. \begin{DoxyParamCaption}
  46. \item[{size\+\_\+t}]{frame\+\_\+index}
  47. \end{DoxyParamCaption}
  48. )}\hypertarget{classcore_1_1ObjectDataMap_ac6df34682a715db6845667f7dda1c795}{}\label{classcore_1_1ObjectDataMap_ac6df34682a715db6845667f7dda1c795}
  49. Creates a new empty object data map.
  50. \begin{DoxyParams}{Parameters}
  51. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  52. \hline
  53. \end{DoxyParams}
  54. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  55. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  56. \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 (
  57. \begin{DoxyParamCaption}
  58. \item[{size\+\_\+t}]{frame\+\_\+index, }
  59. \item[{std\+::vector$<$ std\+::string $>$}]{keys, }
  60. \item[{std\+::vector$<$ double $>$}]{value\+\_\+list}
  61. \end{DoxyParamCaption}
  62. )}\hypertarget{classcore_1_1ObjectDataMap_a573add8d73646e6c5f183a9a0c159596}{}\label{classcore_1_1ObjectDataMap_a573add8d73646e6c5f183a9a0c159596}
  63. Creates a object data map with the given keys and values and an equal weight for every value.
  64. \begin{DoxyParams}{Parameters}
  65. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  66. \hline
  67. {\em keys} & The keys for the values to store \\
  68. \hline
  69. {\em value\+\_\+list} & The values to store with the given keys \\
  70. \hline
  71. \end{DoxyParams}
  72. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  73. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  74. \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 (
  75. \begin{DoxyParamCaption}
  76. \item[{size\+\_\+t}]{frame\+\_\+index, }
  77. \item[{std\+::vector$<$ std\+::string $>$}]{keys, }
  78. \item[{std\+::vector$<$ double $>$}]{value\+\_\+list, }
  79. \item[{std\+::vector$<$ double $>$}]{weight\+\_\+list}
  80. \end{DoxyParamCaption}
  81. )}\hypertarget{classcore_1_1ObjectDataMap_a5727c237d73f3f16c94a748c1b9b0c74}{}\label{classcore_1_1ObjectDataMap_a5727c237d73f3f16c94a748c1b9b0c74}
  82. Creates a object data map with the given keys and values and an given weight for the corresponding key-\/value pair.
  83. \begin{DoxyParams}{Parameters}
  84. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  85. \hline
  86. {\em keys} & The keys for the values to store \\
  87. \hline
  88. {\em value\+\_\+list} & The values to store with the given keys \\
  89. \hline
  90. {\em weight\+\_\+list} & The weights to store with the given key-\/value pairs \\
  91. \hline
  92. \end{DoxyParams}
  93. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Object\+Data\+Map@{Object\+Data\+Map}}
  94. \index{Object\+Data\+Map@{Object\+Data\+Map}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  95. \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 (
  96. \begin{DoxyParamCaption}
  97. \item[{size\+\_\+t}]{frame\+\_\+index, }
  98. \item[{std\+::vector$<$ std\+::string $>$}]{keys, }
  99. \item[{std\+::vector$<$ std\+::pair$<$ double, double $>$$>$}]{value\+\_\+weight\+\_\+list}
  100. \end{DoxyParamCaption}
  101. )}\hypertarget{classcore_1_1ObjectDataMap_ad2af0de7438ed72be68348ac992568b6}{}\label{classcore_1_1ObjectDataMap_ad2af0de7438ed72be68348ac992568b6}
  102. Creates a object data map with the given keys and value-\/weight pairs.
  103. \begin{DoxyParams}{Parameters}
  104. {\em frame\+\_\+index} & The index of the frame this object was detected in \\
  105. \hline
  106. {\em keys} & The keys for the values to store \\
  107. \hline
  108. {\em value\+\_\+weight\+\_\+list} & The value-\/weight-\/pairs to store with the keys \\
  109. \hline
  110. \end{DoxyParams}
  111. \subsection{Member Function Documentation}
  112. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Compare\+To@{Compare\+To}}
  113. \index{Compare\+To@{Compare\+To}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  114. \subsubsection[{\texorpdfstring{Compare\+To(\+Object\+Data $\ast$obj)}{CompareTo(ObjectData *obj)}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Map\+::\+Compare\+To (
  115. \begin{DoxyParamCaption}
  116. \item[{{\bf Object\+Data} $\ast$}]{obj}
  117. \end{DoxyParamCaption}
  118. )\hspace{0.3cm}{\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataMap_ad00d1998652e4d2ffa2629128c9c2947}{}\label{classcore_1_1ObjectDataMap_ad00d1998652e4d2ffa2629128c9c2947}
  119. Compares this object with the given object by calculating the difference in every value and applies the corresponding weight to that difference. Than all weighted differences are summed up.
  120. \begin{DoxyParams}{Parameters}
  121. {\em obj} & A pointer to the object to compare this object to \\
  122. \hline
  123. \end{DoxyParams}
  124. \begin{DoxyReturn}{Returns}
  125. The summed up weighted differences
  126. \end{DoxyReturn}
  127. Reimplemented from \hyperlink{classcore_1_1ObjectData_a01f04d64b1e62f567d819a8fcbe38319}{core\+::\+Object\+Data}.
  128. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Compare\+To@{Compare\+To}}
  129. \index{Compare\+To@{Compare\+To}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  130. \subsubsection[{\texorpdfstring{Compare\+To(\+Object\+Data\+Map $\ast$obj)}{CompareTo(ObjectDataMap *obj)}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Map\+::\+Compare\+To (
  131. \begin{DoxyParamCaption}
  132. \item[{{\bf Object\+Data\+Map} $\ast$}]{obj}
  133. \end{DoxyParamCaption}
  134. )\hspace{0.3cm}{\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataMap_a38ec46bab19a5770cecb00533e8d37c3}{}\label{classcore_1_1ObjectDataMap_a38ec46bab19a5770cecb00533e8d37c3}
  135. Compares this object with the given object by calculating the difference in every value and applies the corresponding weight to that difference. Than all weighted differences are summed up.
  136. \begin{DoxyParams}{Parameters}
  137. {\em obj} & A pointer to the object to compare this object to \\
  138. \hline
  139. \end{DoxyParams}
  140. \begin{DoxyReturn}{Returns}
  141. The summed up weighted differences
  142. \end{DoxyReturn}
  143. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Get\+Value@{Get\+Value}}
  144. \index{Get\+Value@{Get\+Value}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  145. \subsubsection[{\texorpdfstring{Get\+Value(std\+::string key)}{GetValue(std::string key)}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Map\+::\+Get\+Value (
  146. \begin{DoxyParamCaption}
  147. \item[{std\+::string}]{key}
  148. \end{DoxyParamCaption}
  149. )}\hypertarget{classcore_1_1ObjectDataMap_a276c89da6f3318d2baa2e9678e9508f7}{}\label{classcore_1_1ObjectDataMap_a276c89da6f3318d2baa2e9678e9508f7}
  150. Gets the value of the given key.
  151. \begin{DoxyParams}{Parameters}
  152. {\em key} & The key for the value \\
  153. \hline
  154. \end{DoxyParams}
  155. \begin{DoxyReturn}{Returns}
  156. The value
  157. \end{DoxyReturn}
  158. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Get\+Weight@{Get\+Weight}}
  159. \index{Get\+Weight@{Get\+Weight}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  160. \subsubsection[{\texorpdfstring{Get\+Weight(std\+::string key)}{GetWeight(std::string key)}}]{\setlength{\rightskip}{0pt plus 5cm}double core\+::\+Object\+Data\+Map\+::\+Get\+Weight (
  161. \begin{DoxyParamCaption}
  162. \item[{std\+::string}]{key}
  163. \end{DoxyParamCaption}
  164. )}\hypertarget{classcore_1_1ObjectDataMap_a4cd92ab91559063b4e6ab12fec53cc05}{}\label{classcore_1_1ObjectDataMap_a4cd92ab91559063b4e6ab12fec53cc05}
  165. Gets the weight of the given key.
  166. \begin{DoxyParams}{Parameters}
  167. {\em key} & The key for the value \\
  168. \hline
  169. \end{DoxyParams}
  170. \begin{DoxyReturn}{Returns}
  171. The weight
  172. \end{DoxyReturn}
  173. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Print@{Print}}
  174. \index{Print@{Print}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  175. \subsubsection[{\texorpdfstring{Print(std\+::ostream \&os) const}{Print(std::ostream \&os) const}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+Map\+::\+Print (
  176. \begin{DoxyParamCaption}
  177. \item[{std\+::ostream \&}]{os}
  178. \end{DoxyParamCaption}
  179. ) const\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}\hypertarget{classcore_1_1ObjectDataMap_a16fbcc2b99feb1545e1a66f828680b1a}{}\label{classcore_1_1ObjectDataMap_a16fbcc2b99feb1545e1a66f828680b1a}
  180. Used in the $<$$<$ operator
  181. \begin{DoxyParams}{Parameters}
  182. {\em os} & The stream to write to \\
  183. \hline
  184. \end{DoxyParams}
  185. Reimplemented from \hyperlink{classcore_1_1ObjectData_aa26949b0456068d67802d9f6067aa657}{core\+::\+Object\+Data}.
  186. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Put\+Value\+Weight@{Put\+Value\+Weight}}
  187. \index{Put\+Value\+Weight@{Put\+Value\+Weight}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  188. \subsubsection[{\texorpdfstring{Put\+Value\+Weight(std\+::string key, double value, double weight)}{PutValueWeight(std::string key, double value, double weight)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+Map\+::\+Put\+Value\+Weight (
  189. \begin{DoxyParamCaption}
  190. \item[{std\+::string}]{key, }
  191. \item[{double}]{value, }
  192. \item[{double}]{weight}
  193. \end{DoxyParamCaption}
  194. )}\hypertarget{classcore_1_1ObjectDataMap_a61eb1326be41c3411dc0c1757f360591}{}\label{classcore_1_1ObjectDataMap_a61eb1326be41c3411dc0c1757f360591}
  195. Stores the given value-\/weight pair with the given key. If the key is already stored it will be overridden with the new pair.
  196. \begin{DoxyParams}{Parameters}
  197. {\em key} & The key to store the value-\/weight pair at \\
  198. \hline
  199. {\em value} & The value of the value-\/weight pair \\
  200. \hline
  201. {\em weight} & The weight of the value-\/weight pair \\
  202. \hline
  203. \end{DoxyParams}
  204. \index{core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}!Put\+Value\+Weight@{Put\+Value\+Weight}}
  205. \index{Put\+Value\+Weight@{Put\+Value\+Weight}!core\+::\+Object\+Data\+Map@{core\+::\+Object\+Data\+Map}}
  206. \subsubsection[{\texorpdfstring{Put\+Value\+Weight(std\+::string key, std\+::pair$<$ double, double $>$ value\+\_\+weight)}{PutValueWeight(std::string key, std::pair< double, double > value\_weight)}}]{\setlength{\rightskip}{0pt plus 5cm}void core\+::\+Object\+Data\+Map\+::\+Put\+Value\+Weight (
  207. \begin{DoxyParamCaption}
  208. \item[{std\+::string}]{key, }
  209. \item[{std\+::pair$<$ double, double $>$}]{value\+\_\+weight}
  210. \end{DoxyParamCaption}
  211. )}\hypertarget{classcore_1_1ObjectDataMap_a8c2ef0cebadf12e4aa67056823020cc3}{}\label{classcore_1_1ObjectDataMap_a8c2ef0cebadf12e4aa67056823020cc3}
  212. Stores the given value-\/weight pair with the given key. If the key is already stored it will be overridden with the new pair.
  213. \begin{DoxyParams}{Parameters}
  214. {\em key} & The key to store the value-\/weight pair at \\
  215. \hline
  216. {\em value\+\_\+weight} & The value-\/weight pair \\
  217. \hline
  218. \end{DoxyParams}
  219. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  220. \item
  221. core/Object\+Data\+Map.\+h\item
  222. core/Object\+Data\+Map.\+cpp\end{DoxyCompactItemize}