diff options
Diffstat (limited to 'Documentation/class_yolo_database.xhtml')
-rw-r--r-- | Documentation/class_yolo_database.xhtml | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/Documentation/class_yolo_database.xhtml b/Documentation/class_yolo_database.xhtml new file mode 100644 index 0000000000..e08126f143 --- /dev/null +++ b/Documentation/class_yolo_database.xhtml @@ -0,0 +1,219 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: YoloDatabase Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">20.02</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_yolo_database.xhtml','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="class_yolo_database-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">YoloDatabase Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_yolo_database_8hpp_source.xhtml">YoloDatabase.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a626407dd7c0a5e7d9299ac3deba502d7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="class_yolo_database.xhtml#a626407dd7c0a5e7d9299ac3deba502d7">TTestCaseData</a> = <a class="el" href="class_yolo_test_case_data.xhtml">YoloTestCaseData</a></td></tr> +<tr class="separator:a626407dd7c0a5e7d9299ac3deba502d7"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ae29cd81371801a0d70ac3dbd5adc01e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_yolo_database.xhtml#ae29cd81371801a0d70ac3dbd5adc01e5">YoloDatabase</a> (const std::string &imageDir)</td></tr> +<tr class="separator:ae29cd81371801a0d70ac3dbd5adc01e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4b1e13e320d157200130d2161a8d2070"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="class_yolo_database.xhtml#a626407dd7c0a5e7d9299ac3deba502d7">TTestCaseData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_yolo_database.xhtml#a4b1e13e320d157200130d2161a8d2070">GetTestCaseData</a> (unsigned int testCaseId)</td></tr> +<tr class="separator:a4b1e13e320d157200130d2161a8d2070"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<p class="definition">Definition at line <a class="el" href="_yolo_database_8hpp_source.xhtml#l00053">53</a> of file <a class="el" href="_yolo_database_8hpp_source.xhtml">YoloDatabase.hpp</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a626407dd7c0a5e7d9299ac3deba502d7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a626407dd7c0a5e7d9299ac3deba502d7">◆ </a></span>TTestCaseData</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">using <a class="el" href="class_yolo_database.xhtml#a626407dd7c0a5e7d9299ac3deba502d7">TTestCaseData</a> = <a class="el" href="class_yolo_test_case_data.xhtml">YoloTestCaseData</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_yolo_database_8hpp_source.xhtml#l00056">56</a> of file <a class="el" href="_yolo_database_8hpp_source.xhtml">YoloDatabase.hpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ae29cd81371801a0d70ac3dbd5adc01e5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae29cd81371801a0d70ac3dbd5adc01e5">◆ </a></span>YoloDatabase()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_yolo_database.xhtml">YoloDatabase</a> </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>imageDir</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_yolo_database_8cpp_source.xhtml#l00070">70</a> of file <a class="el" href="_yolo_database_8cpp_source.xhtml">YoloDatabase.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  : m_ImageDir(imageDir)</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a4b1e13e320d157200130d2161a8d2070"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4b1e13e320d157200130d2161a8d2070">◆ </a></span>GetTestCaseData()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::unique_ptr< <a class="el" href="class_yolo_database.xhtml#a626407dd7c0a5e7d9299ac3deba502d7">YoloDatabase::TTestCaseData</a> > GetTestCaseData </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"><em>testCaseId</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_yolo_database_8cpp_source.xhtml#l00075">75</a> of file <a class="el" href="_yolo_database_8cpp_source.xhtml">YoloDatabase.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_logging_8hpp_source.xhtml#l00163">ARMNN_LOG</a>, <a class="el" href="_exceptions_8hpp_source.xhtml#l00192">CHECK_LOCATION</a>, <a class="el" href="_inference_test_image_8cpp_source.xhtml#l00311">GetImageDataInArmNnLayoutAsNormalizedFloats()</a>, <a class="el" href="_numeric_cast_8hpp_source.xhtml#l00033">armnn::numeric_cast()</a>, <a class="el" href="_inference_test_image_8cpp_source.xhtml#l00209">InferenceTestImage::Resize()</a>, <a class="el" href="_inference_test_image_8hpp.xhtml#a5f7592b0a8fa09208cd32721cf207110aabe0e112dd5f40f1de00eccbf99798a3">Rgb</a>, <a class="el" href="_exceptions_8cpp_source.xhtml#l00032">Exception::what()</a>, <a class="el" href="_yolo_database_8hpp_source.xhtml#l00051">YoloImageHeight</a>, and <a class="el" href="_yolo_database_8hpp_source.xhtml#l00050">YoloImageWidth</a>.</p> +<div class="fragment"><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  testCaseId = testCaseId % <a class="code" href="namespacearmnn.xhtml#a37fa39012e90d568df7f774cd6d1e956">boost::numeric_cast</a><<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>>(g_PerTestCaseInputOutput.size());</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">const</span> <span class="keyword">auto</span>& testCaseInputOutput = g_PerTestCaseInputOutput[testCaseId];</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">const</span> std::string imagePath = m_ImageDir + testCaseInputOutput.first;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// Loads test case input image.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::vector<float> imageData;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">try</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="class_inference_test_image.xhtml">InferenceTestImage</a> image(imagePath.c_str());</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">if</span> (<a class="code" href="_yolo_database_8hpp.xhtml#a88c3339d57718f167a374ab572610ba8">YoloImageWidth</a> != image.GetWidth() || <a class="code" href="_yolo_database_8hpp.xhtml#af74f4ad1b33fe68237cb97c9345e9e87">YoloImageHeight</a> != image.GetHeight())</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  image.<a class="code" href="class_inference_test_image.xhtml#a4a6637c2a2952a14cb3a426133b67a73">Resize</a>(<a class="code" href="_yolo_database_8hpp.xhtml#a88c3339d57718f167a374ab572610ba8">YoloImageWidth</a>, <a class="code" href="_yolo_database_8hpp.xhtml#af74f4ad1b33fe68237cb97c9345e9e87">YoloImageHeight</a>, <a class="code" href="_exceptions_8hpp.xhtml#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a>());</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  imageData = <a class="code" href="_inference_test_image_8cpp.xhtml#a3f8ac82c346c723f775a383d22239182">GetImageDataInArmNnLayoutAsNormalizedFloats</a>(<a class="code" href="_inference_test_image_8hpp.xhtml#a5f7592b0a8fa09208cd32721cf207110aabe0e112dd5f40f1de00eccbf99798a3">ImageChannelLayout::Rgb</a>, image);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="class_inference_test_image_exception.xhtml">InferenceTestImageException</a>& e)</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a>(fatal) << <span class="stringliteral">"Failed to load test case "</span> << testCaseId << <span class="stringliteral">" with error: "</span> << e.<a class="code" href="classarmnn_1_1_exception.xhtml#abf843cbb29dec939d0731e491bab6f70">what</a>();</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// Prepares test case output.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  std::vector<YoloDetectedObject> topObjectDetections;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  topObjectDetections.reserve(1);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  topObjectDetections.push_back(testCaseInputOutput.second);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> std::make_unique<YoloTestCaseData>(std::move(imageData), std::move(topObjectDetections));</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> }</div><div class="ttc" id="_yolo_database_8hpp_xhtml_af74f4ad1b33fe68237cb97c9345e9e87"><div class="ttname"><a href="_yolo_database_8hpp.xhtml#af74f4ad1b33fe68237cb97c9345e9e87">YoloImageHeight</a></div><div class="ttdeci">constexpr unsigned int YoloImageHeight</div><div class="ttdef"><b>Definition:</b> <a href="_yolo_database_8hpp_source.xhtml#l00051">YoloDatabase.hpp:51</a></div></div> +<div class="ttc" id="classarmnn_1_1_exception_xhtml_abf843cbb29dec939d0731e491bab6f70"><div class="ttname"><a href="classarmnn_1_1_exception.xhtml#abf843cbb29dec939d0731e491bab6f70">armnn::Exception::what</a></div><div class="ttdeci">virtual const char * what() const noexcept override</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8cpp_source.xhtml#l00032">Exceptions.cpp:32</a></div></div> +<div class="ttc" id="_logging_8hpp_xhtml_a7b6ad073975f437ec38ca7d20154727f"><div class="ttname"><a href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a></div><div class="ttdeci">#define ARMNN_LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8hpp_source.xhtml#l00163">Logging.hpp:163</a></div></div> +<div class="ttc" id="class_inference_test_image_exception_xhtml"><div class="ttname"><a href="class_inference_test_image_exception.xhtml">InferenceTestImageException</a></div><div class="ttdef"><b>Definition:</b> <a href="_inference_test_image_8hpp_source.xhtml#l00015">InferenceTestImage.hpp:15</a></div></div> +<div class="ttc" id="_inference_test_image_8cpp_xhtml_a3f8ac82c346c723f775a383d22239182"><div class="ttname"><a href="_inference_test_image_8cpp.xhtml#a3f8ac82c346c723f775a383d22239182">GetImageDataInArmNnLayoutAsNormalizedFloats</a></div><div class="ttdeci">std::vector< float > GetImageDataInArmNnLayoutAsNormalizedFloats(ImageChannelLayout layout, const InferenceTestImage &image)</div><div class="ttdef"><b>Definition:</b> <a href="_inference_test_image_8cpp_source.xhtml#l00311">InferenceTestImage.cpp:311</a></div></div> +<div class="ttc" id="namespacearmnn_xhtml_a37fa39012e90d568df7f774cd6d1e956"><div class="ttname"><a href="namespacearmnn.xhtml#a37fa39012e90d568df7f774cd6d1e956">armnn::numeric_cast</a></div><div class="ttdeci">std::enable_if_t< std::is_unsigned< Source >::value &&std::is_unsigned< Dest >::value, Dest > numeric_cast(Source source)</div><div class="ttdef"><b>Definition:</b> <a href="_numeric_cast_8hpp_source.xhtml#l00033">NumericCast.hpp:33</a></div></div> +<div class="ttc" id="_exceptions_8hpp_xhtml_aa3be76aec4ce713822a5ea1ecbb7bc61"><div class="ttname"><a href="_exceptions_8hpp.xhtml#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a></div><div class="ttdeci">#define CHECK_LOCATION()</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00192">Exceptions.hpp:192</a></div></div> +<div class="ttc" id="class_inference_test_image_xhtml"><div class="ttname"><a href="class_inference_test_image.xhtml">InferenceTestImage</a></div><div class="ttdef"><b>Definition:</b> <a href="_inference_test_image_8hpp_source.xhtml#l00051">InferenceTestImage.hpp:51</a></div></div> +<div class="ttc" id="_yolo_database_8hpp_xhtml_a88c3339d57718f167a374ab572610ba8"><div class="ttname"><a href="_yolo_database_8hpp.xhtml#a88c3339d57718f167a374ab572610ba8">YoloImageWidth</a></div><div class="ttdeci">constexpr unsigned int YoloImageWidth</div><div class="ttdef"><b>Definition:</b> <a href="_yolo_database_8hpp_source.xhtml#l00050">YoloDatabase.hpp:50</a></div></div> +<div class="ttc" id="_inference_test_image_8hpp_xhtml_a5f7592b0a8fa09208cd32721cf207110aabe0e112dd5f40f1de00eccbf99798a3"><div class="ttname"><a href="_inference_test_image_8hpp.xhtml#a5f7592b0a8fa09208cd32721cf207110aabe0e112dd5f40f1de00eccbf99798a3">ImageChannelLayout::Rgb</a></div></div> +<div class="ttc" id="class_inference_test_image_xhtml_a4a6637c2a2952a14cb3a426133b67a73"><div class="ttname"><a href="class_inference_test_image.xhtml#a4a6637c2a2952a14cb3a426133b67a73">InferenceTestImage::Resize</a></div><div class="ttdeci">std::vector< float > Resize(unsigned int newWidth, unsigned int newHeight, const armnn::CheckLocation &location, const ResizingMethods meth=ResizingMethods::STB, const std::array< float, 3 > &mean={{0.0, 0.0, 0.0}}, const std::array< float, 3 > &stddev={{1.0, 1.0, 1.0}}, const float scale=255.0f)</div><div class="ttdef"><b>Definition:</b> <a href="_inference_test_image_8cpp_source.xhtml#l00209">InferenceTestImage.cpp:209</a></div></div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>tests/<a class="el" href="_yolo_database_8hpp_source.xhtml">YoloDatabase.hpp</a></li> +<li>tests/<a class="el" href="_yolo_database_8cpp_source.xhtml">YoloDatabase.cpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="class_yolo_database.xhtml">YoloDatabase</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:16 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |