blob: 0b01f38d9d01795f006e505f6ececf0fbc34c58a [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>Image - MXNet - org.apache.mxnet.Image</title>
<meta name="description" content="Image - MXNet - org.apache.mxnet.Image" />
<meta name="keywords" content="Image MXNet org.apache.mxnet.Image" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../../lib/jquery.js" id="jquery-js"></script>
<script type="text/javascript" src="../../../lib/jquery-ui.js"></script>
<script type="text/javascript" src="../../../lib/template.js"></script>
<script type="text/javascript" src="../../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
if(top === self) {
var url = '../../../index.html';
var hash = 'org.apache.mxnet.Image$';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="value">
<div id="definition">
<img alt="Object" src="../../../lib/object_big.png" />
<p id="owner"><a href="../../package.html" class="extype" name="org">org</a>.<a href="../package.html" class="extype" name="org.apache">apache</a>.<a href="package.html" class="extype" name="org.apache.mxnet">mxnet</a></p>
<h1>Image</h1><h3><span class="morelinks"><div>Related Doc:
<a href="package.html" class="extype" name="org.apache.mxnet">package mxnet</a>
</div></span></h3><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<span class="name">Image</span>
</span>
</h4>
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Image API of Scala package
enable OpenCV feature
</p></div><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
<li class="inherit out"><span>By Inheritance</span></li>
</ol>
</div>
<div id="ancestors">
<span class="filtertype">Inherited<br />
</span>
<ol id="linearization">
<li class="in" name="org.apache.mxnet.Image"><span>Image</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
</ol>
</div><div id="ancestors">
<span class="filtertype"></span>
<ol>
<li class="hideall out"><span>Hide All</span></li>
<li class="showall in"><span>Show All</span></li>
</ol>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="!=(x$1:Any):Boolean"></a>
<a id="!=(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@!=(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="##():Int"></a>
<a id="##():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@##():Int" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="==(x$1:Any):Boolean"></a>
<a id="==(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@==(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="asInstanceOf[T0]:T0"></a>
<a id="asInstanceOf[T0]:T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@asInstanceOf[T0]:T0" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="clone():Object"></a>
<a id="clone():AnyRef"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@clone():Object" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="org.apache.mxnet.Image#copyMakeBorder" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="copyMakeBorder(src:org.apache.mxnet.NDArray,top:Int,bot:Int,left:Int,right:Int,typeOf:Option[Int],value:Option[Double],values:Option[Any],out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray"></a>
<a id="copyMakeBorder(NDArray,Int,Int,Int,Int,Option[Int],Option[Double],Option[Any],Option[NDArray]):NDArray"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">copyMakeBorder</span><span class="params">(<span name="src">src: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>, <span name="top">top: <span class="extype" name="scala.Int">Int</span></span>, <span name="bot">bot: <span class="extype" name="scala.Int">Int</span></span>, <span name="left">left: <span class="extype" name="scala.Int">Int</span></span>, <span name="right">right: <span class="extype" name="scala.Int">Int</span></span>, <span name="typeOf">typeOf: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Int">Int</span>] = <span class="symbol">None</span></span>, <span name="value">value: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Double">Double</span>] = <span class="symbol">None</span></span>, <span name="values">values: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Any">Any</span>] = <span class="symbol">None</span></span>, <span name="out">out: <span class="extype" name="scala.Option">Option</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>] = <span class="symbol">None</span></span>)</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@copyMakeBorder(src:org.apache.mxnet.NDArray,top:Int,bot:Int,left:Int,right:Int,typeOf:Option[Int],value:Option[Double],values:Option[Any],out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Pad image border with OpenCV.</p><div class="fullcomment"><div class="comment cmt"><p>Pad image border with OpenCV.</p></div><dl class="paramcmts block"><dt class="param">src</dt><dd class="cmt"><p>source image</p></dd><dt class="param">top</dt><dd class="cmt"><p>Top margin.</p></dd><dt class="param">bot</dt><dd class="cmt"><p>Bottom margin.</p></dd><dt class="param">left</dt><dd class="cmt"><p>Left margin.</p></dd><dt class="param">right</dt><dd class="cmt"><p>Right margin.</p></dd><dt class="param">typeOf</dt><dd class="cmt"><p>Filling type (default=cv2.BORDER_CONSTANT).</p></dd><dt class="param">value</dt><dd class="cmt"><p>(Deprecated! Use <code><code>values</code></code> instead.) Fill with single value.</p></dd><dt class="param">values</dt><dd class="cmt"><p>Fill with value(RGB[A] or gray), up to 4 channels.</p></dd><dt class="param">out</dt><dd class="cmt"><p>NDArray to store the output</p></dd><dt>returns</dt><dd class="cmt"><p>org.apache.mxnet.NDArray</p></dd></dl></div>
</li><li name="org.apache.mxnet.Image#drawBoundingBox" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="drawBoundingBox(src:java.awt.image.BufferedImage,coordinate:Array[Map[String,Int]],names:Option[Array[String]],stroke:Option[Int],fontSizeMult:Option[Float],transparency:Option[Float]):Unit"></a>
<a id="drawBoundingBox(BufferedImage,Array[Map[String,Int]],Option[Array[String]],Option[Int],Option[Float],Option[Float]):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">drawBoundingBox</span><span class="params">(<span name="src">src: <span class="extype" name="java.awt.image.BufferedImage">BufferedImage</span></span>, <span name="coordinate">coordinate: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Int">Int</span>]]</span>, <span name="names">names: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.String">String</span>]] = <span class="symbol">None</span></span>, <span name="stroke">stroke: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Int">Int</span>] = <span class="symbol">Some(3)</span></span>, <span name="fontSizeMult">fontSizeMult: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Float">Float</span>] = <span class="symbol">Some(1.0f)</span></span>, <span name="transparency">transparency: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Float">Float</span>] = <span class="symbol">Some(1.0f)</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@drawBoundingBox(src:java.awt.image.BufferedImage,coordinate:Array[Map[String,Int]],names:Option[Array[String]],stroke:Option[Int],fontSizeMult:Option[Float],transparency:Option[Float]):Unit" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Method to draw bounding boxes for an image</p><div class="fullcomment"><div class="comment cmt"><p>Method to draw bounding boxes for an image</p></div><dl class="paramcmts block"><dt class="param">src</dt><dd class="cmt"><p>Source of the buffered image</p></dd><dt class="param">coordinate</dt><dd class="cmt"><p>Contains Map of xmin, xmax, ymin, ymax
corresponding to top-left and down-right points</p></dd><dt class="param">names</dt><dd class="cmt"><p>The name set of the bounding box</p></dd><dt class="param">stroke</dt><dd class="cmt"><p>Thickness of the bounding box</p></dd><dt class="param">fontSizeMult</dt><dd class="cmt"><p>Font size multiplier</p></dd><dt class="param">transparency</dt><dd class="cmt"><p>Transparency of the bounding box</p></dd></dl></div>
</li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="eq(x$1:AnyRef):Boolean"></a>
<a id="eq(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="equals(x$1:Any):Boolean"></a>
<a id="equals(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@equals(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="finalize():Unit"></a>
<a id="finalize():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@finalize():Unit" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="symbol">classOf[java.lang.Throwable]</span>
</span>)</span>
</dd></dl></div>
</li><li name="org.apache.mxnet.Image#fixedCrop" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="fixedCrop(src:org.apache.mxnet.NDArray,x0:Int,y0:Int,w:Int,h:Int):org.apache.mxnet.NDArray"></a>
<a id="fixedCrop(NDArray,Int,Int,Int,Int):NDArray"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">fixedCrop</span><span class="params">(<span name="src">src: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>, <span name="x0">x0: <span class="extype" name="scala.Int">Int</span></span>, <span name="y0">y0: <span class="extype" name="scala.Int">Int</span></span>, <span name="w">w: <span class="extype" name="scala.Int">Int</span></span>, <span name="h">h: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@fixedCrop(src:org.apache.mxnet.NDArray,x0:Int,y0:Int,w:Int,h:Int):org.apache.mxnet.NDArray" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Do a fixed crop on the image</p><div class="fullcomment"><div class="comment cmt"><p>Do a fixed crop on the image</p></div><dl class="paramcmts block"><dt class="param">src</dt><dd class="cmt"><p>Src image in NDArray</p></dd><dt class="param">x0</dt><dd class="cmt"><p>starting x point</p></dd><dt class="param">y0</dt><dd class="cmt"><p>starting y point</p></dd><dt class="param">w</dt><dd class="cmt"><p>width of the image</p></dd><dt class="param">h</dt><dd class="cmt"><p>height of the image</p></dd><dt>returns</dt><dd class="cmt"><p>cropped NDArray</p></dd></dl></div>
</li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getClass():Class[_]"></a>
<a id="getClass():Class[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@getClass():Class[_]" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="hashCode():Int"></a>
<a id="hashCode():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@hashCode():Int" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="org.apache.mxnet.Image#imDecode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="imDecode(inputStream:java.io.InputStream,flag:Int,to_rgb:Boolean,out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray"></a>
<a id="imDecode(InputStream,Int,Boolean,Option[NDArray]):NDArray"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">imDecode</span><span class="params">(<span name="inputStream">inputStream: <span class="extype" name="java.io.InputStream">InputStream</span></span>, <span name="flag">flag: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">1</span></span>, <span name="to_rgb">to_rgb: <span class="extype" name="scala.Boolean">Boolean</span> = <span class="symbol">true</span></span>, <span name="out">out: <span class="extype" name="scala.Option">Option</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>] = <span class="symbol">None</span></span>)</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@imDecode(inputStream:java.io.InputStream,flag:Int,to_rgb:Boolean,out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Same imageDecode with InputStream</p><div class="fullcomment"><div class="comment cmt"><p>Same imageDecode with InputStream</p></div><dl class="paramcmts block"><dt class="param">inputStream</dt><dd class="cmt"><p>the inputStream of the image</p></dd><dt class="param">flag</dt><dd class="cmt"><p>Convert decoded image to grayscale (0) or color (1).</p></dd><dt class="param">to_rgb</dt><dd class="cmt"><p>Whether to convert decoded image
to mxnet's default RGB format (instead of opencv's default BGR).</p></dd><dt class="param">out</dt><dd class="cmt"><p>NDArray to store the output</p></dd><dt>returns</dt><dd class="cmt"><p>NDArray in HWC format with DType <a href="DType$.html#UInt8:org.apache.mxnet.DType.Value" class="extmbr" name="org.apache.mxnet.DType#UInt8">DType.UInt8</a></p></dd></dl></div>
</li><li name="org.apache.mxnet.Image#imDecode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="imDecode(buf:Array[Byte],flag:Int,to_rgb:Boolean,out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray"></a>
<a id="imDecode(Array[Byte],Int,Boolean,Option[NDArray]):NDArray"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">imDecode</span><span class="params">(<span name="buf">buf: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Byte">Byte</span>]</span>, <span name="flag">flag: <span class="extype" name="scala.Int">Int</span></span>, <span name="to_rgb">to_rgb: <span class="extype" name="scala.Boolean">Boolean</span></span>, <span name="out">out: <span class="extype" name="scala.Option">Option</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>)</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@imDecode(buf:Array[Byte],flag:Int,to_rgb:Boolean,out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Decode image with OpenCV.</p><div class="fullcomment"><div class="comment cmt"><p>Decode image with OpenCV.
Note: return image in RGB by default, instead of OpenCV's default BGR.</p></div><dl class="paramcmts block"><dt class="param">buf</dt><dd class="cmt"><p>Buffer containing binary encoded image</p></dd><dt class="param">flag</dt><dd class="cmt"><p>Convert decoded image to grayscale (0) or color (1).</p></dd><dt class="param">to_rgb</dt><dd class="cmt"><p>Whether to convert decoded image
to mxnet's default RGB format (instead of opencv's default BGR).</p></dd><dt class="param">out</dt><dd class="cmt"><p>NDArray to store the output</p></dd><dt>returns</dt><dd class="cmt"><p>NDArray in HWC format with DType <a href="DType$.html#UInt8:org.apache.mxnet.DType.Value" class="extmbr" name="org.apache.mxnet.DType#UInt8">DType.UInt8</a></p></dd></dl></div>
</li><li name="org.apache.mxnet.Image#imRead" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="imRead(filename:String,flag:Option[Int],to_rgb:Option[Boolean],out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray"></a>
<a id="imRead(String,Option[Int],Option[Boolean],Option[NDArray]):NDArray"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">imRead</span><span class="params">(<span name="filename">filename: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="flag">flag: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Int">Int</span>] = <span class="symbol">None</span></span>, <span name="to_rgb">to_rgb: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Boolean">Boolean</span>] = <span class="symbol">None</span></span>, <span name="out">out: <span class="extype" name="scala.Option">Option</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>] = <span class="symbol">None</span></span>)</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@imRead(filename:String,flag:Option[Int],to_rgb:Option[Boolean],out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Read and decode image with OpenCV.</p><div class="fullcomment"><div class="comment cmt"><p>Read and decode image with OpenCV.
Note: return image in RGB by default, instead of OpenCV's default BGR.</p></div><dl class="paramcmts block"><dt class="param">filename</dt><dd class="cmt"><p>Name of the image file to be loaded.</p></dd><dt class="param">flag</dt><dd class="cmt"><p>Convert decoded image to grayscale (0) or color (1).</p></dd><dt class="param">to_rgb</dt><dd class="cmt"><p>Whether to convert decoded image to mxnet's default RGB format
(instead of opencv's default BGR).</p></dd><dt class="param">out</dt><dd class="cmt"><p>NDArray to store the output</p></dd><dt>returns</dt><dd class="cmt"><p>org.apache.mxnet.NDArray in HWC format with DType <a href="DType$.html#UInt8:org.apache.mxnet.DType.Value" class="extmbr" name="org.apache.mxnet.DType#UInt8">DType.UInt8</a></p></dd></dl></div>
</li><li name="org.apache.mxnet.Image#imResize" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="imResize(src:org.apache.mxnet.NDArray,w:Int,h:Int,interp:Option[Int],out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray"></a>
<a id="imResize(NDArray,Int,Int,Option[Int],Option[NDArray]):NDArray"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">imResize</span><span class="params">(<span name="src">src: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>, <span name="w">w: <span class="extype" name="scala.Int">Int</span></span>, <span name="h">h: <span class="extype" name="scala.Int">Int</span></span>, <span name="interp">interp: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Int">Int</span>] = <span class="symbol">None</span></span>, <span name="out">out: <span class="extype" name="scala.Option">Option</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>] = <span class="symbol">None</span></span>)</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@imResize(src:org.apache.mxnet.NDArray,w:Int,h:Int,interp:Option[Int],out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArray" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Resize image with OpenCV.</p><div class="fullcomment"><div class="comment cmt"><p>Resize image with OpenCV.</p></div><dl class="paramcmts block"><dt class="param">src</dt><dd class="cmt"><p>source image in NDArray</p></dd><dt class="param">w</dt><dd class="cmt"><p>Width of resized image.</p></dd><dt class="param">h</dt><dd class="cmt"><p>Height of resized image.</p></dd><dt class="param">interp</dt><dd class="cmt"><p>Interpolation method (default=cv2.INTER_LINEAR).</p></dd><dt class="param">out</dt><dd class="cmt"><p>NDArray to store the output</p></dd><dt>returns</dt><dd class="cmt"><p>org.apache.mxnet.NDArray</p></dd></dl></div>
</li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="isInstanceOf[T0]:Boolean"></a>
<a id="isInstanceOf[T0]:Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@isInstanceOf[T0]:Boolean" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="ne(x$1:AnyRef):Boolean"></a>
<a id="ne(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notify():Unit"></a>
<a id="notify():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@notify():Unit" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notifyAll():Unit"></a>
<a id="notifyAll():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@notifyAll():Unit" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="synchronized[T0](x$1:=&gt;T0):T0"></a>
<a id="synchronized[T0](⇒T0):T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@synchronized[T0](x$1:=&gt;T0):T0" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="org.apache.mxnet.Image#toImage" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="toImage(src:org.apache.mxnet.NDArray):java.awt.image.BufferedImage"></a>
<a id="toImage(NDArray):BufferedImage"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">toImage</span><span class="params">(<span name="src">src: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>)</span><span class="result">: <span class="extype" name="java.awt.image.BufferedImage">BufferedImage</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@toImage(src:org.apache.mxnet.NDArray):java.awt.image.BufferedImage" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Convert a NDArray image to a real image
The time cost will increase if the image resolution is big</p><div class="fullcomment"><div class="comment cmt"><p>Convert a NDArray image to a real image
The time cost will increase if the image resolution is big</p></div><dl class="paramcmts block"><dt class="param">src</dt><dd class="cmt"><p>Source image file in RGB</p></dd><dt>returns</dt><dd class="cmt"><p>Buffered Image</p></dd></dl></div>
</li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="toString():String"></a>
<a id="toString():String"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@toString():String" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait():Unit"></a>
<a id="wait():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@wait():Unit" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long,x$2:Int):Unit"></a>
<a id="wait(Long,Int):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long):Unit"></a>
<a id="wait(Long):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#org.apache.mxnet.Image$@wait(x$1:Long):Unit" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
<div class="parent" name="scala.AnyRef">
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
</div><div class="parent" name="scala.Any">
<h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
</div>
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</html>