From 146c14035fa4e8ff3dfb1616a0d406ce70664bdb Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@orekit.org>
Date: Fri, 26 Sep 2014 10:20:54 +0200
Subject: [PATCH] Documented the fact latitude/longitudes are at pixels
*centers*.
---
.../src/main/java/org/orekit/rugged/raster/Tile.java | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/core/src/main/java/org/orekit/rugged/raster/Tile.java b/core/src/main/java/org/orekit/rugged/raster/Tile.java
index 21d5547e..d6abd003 100644
--- a/core/src/main/java/org/orekit/rugged/raster/Tile.java
+++ b/core/src/main/java/org/orekit/rugged/raster/Tile.java
@@ -21,6 +21,12 @@ import org.orekit.bodies.GeodeticPoint;
import org.orekit.rugged.api.RuggedException;
/** Interface representing a raster tile.
+ * <p>
+ * The elevations are considered to be at the <em>center</em> of each pixels.
+ * The minimum latitude and longitude hence correspond to the <em>center</em>
+ * of the most South-West pixel, and the maximum latitude and longitude
+ * correspond to the <em>center</em> of the most North-East pixel.
+ * </p>
* @author Luc Maisonobe
*/
public interface Tile extends UpdatableTile {
@@ -65,33 +71,39 @@ public interface Tile extends UpdatableTile {
/** Get minimum latitude.
* @return minimum latitude
+ * (latitude of the center of the pixels of South row)
*/
double getMinimumLatitude();
/** Get the latitude at some index.
* @param latitudeIndex latitude index
* @return latitude at the specified index
+ * (latitude of the center of the pixels of specified row)
*/
double getLatitudeAtIndex(int latitudeIndex);
/** Get maximum latitude.
* @return maximum latitude
+ * (latitude of the center of the pixels of North row)
*/
double getMaximumLatitude();
/** Get minimum longitude.
* @return minimum longitude
+ * (longitude of the center of the pixels of West column)
*/
double getMinimumLongitude();
/** Get the longitude at some index.
* @param longitudeIndex longitude index
* @return longitude at the specified index
+ * (longitude of the center of the pixels of specified column)
*/
double getLongitudeAtIndex(int longitudeIndex);
/** Get maximum longitude.
* @return maximum longitude
+ * (longitude of the center of the pixels of East column)
*/
double getMaximumLongitude();
--
GitLab