blob: 4a722b2cddeaf6fd8f86cfb111cb683cfce4342c [file] [log] [blame]
<!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="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: CaffePreprocessor 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>
<link href="doxygen.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;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ArmNN
&#160;<span id="projectnumber">NotReleased</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_caffe_preprocessor.html','');});
</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> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_caffe_preprocessor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CaffePreprocessor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_caffe_preprocessor_8hpp_source.html">CaffePreprocessor.hpp</a>&gt;</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:a9d5c241a4bb952f78d140229d17f2465"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_caffe_preprocessor.html#a9d5c241a4bb952f78d140229d17f2465">DataType</a> = float</td></tr>
<tr class="separator:a9d5c241a4bb952f78d140229d17f2465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b6d5426d97a60215cdcd609dee35cc9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_caffe_preprocessor.html#a0b6d5426d97a60215cdcd609dee35cc9">TTestCaseData</a> = <a class="el" href="class_classifier_test_case_data.html">ClassifierTestCaseData</a>&lt; <a class="el" href="class_caffe_preprocessor.html#a9d5c241a4bb952f78d140229d17f2465">DataType</a> &gt;</td></tr>
<tr class="separator:a0b6d5426d97a60215cdcd609dee35cc9"><td class="memSeparator" colspan="2">&#160;</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:a6ca5a337226f4d2d85ffc3d95f39998e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_caffe_preprocessor.html#a6ca5a337226f4d2d85ffc3d95f39998e">CaffePreprocessor</a> (const std::string &amp;binaryFileDirectory, unsigned int width=227, unsigned int height=227, const std::vector&lt; <a class="el" href="_caffe_preprocessor_8hpp.html#aaf2811634c15da39d0966a444b780a55">ImageSet</a> &gt; &amp;imageSet=std::vector&lt; <a class="el" href="_caffe_preprocessor_8hpp.html#aaf2811634c15da39d0966a444b780a55">ImageSet</a> &gt;())</td></tr>
<tr class="separator:a6ca5a337226f4d2d85ffc3d95f39998e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21e0733780e895c0baf0072c51cbfd23"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="class_caffe_preprocessor.html#a0b6d5426d97a60215cdcd609dee35cc9">TTestCaseData</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_caffe_preprocessor.html#a21e0733780e895c0baf0072c51cbfd23">GetTestCaseData</a> (unsigned int testCaseId)</td></tr>
<tr class="separator:a21e0733780e895c0baf0072c51cbfd23"><td class="memSeparator" colspan="2">&#160;</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="_caffe_preprocessor_8hpp_source.html#l00018">18</a> of file <a class="el" href="_caffe_preprocessor_8hpp_source.html">CaffePreprocessor.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a9d5c241a4bb952f78d140229d17f2465"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d5c241a4bb952f78d140229d17f2465">&#9670;&nbsp;</a></span>DataType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="class_caffe_preprocessor.html#a9d5c241a4bb952f78d140229d17f2465">DataType</a> = float</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_caffe_preprocessor_8hpp_source.html#l00021">21</a> of file <a class="el" href="_caffe_preprocessor_8hpp_source.html">CaffePreprocessor.hpp</a>.</p>
</div>
</div>
<a id="a0b6d5426d97a60215cdcd609dee35cc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b6d5426d97a60215cdcd609dee35cc9">&#9670;&nbsp;</a></span>TTestCaseData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="class_caffe_preprocessor.html#a0b6d5426d97a60215cdcd609dee35cc9">TTestCaseData</a> = <a class="el" href="class_classifier_test_case_data.html">ClassifierTestCaseData</a>&lt;<a class="el" href="class_caffe_preprocessor.html#a9d5c241a4bb952f78d140229d17f2465">DataType</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_caffe_preprocessor_8hpp_source.html#l00022">22</a> of file <a class="el" href="_caffe_preprocessor_8hpp_source.html">CaffePreprocessor.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6ca5a337226f4d2d85ffc3d95f39998e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ca5a337226f4d2d85ffc3d95f39998e">&#9670;&nbsp;</a></span>CaffePreprocessor()</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_caffe_preprocessor.html">CaffePreprocessor</a> </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>binaryFileDirectory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>width</em> = <code>227</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>height</em> = <code>227</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="_caffe_preprocessor_8hpp.html#aaf2811634c15da39d0966a444b780a55">ImageSet</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>imageSet</em> = <code>std::vector&lt;<a class="el" href="_caffe_preprocessor_8hpp.html#aaf2811634c15da39d0966a444b780a55">ImageSet</a>&gt;()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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="_caffe_preprocessor_8cpp_source.html#l00021">21</a> of file <a class="el" href="_caffe_preprocessor_8cpp_source.html">CaffePreprocessor.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;: m_BinaryDirectory(binaryFileDirectory)</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;, m_Height(height)</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;, m_Width(width)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;, m_ImageSet(imageSet.empty() ? <a class="code" href="_caffe_preprocessor_8cpp.html#a2e3a3e9d1f061482dc3dfcc790dceb79">g_DefaultImageSet</a> : imageSet)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;}</div><div class="ttc" id="_caffe_preprocessor_8cpp_html_a2e3a3e9d1f061482dc3dfcc790dceb79"><div class="ttname"><a href="_caffe_preprocessor_8cpp.html#a2e3a3e9d1f061482dc3dfcc790dceb79">g_DefaultImageSet</a></div><div class="ttdeci">const std::vector&lt; ImageSet &gt; g_DefaultImageSet</div><div class="ttdef"><b>Definition:</b> <a href="_caffe_preprocessor_8cpp_source.html#l00016">CaffePreprocessor.cpp:16</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a21e0733780e895c0baf0072c51cbfd23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21e0733780e895c0baf0072c51cbfd23">&#9670;&nbsp;</a></span>GetTestCaseData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; <a class="el" href="class_caffe_preprocessor.html#a0b6d5426d97a60215cdcd609dee35cc9">CaffePreprocessor::TTestCaseData</a> &gt; GetTestCaseData </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</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="_caffe_preprocessor_8cpp_source.html#l00030">30</a> of file <a class="el" href="_caffe_preprocessor_8cpp_source.html">CaffePreprocessor.cpp</a>.</p>
<p class="reference">References <a class="el" href="_inference_test_image_8hpp.html#a5f7592b0a8fa09208cd32721cf207110a103b58155b4c5cc09249629e7ccd5dc2">Bgr</a>, <a class="el" href="_exceptions_8hpp_source.html#l00169">CHECK_LOCATION</a>, <a class="el" href="_inference_test_image_8cpp_source.html#l00322">GetImageDataInArmNnLayoutAsFloatsSubtractingMean()</a>, and <a class="el" href="_inference_test_image_8cpp_source.html#l00209">InferenceTestImage::Resize()</a>.</p>
<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; testCaseId = testCaseId % boost::numeric_cast&lt;<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>&gt;(m_ImageSet.size());</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">const</span> <a class="code" href="_caffe_preprocessor_8hpp.html#aaf2811634c15da39d0966a444b780a55">ImageSet</a>&amp; imageSet = m_ImageSet[testCaseId];</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">const</span> std::string fullPath = m_BinaryDirectory + imageSet.first;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="class_inference_test_image.html">InferenceTestImage</a> image(fullPath.c_str());</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; image.<a class="code" href="class_inference_test_image.html#a4a6637c2a2952a14cb3a426133b67a73">Resize</a>(m_Width, m_Height, <a class="code" href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a>());</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// The model expects image data in BGR format.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; std::vector&lt;float&gt; inputImageData = <a class="code" href="_inference_test_image_8cpp.html#a16f15d88afcc9c6bba231cc72bdd8cbf">GetImageDataInArmNnLayoutAsFloatsSubtractingMean</a>(<a class="code" href="_inference_test_image_8hpp.html#a5f7592b0a8fa09208cd32721cf207110a103b58155b4c5cc09249629e7ccd5dc2">ImageChannelLayout::Bgr</a>,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; image, m_MeanBgr);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// List of labels: https://gist.github.com/yrevar/942d3a0ac09ec9e5eb3a</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> label = imageSet.second;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;TTestCaseData&gt;(label, std::move(inputImageData));</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div><div class="ttc" id="_inference_test_image_8hpp_html_a5f7592b0a8fa09208cd32721cf207110a103b58155b4c5cc09249629e7ccd5dc2"><div class="ttname"><a href="_inference_test_image_8hpp.html#a5f7592b0a8fa09208cd32721cf207110a103b58155b4c5cc09249629e7ccd5dc2">ImageChannelLayout::Bgr</a></div></div>
<div class="ttc" id="_exceptions_8hpp_html_aa3be76aec4ce713822a5ea1ecbb7bc61"><div class="ttname"><a href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a></div><div class="ttdeci">#define CHECK_LOCATION()</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00169">Exceptions.hpp:169</a></div></div>
<div class="ttc" id="class_inference_test_image_html"><div class="ttname"><a href="class_inference_test_image.html">InferenceTestImage</a></div><div class="ttdef"><b>Definition:</b> <a href="_inference_test_image_8hpp_source.html#l00051">InferenceTestImage.hpp:51</a></div></div>
<div class="ttc" id="_inference_test_image_8cpp_html_a16f15d88afcc9c6bba231cc72bdd8cbf"><div class="ttname"><a href="_inference_test_image_8cpp.html#a16f15d88afcc9c6bba231cc72bdd8cbf">GetImageDataInArmNnLayoutAsFloatsSubtractingMean</a></div><div class="ttdeci">std::vector&lt; float &gt; GetImageDataInArmNnLayoutAsFloatsSubtractingMean(ImageChannelLayout layout, const InferenceTestImage &amp;image, const std::array&lt; float, 3 &gt; &amp;mean)</div><div class="ttdef"><b>Definition:</b> <a href="_inference_test_image_8cpp_source.html#l00322">InferenceTestImage.cpp:322</a></div></div>
<div class="ttc" id="class_inference_test_image_html_a4a6637c2a2952a14cb3a426133b67a73"><div class="ttname"><a href="class_inference_test_image.html#a4a6637c2a2952a14cb3a426133b67a73">InferenceTestImage::Resize</a></div><div class="ttdeci">std::vector&lt; float &gt; Resize(unsigned int newWidth, unsigned int newHeight, const armnn::CheckLocation &amp;location, const ResizingMethods meth=ResizingMethods::STB, const std::array&lt; float, 3 &gt; &amp;mean={{0.0, 0.0, 0.0}}, const std::array&lt; float, 3 &gt; &amp;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.html#l00209">InferenceTestImage.cpp:209</a></div></div>
<div class="ttc" id="_caffe_preprocessor_8hpp_html_aaf2811634c15da39d0966a444b780a55"><div class="ttname"><a href="_caffe_preprocessor_8hpp.html#aaf2811634c15da39d0966a444b780a55">ImageSet</a></div><div class="ttdeci">std::pair&lt; const std::string, unsigned int &gt; ImageSet</div><div class="ttdoc">Caffe requires BGR images, not normalized, mean adjusted and resized using smooth resize of STB libra...</div><div class="ttdef"><b>Definition:</b> <a href="_caffe_preprocessor_8hpp_source.html#l00016">CaffePreprocessor.hpp:16</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="_caffe_preprocessor_8hpp_source.html">CaffePreprocessor.hpp</a></li>
<li>tests/<a class="el" href="_caffe_preprocessor_8cpp_source.html">CaffePreprocessor.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_caffe_preprocessor.html">CaffePreprocessor</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:07:01 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>