| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.image (Apache SIS 1.4 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="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.feature, package: org.apache.sis.image"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.image package"> |
| <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"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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="../../../../module-summary.html">Module</a></li> |
| <li class="nav-bar-cell1-rev">Package</li> |
| <li>Class</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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li>Related Packages</li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li>Related Packages | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../module-summary.html">org.apache.sis.feature</a></div> |
| <h1 title="Package org.apache.sis.image" class="title">Package org.apache.sis.image</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.image</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides helper classes for handling Java2D rendered images together with some operations. |
| This package does not provide any geospatial functionalities; |
| it works only on sample or pixel values stored in <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link"><code>RenderedImage</code></a>s. |
| Those rendered images have the following capabilities: |
| |
| <ul> |
| <li>Images may have an arbitrary number of bands (not necessarily RGB).</li> |
| <li>Sample values can be bytes, shorts (signed or unsigned), integers or floating-point values.</li> |
| <li>Images can be tiled.</li> |
| </ul> |
| |
| This package is used as a basis for |
| <a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/spatial/DefaultGeorectified.html" title="class in org.apache.sis.metadata.iso.spatial">georectified</a> or |
| <a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/spatial/DefaultGeoreferenceable.html" title="class in org.apache.sis.metadata.iso.spatial">georeferenceable</a> |
| <cite>grid coverages</cite>. |
| |
| <h2 id="usage-note-heading">Usage note</h2> |
| Some images are writable. But modifying pixel values should be done by invoking the <code>getWritableTile(…)</code> |
| and <code>releaseWritableTile(…)</code> methods of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/WritableRenderedImage.html" title="class or interface in java.awt.image" class="external-link"><code>WritableRenderedImage</code></a> interface. |
| Do not cast directly a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/Raster.html" title="class or interface in java.awt.image" class="external-link"><code>Raster</code></a> to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/WritableRaster.html" title="class or interface in java.awt.image" class="external-link"><code>WritableRaster</code></a> |
| even when the cast is safe, because some raster data may be shared by many tiles having identical content. |
| Furthermore, changes in pixel values may be lost if <code>releaseWritableTile(…)</code> is not invoked.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Colorizer.html" title="interface in org.apache.sis.image">Colorizer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Colorization algorithm to apply for colorizing a computed image.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Colorizer.Target.html" title="class in org.apache.sis.image">Colorizer.Target</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about the computed image to colorize.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ComputedImage.html" title="class in org.apache.sis.image">ComputedImage</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An image with tiles computed on-the-fly and cached for future reuse.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="DataType.html" title="enum class in org.apache.sis.image">DataType</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Identification of the primitive type used for storing sample values in an image.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ErrorHandler.html" title="interface in org.apache.sis.image">ErrorHandler</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Action to perform when errors occurred while reading or writing some tiles in an image.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ErrorHandler.Report.html" title="class in org.apache.sis.image">ErrorHandler.Report</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about errors that occurred while reading or writing tiles in an image.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ImageCombiner.html" title="class in org.apache.sis.image">ImageCombiner</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Combines an arbitrary number of images into a single one.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ImageProcessor.html" title="class in org.apache.sis.image">ImageProcessor</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A predefined set of operations on images.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="ImageProcessor.Mode.html" title="enum class in org.apache.sis.image">ImageProcessor.Mode</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">Execution modes specifying whether operations can be executed in parallel.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ImageProcessor.Resizing.html" title="enum class in org.apache.sis.image">ImageProcessor.Resizing</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Whether <code>ImageProcessor</code> can produce an image of different size compared to requested size.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Interpolation.html" title="class in org.apache.sis.image">Interpolation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Algorithm for image interpolation (resampling).</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PixelIterator.html" title="class in org.apache.sis.image">PixelIterator</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An iterator over sample values in a raster or an image.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="PixelIterator.Builder.html" title="class in org.apache.sis.image">PixelIterator.Builder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Builds pixel iterators for specified region of interest, window size or iteration order.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PixelIterator.Window.html" title="class in org.apache.sis.image">PixelIterator.Window</a><T extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/Buffer.html" title="class or interface in java.nio" class="external-link">Buffer</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Contains the sample values in a moving window over the image.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link"><code>RenderedImage</code></a> implementations in Apache SIS.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ResampledImage.html" title="class in org.apache.sis.image">ResampledImage</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An image which is the result of resampling the pixel values of another image.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="SequenceType.html" title="enum class in org.apache.sis.image">SequenceType</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">Specifies the order in which attribute value records are assigned to grid points.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TransferType.html" title="class in org.apache.sis.image">TransferType</a><T extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/Buffer.html" title="class or interface in java.nio" class="external-link">Buffer</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The type of data used to transfer pixels.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="WritablePixelIterator.html" title="class in org.apache.sis.image">WritablePixelIterator</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A pixel iterator capable to write sample values.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
