sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1832531 - in /sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid: GridExtent.java GridGeometry.java
Date Wed, 30 May 2018 10:25:30 GMT
Author: desruisseaux
Date: Wed May 30 10:25:29 2018
New Revision: 1832531

URL: http://svn.apache.org/viewvc?rev=1832531&view=rev
Log:
Documentation clarification in GridExtent.

Modified:
    sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
    sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridGeometry.java

Modified: sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridExtent.java?rev=1832531&r1=1832530&r2=1832531&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
[UTF-8] Wed May 30 10:25:29 2018
@@ -30,14 +30,16 @@ import org.opengis.coverage.grid.GridCoo
 
 /**
  * A range of grid coverage coordinates, also known as "grid envelope".
- * {@code GridExtent} instances are unmodifiable,
- * so they can be shared between different {@link GridGeometry} instances.
+ * {@code GridExtent} are defined by {@linkplain #getLow() low} coordinates (often all zeros)
+ * and {@linkplain #getHigh() high} coordinates, <strong>inclusive</strong>.
+ * For example a grid with a width of 512 cells can have a low coordinate of 0 and high coordinate
of 511.
  *
- * <p><b>CAUTION:</b>
- * ISO 19123 defines {@linkplain #getHigh high} coordinates as <strong>inclusive</strong>.
- * We follow this specification for all getters methods, but developer should keep in mind
- * that this is the opposite of Java2D usage where {@link java.awt.Rectangle} maximal values
are exclusive.
- * When the context is ambiguous, an explicit {@code isHighIncluded} argument is required.</p>
+ * <div class="note"><b>Note:</b>
+ * The inclusiveness of {@linkplain #getHigh() high} coordinates come from ISO 19123.
+ * We follow this specification for all getters methods, but developers should keep in mind
+ * that this is the opposite of Java2D usage where {@link java.awt.Rectangle} maximal values
are exclusive.</div>
+ *
+ * {@code GridExtent} instances are unmodifiable, so they can be shared between different
{@link GridGeometry} instances.
  *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @version 1.0

Modified: sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridGeometry.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridGeometry.java?rev=1832531&r1=1832530&r2=1832531&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridGeometry.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/coverage/grid/GridGeometry.java
[UTF-8] Wed May 30 10:25:29 2018
@@ -110,6 +110,9 @@ public class GridGeometry implements Ser
      * The valid domain of a grid coverage, or {@code null} if unknown. The lowest valid
grid coordinate is zero
      * for {@link java.awt.image.BufferedImage}, but may be non-zero for arbitrary {@link
RenderedImage}.
      * A grid with 512 cells can have a minimum coordinate of 0 and maximum of 511.
+     *
+     * @see #EXTENT
+     * @see #getExtent()
      */
     protected final GridExtent extent;
 
@@ -117,6 +120,9 @@ public class GridGeometry implements Ser
      * The geodetic envelope, or {@code null} if unknown. If non-null, this envelope is usually
the grid {@link #extent}
      * {@linkplain #gridToCRS transformed} to real world coordinates. The Coordinate Reference
System} (CRS) of this
      * envelope defines the "real world" CRS of this grid geometry.
+     *
+     * @see #ENVELOPE
+     * @see #getEnvelope()
      */
     protected final ImmutableEnvelope envelope;
 
@@ -129,6 +135,9 @@ public class GridGeometry implements Ser
      *     DirectPosition aCellIndices = ...:
      *     DirectPosition aPixelCenter = gridToCRS.transform(pixels, aCellIndices);
      * }
+     *
+     * @see #CRS
+     * @see #getGridToCRS()
      */
     protected final MathTransform gridToCRS;
 
@@ -144,6 +153,8 @@ public class GridGeometry implements Ser
     /**
      * The resolution in units of the CRS axes.
      * Computed only when first needed.
+     *
+     * @see #resolution(boolean)
      */
     private transient double[] resolution;
 



Mime
View raw message