org/apache/sis/image/PixelIterator.Builder.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>PixelIterator.Builder (Apache SIS 1.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.sis.image, class: PixelIterator, class: Builder">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.image.PixelIterator.Builder class">
 <meta name="keywords" content="setRegionOfInterest()">
 <meta name="keywords" content="setWindowSize()">
 <meta name="keywords" content="setIteratorOrder()">
 <meta name="keywords" content="create()">
 <meta name="keywords" content="createWritable()">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/PixelIterator.Builder.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <li>Nested</li>
 <li>Field</li>
 <li><a href="#constructor-summary">Constr</a></li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li>Field</li>
 <li><a href="#constructor-detail">Constr</a></li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a>
 <input type="text" id="search-input" disabled placeholder="Search">
 <input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.image</a></div>
 <h1 title="Class PixelIterator.Builder" class="title">Class PixelIterator.Builder</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance">Builder</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>Enclosing class:</dt>
 <dd><code><a href="PixelIterator.html" title="class in org.apache.sis.image">PixelIterator</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">PixelIterator.Builder</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 <div class="block">Builds pixel iterators for specified region of interest, window size or iteration order.
  By default, the builder creates iterators for all pixels in the given raster or image,
  with unspecified iteration order. Users can invoke setter methods for specifying
  desired behavior for the iterators to create.

  <div class="note"><b>Example:</b>
  <blockquote><pre>PixelIterator iterator = <font color="green">new</font> PixelIterator.<b>Builder</b>().<b>setRegionOfInterest</b>(<font color="green">new</font> <b>Rectangle</b>(10, 10, 5, 5).<b>create</b>(image);</pre></blockquote>
  </div></div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Builder</a>()</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new iterator builder with no region of interest, no window size and default iterator order.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PixelIterator.html" title="class in org.apache.sis.image">PixelIterator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#create(java.awt.image.Raster)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html" title="class or interface in java.awt.image" class="external-link">Raster</a>&nbsp;data)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates a read-only iterator for the given raster.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PixelIterator.html" title="class in org.apache.sis.image">PixelIterator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#create(java.awt.image.RenderedImage)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a>&nbsp;data)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates a read-only iterator for the given image.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createWritable(java.awt.image.Raster,java.awt.image.WritableRaster)" class="member-name-link">createWritable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html" title="class or interface in java.awt.image" class="external-link">Raster</a>&nbsp;input,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRaster.html" title="class or interface in java.awt.image" class="external-link">WritableRaster</a>&nbsp;output)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates an iterator which will read and write in two different rasters.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createWritable(java.awt.image.RenderedImage,java.awt.image.WritableRenderedImage)" class="member-name-link">createWritable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a>&nbsp;input,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRenderedImage.html" title="class or interface in java.awt.image" class="external-link">WritableRenderedImage</a>&nbsp;output)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates an iterator which will read and write in two different images.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createWritable(java.awt.image.WritableRaster)" class="member-name-link">createWritable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRaster.html" title="class or interface in java.awt.image" class="external-link">WritableRaster</a>&nbsp;data)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates a read/write iterator for the given raster.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createWritable(java.awt.image.WritableRenderedImage)" class="member-name-link">createWritable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRenderedImage.html" title="class or interface in java.awt.image" class="external-link">WritableRenderedImage</a>&nbsp;data)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates a read/write iterator for the given image.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PixelIterator.Builder.html" title="class in org.apache.sis.image">PixelIterator.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIteratorOrder(org.apache.sis.image.SequenceType)" class="member-name-link">setIteratorOrder</a><wbr>(<a href="SequenceType.html" title="enum class in org.apache.sis.image">SequenceType</a>&nbsp;order)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the desired iteration order.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PixelIterator.Builder.html" title="class in org.apache.sis.image">PixelIterator.Builder</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRegionOfInterest(java.awt.Rectangle)" class="member-name-link">setRegionOfInterest</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/Rectangle.html" title="class or interface in java.awt" class="external-link">Rectangle</a>&nbsp;subArea)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the region (in pixel coordinates) where to perform the iteration.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PixelIterator.Builder.html" title="class in org.apache.sis.image">PixelIterator.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setWindowSize(java.awt.Dimension)" class="member-name-link">setWindowSize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/Dimension.html" title="class or interface in java.awt" class="external-link">Dimension</a>&nbsp;window)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the size of the window to use in <a href="PixelIterator.html#createWindow(org.apache.sis.image.TransferType)"><code>PixelIterator.createWindow(TransferType)</code></a> method.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>Builder</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Builder</span>()</div>
 <div class="block">Creates a new iterator builder with no region of interest, no window size and default iterator order.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="setRegionOfInterest(java.awt.Rectangle)">
 <h3>setRegionOfInterest</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PixelIterator.Builder.html" title="class in org.apache.sis.image">PixelIterator.Builder</a></span>&nbsp;<span class="element-name">setRegionOfInterest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/Rectangle.html" title="class or interface in java.awt" class="external-link">Rectangle</a>&nbsp;subArea)</span></div>
 <div class="block">Sets the region (in pixel coordinates) where to perform the iteration.
  If this method is not invoked, then  by default iterators will traverse all pixels in the image or raster.
  If a sub-area is specified, then the traversed area is the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/Rectangle.html#intersection(java.awt.Rectangle)" title="class or interface in java.awt" class="external-link">intersection</a> of <code>subArea</code> with the image or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html#getBounds()" title="class or interface in java.awt.image" class="external-link">raster bounds</a>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>subArea</code> - region to intersect, or <code>null</code> for iterating over all image domain.</dd>
 <dt>Returns:</dt>
 <dd><code>this</code> for method call chaining.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given rectangle is empty.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setWindowSize(java.awt.Dimension)">
 <h3>setWindowSize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PixelIterator.Builder.html" title="class in org.apache.sis.image">PixelIterator.Builder</a></span>&nbsp;<span class="element-name">setWindowSize</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/Dimension.html" title="class or interface in java.awt" class="external-link">Dimension</a>&nbsp;window)</span></div>
 <div class="block">Sets the size of the window to use in <a href="PixelIterator.html#createWindow(org.apache.sis.image.TransferType)"><code>PixelIterator.createWindow(TransferType)</code></a> method.
  By default, iterators do not create windows.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>window</code> - the window size, or <code>null</code> if no window will be created.</dd>
 <dt>Returns:</dt>
 <dd><code>this</code> for method call chaining.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setIteratorOrder(org.apache.sis.image.SequenceType)">
 <h3>setIteratorOrder</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PixelIterator.Builder.html" title="class in org.apache.sis.image">PixelIterator.Builder</a></span>&nbsp;<span class="element-name">setIteratorOrder</span><wbr><span class="parameters">(<a href="SequenceType.html" title="enum class in org.apache.sis.image">SequenceType</a>&nbsp;order)</span></div>
 <div class="block">Sets the desired iteration order.
  The <code>order</code> argument can have the following values:

  <table class="sis">
    <caption>Supported iteration order</caption>
    <tr><th>Value</th>                         <th>Iteration order</th></tr>
    <tr><td><code>null</code></td>                  <td>Most efficient iteration order.</td></tr>
    <tr><td><a href="SequenceType.html#LINEAR"><code>SequenceType.LINEAR</code></a></td>   <td>From left to right, then from top to bottom.</td></tr>
  </table>

  Any other <code>order</code> value will cause an <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> to be thrown.
  More iteration orders may be supported in future Apache SIS versions.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>order</code> - the desired iteration order, or <code>null</code> for a default order.</dd>
 <dt>Returns:</dt>
 <dd><code>this</code> for method call chaining.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="create(java.awt.image.Raster)">
 <h3>create</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PixelIterator.html" title="class in org.apache.sis.image">PixelIterator</a></span>&nbsp;<span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html" title="class or interface in java.awt.image" class="external-link">Raster</a>&nbsp;data)</span></div>
 <div class="block">Creates a read-only iterator for the given raster.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>data</code> - the raster which contains the sample values on which to iterate.</dd>
 <dt>Returns:</dt>
 <dd>a new iterator traversing pixels in the given raster.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="create(java.awt.image.RenderedImage)">
 <h3>create</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PixelIterator.html" title="class in org.apache.sis.image">PixelIterator</a></span>&nbsp;<span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a>&nbsp;data)</span></div>
 <div class="block">Creates a read-only iterator for the given image.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>data</code> - the image which contains the sample values on which to iterate.</dd>
 <dt>Returns:</dt>
 <dd>a new iterator traversing pixels in the given image.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="createWritable(java.awt.image.WritableRaster)">
 <h3>createWritable</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></span>&nbsp;<span class="element-name">createWritable</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRaster.html" title="class or interface in java.awt.image" class="external-link">WritableRaster</a>&nbsp;data)</span></div>
 <div class="block">Creates a read/write iterator for the given raster.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>data</code> - the raster which contains the sample values on which to iterate.</dd>
 <dt>Returns:</dt>
 <dd>a new iterator traversing pixels in the given raster.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="createWritable(java.awt.image.WritableRenderedImage)">
 <h3>createWritable</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></span>&nbsp;<span class="element-name">createWritable</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRenderedImage.html" title="class or interface in java.awt.image" class="external-link">WritableRenderedImage</a>&nbsp;data)</span></div>
 <div class="block">Creates a read/write iterator for the given image.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>data</code> - the image which contains the sample values on which to iterate.</dd>
 <dt>Returns:</dt>
 <dd>a new iterator traversing pixels in the given image.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="createWritable(java.awt.image.Raster,java.awt.image.WritableRaster)">
 <h3>createWritable</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></span>&nbsp;<span class="element-name">createWritable</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/Raster.html" title="class or interface in java.awt.image" class="external-link">Raster</a>&nbsp;input,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRaster.html" title="class or interface in java.awt.image" class="external-link">WritableRaster</a>&nbsp;output)</span></div>
 <div class="block">Creates an iterator which will read and write in two different rasters.
  The two rasters must use the same sample model and have the same bounds.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>input</code> - the raster which contains the sample values to read.</dd>
 <dd><code>output</code> - the raster where to write the sample values. Can be the same than <code>input</code>.</dd>
 <dt>Returns:</dt>
 <dd>a new writable iterator.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="createWritable(java.awt.image.RenderedImage,java.awt.image.WritableRenderedImage)">
 <h3>createWritable</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></span>&nbsp;<span class="element-name">createWritable</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a>&nbsp;input,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/WritableRenderedImage.html" title="class or interface in java.awt.image" class="external-link">WritableRenderedImage</a>&nbsp;output)</span></div>
 <div class="block">Creates an iterator which will read and write in two different images.
  The two images must use the same sample model and have the same bounds.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>input</code> - the image which contains the sample values to read.</dd>
 <dd><code>output</code> - the image where to write the sample values. Can be the same than <code>input</code>.</dd>
 <dt>Returns:</dt>
 <dd>a new writable iterator.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>