| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>ResampledImage (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, class: ResampledImage"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.image.ResampledImage class"> |
| <meta name="keywords" content="POSITIONAL_CONSISTENCY_KEY"> |
| <meta name="keywords" content="toSource"> |
| <meta name="keywords" content="interpolation"> |
| <meta name="keywords" content="verify()"> |
| <meta name="keywords" content="getColorModel()"> |
| <meta name="keywords" content="getProperty()"> |
| <meta name="keywords" content="getPropertyNames()"> |
| <meta name="keywords" content="getMinTileX()"> |
| <meta name="keywords" content="getMinTileY()"> |
| <meta name="keywords" content="getMinX()"> |
| <meta name="keywords" content="getMinY()"> |
| <meta name="keywords" content="getWidth()"> |
| <meta name="keywords" content="getHeight()"> |
| <meta name="keywords" content="computeTile()"> |
| <meta name="keywords" content="prefetch()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <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="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"> </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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li><a href="#field-summary">Field</a></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><a href="#field-detail">Field</a></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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.feature</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.image</a></div> |
| <h1 title="Class ResampledImage" class="title">Class ResampledImage</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a> |
| <div class="inheritance"><a href="ComputedImage.html" title="class in org.apache.sis.image">ComputedImage</a> |
| <div class="inheritance">ResampledImage</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><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">RenderedImage</a></code>, <code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Disposable.html" title="interface in org.apache.sis.util">Disposable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ResampledImage</span> |
| <span class="extends-implements">extends <a href="ComputedImage.html" title="class in org.apache.sis.image">ComputedImage</a></span></div> |
| <div class="block">An image which is the result of resampling the pixel values of another image. |
| Resampling is the action of computing pixel values at possibly non-integral positions of a source image. |
| It can be used for projecting an image to another coordinate reference system, |
| for example from (<var>latitude</var>, <var>longitude</var>) to World Mercator. |
| The resampling is defined by a non-linear <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>MathTransform</code></a> (for example a map projection) |
| which converts pixel center coordinates from <em>this</em> image to pixel center coordinates |
| in the <em>source</em> image. |
| The converted coordinates usually contain fraction digits, in which case an interpolation is applied. |
| |
| <h2 id="usage-note-heading">Usage note</h2> |
| This class should be used with non-linear transforms such as map projections. It is technically |
| possible to use this class with linear transforms such as <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link"><code>AffineTransform</code></a>, |
| but there is more efficient alternatives for linear cases (for example |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Graphics2D.html#drawRenderedImage(java.awt.image.RenderedImage,java.awt.geom.AffineTransform)" title="class or interface in java.awt" class="external-link">specifying the affine transform at rendering time</a>).</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="Interpolation.html" title="class in org.apache.sis.image"><code>Interpolation</code></a></li> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/AffineTransformOp.html" title="class or interface in java.awt.image" class="external-link"><code>AffineTransformOp</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected final <a href="Interpolation.html" title="class in org.apache.sis.image">Interpolation</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#interpolation" class="member-name-link">interpolation</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The object to use for performing interpolations.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#POSITIONAL_CONSISTENCY_KEY" class="member-name-link">POSITIONAL_CONSISTENCY_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Key of a property providing an estimation of positional error for each pixel.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected final <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#toSource" class="member-name-link">toSource</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Conversion from pixel center coordinates of <em>this</em> image to pixel center coordinates of <em>source</em> |
| image.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-ComputedImage">Fields inherited from class <a href="ComputedImage.html" title="class in org.apache.sis.image">ComputedImage</a></h3> |
| <code><a href="ComputedImage.html#sampleModel">sampleModel</a>, <a href="ComputedImage.html#SOURCE_PADDING_KEY">SOURCE_PADDING_KEY</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-PlanarImage">Fields inherited from class <a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></h3> |
| <code><a href="PlanarImage.html#GRID_GEOMETRY_KEY">GRID_GEOMETRY_KEY</a>, <a href="PlanarImage.html#MASK_KEY">MASK_KEY</a>, <a href="PlanarImage.html#POSITIONAL_ACCURACY_KEY">POSITIONAL_ACCURACY_KEY</a>, <a href="PlanarImage.html#SAMPLE_DIMENSIONS_KEY">SAMPLE_DIMENSIONS_KEY</a>, <a href="PlanarImage.html#SAMPLE_RESOLUTIONS_KEY">SAMPLE_RESOLUTIONS_KEY</a>, <a href="PlanarImage.html#STATISTICS_KEY">STATISTICS_KEY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== 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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.awt.image.RenderedImage,java.awt.image.SampleModel,java.awt.Point,java.awt.Rectangle,org.opengis.referencing.operation.MathTransform,org.apache.sis.image.Interpolation,java.lang.Number%5B%5D,javax.measure.Quantity%5B%5D)" class="member-name-link">ResampledImage</a><wbr>(<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">RenderedImage</a> source, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/SampleModel.html" title="class or interface in java.awt.image" class="external-link">SampleModel</a> sampleModel, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Point.html" title="class or interface in java.awt" class="external-link">Point</a> minTile, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html" title="class or interface in java.awt" class="external-link">Rectangle</a> bounds, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a> toSource, |
| <a href="Interpolation.html" title="class in org.apache.sis.image">Interpolation</a> interpolation, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[] fillValues, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a><?>[] accuracy)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new image which will resample the given image.</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>protected <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">Raster</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#computeTile(int,int,java.awt.image.WritableRaster)" class="member-name-link">computeTile</a><wbr>(int tileX, |
| int tileY, |
| <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">WritableRaster</a> tile)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Invoked when a tile need to be computed or updated.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares the given object with this image for equality.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/ColorModel.html" title="class or interface in java.awt.image" class="external-link">ColorModel</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColorModel()" class="member-name-link">getColorModel</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the color model of this resampled image.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeight()" class="member-name-link">getHeight</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of rows in this image.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinTileX()" class="member-name-link">getMinTileX</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minimum tile index in the <var>x</var> direction.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinTileY()" class="member-name-link">getMinTileY</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minimum tile index in the <var>y</var> direction.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinX()" class="member-name-link">getMinX</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minimum <var>x</var> coordinate (inclusive) of this image.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinY()" class="member-name-link">getMinY</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minimum <var>y</var> coordinate (inclusive) of this image.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProperty(java.lang.String)" class="member-name-link">getProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets a property from this image.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPropertyNames()" class="member-name-link">getPropertyNames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the names of all recognized properties, or <code>null</code> if this image has no properties.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWidth()" class="member-name-link">getWidth</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of columns in this image.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a hash code value for this image.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../../../../../org.apache.sis.util/org/apache/sis/util/Disposable.html" title="interface in org.apache.sis.util">Disposable</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prefetch(java.awt.Rectangle)" class="member-name-link">prefetch</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html" title="class or interface in java.awt" class="external-link">Rectangle</a> tiles)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Notifies the source image that tiles will be computed soon in the given region.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#verify()" class="member-name-link">verify</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Verifies whether image layout information are consistent.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-ComputedImage">Methods inherited from class <a href="ComputedImage.html" title="class in org.apache.sis.image">ComputedImage</a></h3> |
| <code><a href="ComputedImage.html#clearErrorFlags(java.awt.Rectangle)">clearErrorFlags</a>, <a href="ComputedImage.html#createTile(int,int)">createTile</a>, <a href="ComputedImage.html#dispose()">dispose</a>, <a href="ComputedImage.html#getSampleModel()">getSampleModel</a>, <a href="ComputedImage.html#getSource(int)">getSource</a>, <a href="ComputedImage.html#getSources()">getSources</a>, <a href="ComputedImage.html#getTile(int,int)">getTile</a>, <a href="ComputedImage.html#getTileHeight()">getTileHeight</a>, <a href="ComputedImage.html#getTileWidth()">getTileWidth</a>, <a href="ComputedImage.html#getWritableTileIndices()">getWritableTileIndices</a>, <a href="ComputedImage.html#hasTileWriters()">hasTileWriters</a>, <a href="ComputedImage.html#isTileWritable(int,int)">isTileWritable</a>, <a href="ComputedImage.html#markDirtyTiles(java.awt.Rectangle)">markDirtyTiles</a>, <a href="ComputedImage.html#markTileWritable(int,int,boolean)">markTileWritable</a>, <a href="ComputedImage.html#sourceTileChanged(java.awt.image.RenderedImage,int,int)">sourceTileChanged</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-PlanarImage">Methods inherited from class <a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></h3> |
| <code><a href="PlanarImage.html#copyData(java.awt.image.WritableRaster)">copyData</a>, <a href="PlanarImage.html#getBounds()">getBounds</a>, <a href="PlanarImage.html#getData()">getData</a>, <a href="PlanarImage.html#getData(java.awt.Rectangle)">getData</a>, <a href="PlanarImage.html#getNumXTiles()">getNumXTiles</a>, <a href="PlanarImage.html#getNumYTiles()">getNumYTiles</a>, <a href="PlanarImage.html#getTileGridXOffset()">getTileGridXOffset</a>, <a href="PlanarImage.html#getTileGridYOffset()">getTileGridYOffset</a>, <a href="PlanarImage.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="POSITIONAL_CONSISTENCY_KEY"> |
| <h3>POSITIONAL_CONSISTENCY_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">POSITIONAL_CONSISTENCY_KEY</span></div> |
| <div class="block">Key of a property providing an estimation of positional error for each pixel. |
| Values shall be instances 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> with same size and origin than this image. |
| The image should contain a single band where all sample values are error estimations in pixel units |
| (relative to pixels of this image). The value should be small, for example between 0 and 0.2. |
| |
| <p>The default implementation transforms all pixel coordinates <a href="#toSource">to source</a>, |
| then convert them back to pixel coordinates in this image. The result is compared with expected |
| coordinates and the distance is stored in the image.</p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="PlanarImage.html#POSITIONAL_ACCURACY_KEY"><code>PlanarImage.POSITIONAL_ACCURACY_KEY</code></a></li> |
| <li><a href="../../../../../constant-values.html#org.apache.sis.image.ResampledImage.POSITIONAL_CONSISTENCY_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSource"> |
| <h3>toSource</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></span> <span class="element-name">toSource</span></div> |
| <div class="block">Conversion from pixel center coordinates of <em>this</em> image to pixel center coordinates of <em>source</em> |
| image. This transform should be an instance of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform2D.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>MathTransform2D</code></a>, but this is not required by this class |
| (a future version may allow interpolations in a <var>n</var>-dimensional cube).</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/PixelInCell.html#CELL_CENTER" title="class or interface in org.opengis.referencing.datum" class="external-link"><code>PixelInCell.CELL_CENTER</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="interpolation"> |
| <h3>interpolation</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="Interpolation.html" title="class in org.apache.sis.image">Interpolation</a></span> <span class="element-name">interpolation</span></div> |
| <div class="block">The object to use for performing interpolations.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.awt.image.RenderedImage,java.awt.image.SampleModel,java.awt.Point,java.awt.Rectangle,org.opengis.referencing.operation.MathTransform,org.apache.sis.image.Interpolation,java.lang.Number[],javax.measure.Quantity[])"> |
| <h3>ResampledImage</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">ResampledImage</span><wbr><span class="parameters">(<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">RenderedImage</a> source, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/SampleModel.html" title="class or interface in java.awt.image" class="external-link">SampleModel</a> sampleModel, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Point.html" title="class or interface in java.awt" class="external-link">Point</a> minTile, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html" title="class or interface in java.awt" class="external-link">Rectangle</a> bounds, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a> toSource, |
| <a href="Interpolation.html" title="class in org.apache.sis.image">Interpolation</a> interpolation, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[] fillValues, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a><?>[] accuracy)</span></div> |
| <div class="block">Creates a new image which will resample the given image. The resampling operation is defined |
| by a potentially non-linear transform from <em>this</em> image to the specified <em>source</em> image. |
| That transform should map <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/PixelInCell.html#CELL_CENTER" title="class or interface in org.opengis.referencing.datum" class="external-link">pixel centers</a>. |
| |
| <p>The <code>sampleModel</code> determines the tile size and the target data type. This is often the same sample |
| model than the one used by the <code>source</code> image, but may also be different for forcing a different tile |
| size or a different data type (e.g. <code>byte</code> versus <code>float</code>) for storing resampled values. |
| If the specified sample model is not the same than the one used by the source image, |
| then subclass should override <a href="#getColorModel()"><code>getColorModel()</code></a> for returning a color model which is |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/ColorModel.html#isCompatibleSampleModel(java.awt.image.SampleModel)" title="class or interface in java.awt.image" class="external-link">compatible with the sample model</a>.</p> |
| |
| <p>If a pixel in this image cannot be mapped to a pixel in the source image, then the sample values are set |
| to <code>fillValues</code>. If the given array is <code>null</code>, or if any element in the given array is <code>null</code>, |
| then the default fill value is NaN for floating point data types or zero for integer data types. |
| If the array is shorter than the number of bands, then above-cited default values are used for missing values. |
| If longer than the number of bands, extraneous values are ignored.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the image to be resampled.</dd> |
| <dd><code>sampleModel</code> - the sample model shared by all tiles in this resampled image.</dd> |
| <dd><code>minTile</code> - indices of the first tile (<code>minTileX</code>, <code>minTileY</code>), or <code>null</code> for (0,0).</dd> |
| <dd><code>bounds</code> - domain of pixel coordinates of this resampled image.</dd> |
| <dd><code>toSource</code> - conversion of pixel coordinates of this image to pixel coordinates of <code>source</code> image.</dd> |
| <dd><code>interpolation</code> - the object to use for performing interpolations.</dd> |
| <dd><code>fillValues</code> - the values to use for pixels in this image that cannot be mapped to pixels in source image. |
| May be <code>null</code> or contain <code>null</code> elements, and may have any length |
| (see above for more details).</dd> |
| <dd><code>accuracy</code> - values of <a href="PlanarImage.html#POSITIONAL_ACCURACY_KEY">"org.apache.sis.PositionalAccuracy"</a> property, or <code>null</code> if none. |
| This constructor may retain only a subset of specified values or replace some of them. |
| If an accuracy is specified in <a href="../../../../../org.apache.sis.util/org/apache/sis/measure/Units.html#PIXEL">pixel units</a>, then a value such as |
| 0.125 pixel may enable the use of a slightly faster algorithm at the expense of accuracy. |
| This is only a hint honored on a <em>best-effort</em> basis.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="ImageProcessor.html#resample(java.awt.image.RenderedImage,java.awt.Rectangle,org.opengis.referencing.operation.MathTransform)"><code>ImageProcessor.resample(RenderedImage, Rectangle, MathTransform)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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="verify()"> |
| <h3>verify</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">verify</span>()</div> |
| <div class="block">Verifies whether image layout information are consistent. This method verifies that source coordinates |
| required by this image (computed by converting <a href="PlanarImage.html#getBounds()">this image bounds</a> using the |
| <a href="#toSource"><code>toSource</code></a> transform) intersects the bounds of the source image. If this is not the case, then |
| this method returns <code>"toSource"</code> for signaling that the transform may have a problem. |
| Otherwise this method completes the check with all verifications |
| <a href="PlanarImage.html#verify()">documented in parent class</a></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="PlanarImage.html#verify()">verify</a></code> in class <code><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>null</code> if image layout information are consistent, |
| or the name of inconsistent attribute if a problem is found.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getColorModel()"> |
| <h3>getColorModel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/ColorModel.html" title="class or interface in java.awt.image" class="external-link">ColorModel</a></span> <span class="element-name">getColorModel</span>()</div> |
| <div class="block">Returns the color model of this resampled image. |
| Default implementation assumes that this image has the same color model than the source image.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the color model, or <code>null</code> if unspecified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperty(java.lang.String)"> |
| <h3>getProperty</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</span></div> |
| <div class="block">Gets a property from this image. Current default implementation supports the following keys |
| (more properties may be added to this list in any future Apache SIS versions): |
| |
| <ul> |
| <li><a href="PlanarImage.html#POSITIONAL_ACCURACY_KEY">"org.apache.sis.PositionalAccuracy"</a></li> |
| <li><a href="#POSITIONAL_CONSISTENCY_KEY">"org.apache.sis.PositionalConsistency"</a></li> |
| <li><a href="PlanarImage.html#SAMPLE_DIMENSIONS_KEY">"org.apache.sis.SampleDimensions"</a> (forwarded to the source image)</li> |
| <li><a href="PlanarImage.html#SAMPLE_RESOLUTIONS_KEY">"org.apache.sis.SampleResolutions"</a> (forwarded to the source image)</li> |
| <li><a href="PlanarImage.html#MASK_KEY">"org.apache.sis.Mask"</a> if the image uses floating point numbers.</li> |
| </ul> |
| |
| <h4 id="note-on-sample-values-heading">Note on sample values</h4> |
| The sample resolutions are retained because they should have approximately the same values before and after |
| resampling. <a href="PlanarImage.html#STATISTICS_KEY">Statistics</a> are not in this list because, while minimum and maximum |
| values should stay approximately the same, the average value and standard deviation may be quite different.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html#getProperty(java.lang.String)" title="class or interface in java.awt.image" class="external-link">getProperty</a></code> in interface <code><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">RenderedImage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="PlanarImage.html#getProperty(java.lang.String)">getProperty</a></code> in class <code><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get.</dd> |
| <dt>Returns:</dt> |
| <dd>the property value, or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Image.html#UndefinedProperty" title="class or interface in java.awt" class="external-link"><code>Image.UndefinedProperty</code></a> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyNames()"> |
| <h3>getPropertyNames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">getPropertyNames</span>()</div> |
| <div class="block">Returns the names of all recognized properties, or <code>null</code> if this image has no properties. |
| The returned array contains the properties listed in <a href="#getProperty(java.lang.String)"><code>getProperty(String)</code></a> if the source |
| image has those properties.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html#getPropertyNames()" title="class or interface in java.awt.image" class="external-link">getPropertyNames</a></code> in interface <code><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">RenderedImage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="PlanarImage.html#getPropertyNames()">getPropertyNames</a></code> in class <code><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>names of all recognized properties, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinTileX()"> |
| <h3>getMinTileX</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getMinTileX</span>()</div> |
| <div class="block">Returns the minimum tile index in the <var>x</var> direction. |
| This is often 0.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html#getMinTileX()" title="class or interface in java.awt.image" class="external-link">getMinTileX</a></code> in interface <code><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">RenderedImage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="PlanarImage.html#getMinTileX()">getMinTileX</a></code> in class <code><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the minimum tile index in the <var>x</var> direction.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinTileY()"> |
| <h3>getMinTileY</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getMinTileY</span>()</div> |
| <div class="block">Returns the minimum tile index in the <var>y</var> direction. |
| This is often 0.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html#getMinTileY()" title="class or interface in java.awt.image" class="external-link">getMinTileY</a></code> in interface <code><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">RenderedImage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="PlanarImage.html#getMinTileY()">getMinTileY</a></code> in class <code><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the minimum tile index in the <var>y</var> direction.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinX()"> |
| <h3>getMinX</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getMinX</span>()</div> |
| <div class="block">Returns the minimum <var>x</var> coordinate (inclusive) of this image. |
| This is the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html#x" title="class or interface in java.awt" class="external-link"><code>Rectangle.x</code></a> value of the <code>bounds</code> specified at construction time.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html#getMinX()" title="class or interface in java.awt.image" class="external-link">getMinX</a></code> in interface <code><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">RenderedImage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="PlanarImage.html#getMinX()">getMinX</a></code> in class <code><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the minimum <var>x</var> coordinate (column) of this image.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinY()"> |
| <h3>getMinY</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getMinY</span>()</div> |
| <div class="block">Returns the minimum <var>y</var> coordinate (inclusive) of this image. |
| This is the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html#y" title="class or interface in java.awt" class="external-link"><code>Rectangle.y</code></a> value of the <code>bounds</code> specified at construction time.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html#getMinY()" title="class or interface in java.awt.image" class="external-link">getMinY</a></code> in interface <code><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">RenderedImage</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="PlanarImage.html#getMinY()">getMinY</a></code> in class <code><a href="PlanarImage.html" title="class in org.apache.sis.image">PlanarImage</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the minimum <var>y</var> coordinate (row) of this image.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWidth()"> |
| <h3>getWidth</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getWidth</span>()</div> |
| <div class="block">Returns the number of columns in this image. |
| This is the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html#width" title="class or interface in java.awt" class="external-link"><code>Rectangle.width</code></a> value of the <code>bounds</code> specified at construction time.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of columns in this image.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeight()"> |
| <h3>getHeight</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getHeight</span>()</div> |
| <div class="block">Returns the number of rows in this image. |
| This is the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html#height" title="class or interface in java.awt" class="external-link"><code>Rectangle.height</code></a> value of the <code>bounds</code> specified at construction time.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of rows in this image.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="computeTile(int,int,java.awt.image.WritableRaster)"> |
| <h3>computeTile</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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">Raster</a></span> <span class="element-name">computeTile</span><wbr><span class="parameters">(int tileX, |
| int tileY, |
| <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">WritableRaster</a> tile)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></span></div> |
| <div class="block">Invoked when a tile need to be computed or updated. This method fills all pixel values of the tile |
| with values interpolated from the source image. It may be invoked concurrently in different threads.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ComputedImage.html#computeTile(int,int,java.awt.image.WritableRaster)">computeTile</a></code> in class <code><a href="ComputedImage.html" title="class in org.apache.sis.image">ComputedImage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>tileX</code> - the column index of the tile to compute.</dd> |
| <dd><code>tileY</code> - the row index of the tile to compute.</dd> |
| <dd><code>tile</code> - if the tile already exists but needs to be updated, the tile to update. Otherwise <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>computed tile for the given indices.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></code> - if an error occurred while computing pixel coordinates.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prefetch(java.awt.Rectangle)"> |
| <h3>prefetch</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Disposable.html" title="interface in org.apache.sis.util">Disposable</a></span> <span class="element-name">prefetch</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Rectangle.html" title="class or interface in java.awt" class="external-link">Rectangle</a> tiles)</span></div> |
| <div class="block">Notifies the source image that tiles will be computed soon in the given region. |
| If the source image is an instance of <a href="ComputedImage.html" title="class in org.apache.sis.image"><code>ComputedImage</code></a>, then this method |
| forwards the notification to it. Otherwise default implementation does nothing.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="ComputedImage.html#prefetch(java.awt.Rectangle)">prefetch</a></code> in class <code><a href="ComputedImage.html" title="class in org.apache.sis.image">ComputedImage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>tiles</code> - indices of the tiles which will be prefetched.</dd> |
| <dt>Returns:</dt> |
| <dd>handler on which to invoke <code>dispose()</code> after the prefetch operation |
| completed (successfully or not), or <code>null</code> if none.</dd> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</span></div> |
| <div class="block">Compares the given object with this image for equality. This method returns <code>true</code> |
| if the given object is non-null, is an instance of the exact same class than this image, |
| has equal sources and do the same resampling operation (same interpolation method, |
| same fill values, same coordinates).</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the object to compare with this image.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the given object is an image performing the same resampling than this image.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block">Returns a hash code value for this image.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a hash code value based on a description of the operation performed by this image.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
