blob: 3a023adff4366b33049928d234983f811b463952 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!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.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: FileImageFeeder 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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" async="async" 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="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">20.02.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarm__compute_1_1utils_1_1_file_image_feeder.xhtml','');});
/* @license-end */
</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-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">FileImageFeeder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>File <a class="el" href="struct_image.xhtml" title="Structure to hold Image information.">Image</a> feeder concrete implementation.
<a href="classarm__compute_1_1utils_1_1_file_image_feeder.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_image_loader_8h_source.xhtml">ImageLoader.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for FileImageFeeder:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1utils_1_1_file_image_feeder__coll__graph.svg" width="150" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
<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:a72f5e7f7f675855cd757c284c3767b0f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_file_image_feeder.xhtml#a72f5e7f7f675855cd757c284c3767b0f">FileImageFeeder</a> (std::ifstream &amp;fs)</td></tr>
<tr class="memdesc:a72f5e7f7f675855cd757c284c3767b0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="#a72f5e7f7f675855cd757c284c3767b0f">More...</a><br /></td></tr>
<tr class="separator:a72f5e7f7f675855cd757c284c3767b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c390fc2fcfbbd7af032f03d0750d494"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_file_image_feeder.xhtml#a7c390fc2fcfbbd7af032f03d0750d494">get</a> () override</td></tr>
<tr class="memdesc:a7c390fc2fcfbbd7af032f03d0750d494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a character from an image feed. <a href="#a7c390fc2fcfbbd7af032f03d0750d494">More...</a><br /></td></tr>
<tr class="separator:a7c390fc2fcfbbd7af032f03d0750d494"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3dfd581be9d71ccba4e1b03ecc0d684"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_file_image_feeder.xhtml#aa3dfd581be9d71ccba4e1b03ecc0d684">get_row</a> (uint8_t *dst, size_t row_size) override</td></tr>
<tr class="memdesc:aa3dfd581be9d71ccba4e1b03ecc0d684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Feed a whole row to a destination pointer. <a href="#aa3dfd581be9d71ccba4e1b03ecc0d684">More...</a><br /></td></tr>
<tr class="separator:aa3dfd581be9d71ccba4e1b03ecc0d684"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classarm__compute_1_1utils_1_1_i_image_data_feeder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1utils_1_1_i_image_data_feeder')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1utils_1_1_i_image_data_feeder.xhtml">IImageDataFeeder</a></td></tr>
<tr class="memitem:aa83bce0f78d159e993775ee2a1bdf116 inherit pub_methods_classarm__compute_1_1utils_1_1_i_image_data_feeder"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_i_image_data_feeder.xhtml#aa83bce0f78d159e993775ee2a1bdf116">~IImageDataFeeder</a> ()=default</td></tr>
<tr class="memdesc:aa83bce0f78d159e993775ee2a1bdf116 inherit pub_methods_classarm__compute_1_1utils_1_1_i_image_data_feeder"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual base destructor. <a href="classarm__compute_1_1utils_1_1_i_image_data_feeder.xhtml#aa83bce0f78d159e993775ee2a1bdf116">More...</a><br /></td></tr>
<tr class="separator:aa83bce0f78d159e993775ee2a1bdf116 inherit pub_methods_classarm__compute_1_1utils_1_1_i_image_data_feeder"><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>File <a class="el" href="struct_image.xhtml" title="Structure to hold Image information.">Image</a> feeder concrete implementation. </p>
<p class="definition">Definition at line <a class="el" href="_image_loader_8h_source.xhtml#l00064">64</a> of file <a class="el" href="_image_loader_8h_source.xhtml">ImageLoader.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a72f5e7f7f675855cd757c284c3767b0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72f5e7f7f675855cd757c284c3767b0f">&#9670;&nbsp;</a></span>FileImageFeeder()</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="classarm__compute_1_1utils_1_1_file_image_feeder.xhtml">FileImageFeeder</a> </td>
<td>(</td>
<td class="paramtype">std::ifstream &amp;&#160;</td>
<td class="paramname"><em>fs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fs</td><td><a class="el" href="struct_image.xhtml" title="Structure to hold Image information.">Image</a> file stream </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_image_loader_8h_source.xhtml#l00071">71</a> of file <a class="el" href="_image_loader_8h_source.xhtml">ImageLoader.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; : _fs(fs)</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7c390fc2fcfbbd7af032f03d0750d494"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c390fc2fcfbbd7af032f03d0750d494">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a character from an image feed. </p>
<p>Implements <a class="el" href="classarm__compute_1_1utils_1_1_i_image_data_feeder.xhtml#ae18857a90dabdfda0bf26ee448f46652">IImageDataFeeder</a>.</p>
<p class="definition">Definition at line <a class="el" href="_image_loader_8h_source.xhtml#l00076">76</a> of file <a class="el" href="_image_loader_8h_source.xhtml">ImageLoader.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">return</span> _fs.get();</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<a id="aa3dfd581be9d71ccba4e1b03ecc0d684"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3dfd581be9d71ccba4e1b03ecc0d684">&#9670;&nbsp;</a></span>get_row()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void get_row </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>row_size</em>&#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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Feed a whole row to a destination pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Destination pointer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">row_size</td><td>Row size in terms of bytes </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classarm__compute_1_1utils_1_1_i_image_data_feeder.xhtml#a352ac249fbff257dddef6eb8792cd648">IImageDataFeeder</a>.</p>
<p class="definition">Definition at line <a class="el" href="_image_loader_8h_source.xhtml#l00080">80</a> of file <a class="el" href="_image_loader_8h_source.xhtml">ImageLoader.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#adbf67dcee294e673cf796f1ed8aeb6a4">dst</a> == <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; _fs.read(reinterpret_cast&lt;std::fstream::char_type *&gt;(<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#adbf67dcee294e673cf796f1ed8aeb6a4">dst</a>), row_size);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div>
<div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_adbf67dcee294e673cf796f1ed8aeb6a4"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#adbf67dcee294e673cf796f1ed8aeb6a4">arm_compute::test::validation::dst</a></div><div class="ttdeci">CLTensor dst</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_2_absolute_difference_8cpp_source.xhtml#l00102">AbsoluteDifference.cpp:102</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00466">ARM_COMPUTE_ERROR_ON</a>, and <a class="el" href="_c_l_2_absolute_difference_8cpp_source.xhtml#l00102">arm_compute::test::validation::dst</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>utils/<a class="el" href="_image_loader_8h_source.xhtml">ImageLoader.h</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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1utils.xhtml">utils</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1utils_1_1_file_image_feeder.xhtml">FileImageFeeder</a></li>
<li class="footer">Generated on Thu Mar 5 2020 16:07:20 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>