diff --git a/src/main/java/org/orekit/rugged/api/Rugged.java b/src/main/java/org/orekit/rugged/api/Rugged.java
index 2b0bef298a42497a73e03821485b75c5333b231a..7335cf55501f11eb49604c02846a0e4a224f299e 100644
--- a/src/main/java/org/orekit/rugged/api/Rugged.java
+++ b/src/main/java/org/orekit/rugged/api/Rugged.java
@@ -67,6 +67,7 @@ import org.orekit.utils.ParameterDriver;
/** Main class of Rugged library API.
* @see RuggedBuilder
* @author Luc Maisonobe
+ * @author Guylaine Prat
*/
public class Rugged {
@@ -425,8 +426,8 @@ public class Rugged {
* are only an example and should be adjusted depending on mission needs.
* </p>
* @param sensorName name of the line sensor
- * @param latitude ground point latitude
- * @param longitude ground point longitude
+ * @param latitude ground point latitude (rad)
+ * @param longitude ground point longitude (rad)
* @param minLine minimum line number
* @param maxLine maximum line number
* @return date at which ground point is seen by line sensor
@@ -508,8 +509,8 @@ public class Rugged {
* are only an example and should be adjusted depending on mission needs.
* </p>
* @param sensorName name of the line sensor
- * @param latitude ground point latitude
- * @param longitude ground point longitude
+ * @param latitude ground point latitude (rad)
+ * @param longitude ground point longitude (rad)
* @param minLine minimum line number
* @param maxLine maximum line number
* @return sensor pixel seeing ground point, or null if ground point cannot
diff --git a/src/main/java/org/orekit/rugged/api/RuggedBuilder.java b/src/main/java/org/orekit/rugged/api/RuggedBuilder.java
index 59d372e05043e485c62f5b1ad871add7beec4beb..1c8b32a94ec417fd04bdc5d02af7106e287cc9db 100644
--- a/src/main/java/org/orekit/rugged/api/RuggedBuilder.java
+++ b/src/main/java/org/orekit/rugged/api/RuggedBuilder.java
@@ -85,6 +85,7 @@ import org.orekit.utils.TimeStampedPVCoordinates;
* @see <a href="https://en.wikipedia.org/wiki/Builder_pattern">Builder pattern (wikipedia)</a>
* @see <a href="https://en.wikipedia.org/wiki/Fluent_interface">Fluent interface (wikipedia)</a>
* @author Luc Maisonobe
+ * @author Guylaine Prat
*/
public class RuggedBuilder {
@@ -97,7 +98,7 @@ public class RuggedBuilder {
/** Updater used to load Digital Elevation Model tiles. */
private TileUpdater tileUpdater;
- /** Constant elevation over ellipsoid.
+ /** Constant elevation over ellipsoid (m).
* used only with {@link AlgorithmId#CONSTANT_ELEVATION_OVER_ELLIPSOID. */
private double constantElevation;
@@ -110,10 +111,10 @@ public class RuggedBuilder {
/** End of search time span. */
private AbsoluteDate maxDate;
- /** Step to use for inertial frame to body frame transforms cache computations. */
+ /** Step to use for inertial frame to body frame transforms cache computations (s). */
private double tStep;
- /** OvershootTolerance tolerance in seconds allowed for {@code minDate} and {@code maxDate} overshooting. */
+ /** OvershootTolerance tolerance in seconds allowed for {@code minDate} and {@code maxDate} overshooting (s). */
private double overshootTolerance;
/** Inertial frame for position/velocity/attitude. */
@@ -140,7 +141,7 @@ public class RuggedBuilder {
/** Propagator for position/velocity/attitude. */
private Propagator pvaPropagator;
- /** Step to use for inertial/Earth/spacraft transforms interpolations. */
+ /** Step to use for inertial/Earth/spacraft transforms interpolations (s). */
private double iStep;
/** Number of points to use for inertial/Earth/spacraft transforms interpolations. */
@@ -297,7 +298,7 @@ public class RuggedBuilder {
* AlgorithmId#CONSTANT_ELEVATION_OVER_ELLIPSOID CONSTANT_ELEVATION_OVER_ELLIPSOID}.
* If it is called for another algorithm, the elevation set here will be ignored.
* </p>
- * @param constantElevation constant elevation to use
+ * @param constantElevation constant elevation to use (m)
* @return the builder instance
* @see #setAlgorithm(AlgorithmId)
* @see #getConstantElevation()
@@ -337,8 +338,8 @@ public class RuggedBuilder {
* </p>
* @param minDate start of search time span
* @param maxDate end of search time span
- * @param tStep step to use for inertial frame to body frame transforms cache computations
- * @param overshootTolerance tolerance in seconds allowed for {@code minDate} and {@code maxDate} overshooting
+ * @param tStep step to use for inertial frame to body frame transforms cache computations (s)
+ * @param overshootTolerance tolerance in seconds allowed for {@code minDate} and {@code maxDate} overshooting (s)
* @return the builder instance
* @see #setTrajectoryAndTimeSpan(InputStream)
* @see #getMinDate()
@@ -476,7 +477,7 @@ public class RuggedBuilder {
* <em>must</em> be used together with the {@link #setTimeSpan(AbsoluteDate, AbsoluteDate, double, double)}
* but should <em>not</em> be mixed with {@link #setTrajectoryAndTimeSpan(InputStream)}.
* </p>
- * @param interpolationStep step to use for inertial/Earth/spacraft transforms interpolations
+ * @param interpolationStep step to use for inertial/Earth/spacraft transforms interpolations (s)
* @param interpolationNumber number of points to use for inertial/Earth/spacraft transforms interpolations
* @param pvFilter filter for derivatives from the sample to use in position/velocity interpolation
* @param aFilter filter for derivatives from the sample to use in attitude interpolation
diff --git a/src/main/java/org/orekit/rugged/raster/TileUpdater.java b/src/main/java/org/orekit/rugged/raster/TileUpdater.java
index 2943f16a73946dd80dc7dd007017cad859725bea..43bf954e35909d29565bac2d393171423c845ff0 100644
--- a/src/main/java/org/orekit/rugged/raster/TileUpdater.java
+++ b/src/main/java/org/orekit/rugged/raster/TileUpdater.java
@@ -24,7 +24,8 @@ import org.orekit.rugged.errors.RuggedException;
* the image processing mission-specific layer, thus allowing
* the Rugged library to access the Digital Elevation Model data.
* </p>
- * * @author Luc Maisonobe
+ * @author Luc Maisonobe
+ * @author Guylaine Prat
*/
public interface TileUpdater {
@@ -76,8 +77,8 @@ public interface TileUpdater {
latitudeStep, longitudeStep, latitudeRows, longitudeColumns)} call.
* </li>
* </ul>
- * @param latitude latitude that must be covered by the tile
- * @param longitude longitude that must be covered by the tile
+ * @param latitude latitude that must be covered by the tile (rad)
+ * @param longitude longitude that must be covered by the tile (rad)
* @param tile to update
* @exception RuggedException if tile cannot be updated
*/
diff --git a/src/main/java/org/orekit/rugged/raster/UpdatableTile.java b/src/main/java/org/orekit/rugged/raster/UpdatableTile.java
index 0e38a7f71dca2df99656daf25f32ac65797e1dda..52c421f2b3c3675d0accedd058243fa189b92cf6 100644
--- a/src/main/java/org/orekit/rugged/raster/UpdatableTile.java
+++ b/src/main/java/org/orekit/rugged/raster/UpdatableTile.java
@@ -20,14 +20,15 @@ import org.orekit.rugged.errors.RuggedException;
/** Interface representing one tile of a raster Digital Elevation Model.
* @author Luc Maisonobe
+ * @author Guylaine Prat
*/
public interface UpdatableTile {
/** Set the tile global geometry.
- * @param minLatitude minimum latitude
- * @param minLongitude minimum longitude
- * @param latitudeStep step in latitude (size of one raster element)
- * @param longitudeStep step in longitude (size of one raster element)
+ * @param minLatitude minimum latitude (rad)
+ * @param minLongitude minimum longitude (rad)
+ * @param latitudeStep step in latitude (size of one raster element) (rad)
+ * @param longitudeStep step in longitude (size of one raster element) (rad)
* @param latitudeRows number of latitude rows
* @param longitudeColumns number of longitude columns
* @exception RuggedException if tile is empty (zero rows or columns)
diff --git a/src/main/java/org/orekit/rugged/utils/ExtendedEllipsoid.java b/src/main/java/org/orekit/rugged/utils/ExtendedEllipsoid.java
index a90dd050a9b6fe0a418860e7ff779780444b1582..6ce1a013fcc08508e54f1267558dc1e59185d377 100644
--- a/src/main/java/org/orekit/rugged/utils/ExtendedEllipsoid.java
+++ b/src/main/java/org/orekit/rugged/utils/ExtendedEllipsoid.java
@@ -47,7 +47,7 @@ public class ExtendedEllipsoid extends OneAxisEllipsoid {
private final double b2;
/** Simple constructor.
- * @param ae equatorial radius
+ * @param ae equatorial radius (m)
* @param f the flattening (f = (a-b)/a)
* @param bodyFrame body frame related to body shape
* @see org.orekit.frames.FramesFactory#getITRF(org.orekit.utils.IERSConventions, boolean)
@@ -75,13 +75,13 @@ public class ExtendedEllipsoid extends OneAxisEllipsoid {
}
/** Get point at some latitude along a pixel line of sight.
- * @param position cell position (in body frame)
+ * @param position cell position (in body frame) (m)
* @param los pixel line-of-sight, not necessarily normalized (in body frame)
- * @param latitude latitude with respect to ellipsoid
- * @param closeReference reference point used to select the closest solution
+ * @param latitude latitude with respect to ellipsoid (rad)
+ * @param closeReference reference point used to select the closest solution
* when there are two points at the desired latitude along the line, it should
- * be close to los surface intersection
- * @return point at latitude
+ * be close to los surface intersection (m)
+ * @return point at latitude (m)
* @exception RuggedException if no such point exists
*/
public Vector3D pointAtLatitude(final Vector3D position, final Vector3D los,
@@ -161,10 +161,10 @@ public class ExtendedEllipsoid extends OneAxisEllipsoid {
}
/** Get point at some longitude along a pixel line of sight.
- * @param position cell position (in body frame)
+ * @param position cell position (in body frame) (m)
* @param los pixel line-of-sight, not necessarily normalized (in body frame)
- * @param longitude longitude with respect to ellipsoid
- * @return point at longitude
+ * @param longitude longitude with respect to ellipsoid (rad)
+ * @return point at longitude (m)
* @exception RuggedException if no such point exists
*/
public Vector3D pointAtLongitude(final Vector3D position, final Vector3D los, final double longitude)
@@ -186,10 +186,10 @@ public class ExtendedEllipsoid extends OneAxisEllipsoid {
}
/** Get point on ground along a pixel line of sight.
- * @param position cell position (in body frame)
+ * @param position cell position (in body frame) (m)
* @param los pixel line-of-sight, not necessarily normalized (in body frame)
* @param centralLongitude reference longitude lc such that the point longitude will
- * be normalized between lc-Ï€ and lc+Ï€
+ * be normalized between lc-Ï€ and lc+Ï€ (rad)
* @return point on ground
* @exception RuggedException if no such point exists (typically line-of-sight missing body)
*/
@@ -212,10 +212,10 @@ public class ExtendedEllipsoid extends OneAxisEllipsoid {
}
/** Get point at some altitude along a pixel line of sight.
- * @param position cell position (in body frame)
+ * @param position cell position (in body frame) (m)
* @param los pixel line-of-sight, not necessarily normalized (in body frame)
- * @param altitude altitude with respect to ellipsoid
- * @return point at altitude
+ * @param altitude altitude with respect to ellipsoid (m)
+ * @return point at altitude (m)
* @exception RuggedException if no such point exists (typically too negative altitude)
*/
public Vector3D pointAtAltitude(final Vector3D position, final Vector3D los, final double altitude)
@@ -321,11 +321,11 @@ public class ExtendedEllipsoid extends OneAxisEllipsoid {
}
/** Transform a cartesian point to a surface-relative point.
- * @param point cartesian point
+ * @param point cartesian point (m)
* @param frame frame in which cartesian point is expressed
* @param date date of the computation (used for frames conversions)
* @param centralLongitude reference longitude lc such that the point longitude will
- * be normalized between lc-Ï€ and lc+Ï€
+ * be normalized between lc-Ï€ and lc+Ï€ (rad)
* @return point at the same location but as a surface-relative point
* @exception OrekitException if point cannot be converted to body frame
*/
diff --git a/src/test/java/org/orekit/rugged/raster/RandomLandscapeUpdater.java b/src/test/java/org/orekit/rugged/raster/RandomLandscapeUpdater.java
index 9d66ee7f436eed8ec3895c0452e0f1a27a9e161d..67fcfa8c58c4662f41c0b7344d5f71a027a71a98 100644
--- a/src/test/java/org/orekit/rugged/raster/RandomLandscapeUpdater.java
+++ b/src/test/java/org/orekit/rugged/raster/RandomLandscapeUpdater.java
@@ -35,10 +35,6 @@ public class RandomLandscapeUpdater implements TileUpdater {
throws MathIllegalArgumentException {
if (!ArithmeticUtils.isPowerOfTwo(n - 1)) {
-
-// TODO hipparchus migration : change to the appropriate message
-// throw new MathIllegalArgumentException(LocalizedFormats.SIMPLE_MESSAGE,
-// "tile size must be a power of two plus one");
throw new MathIllegalArgumentException(LocalizedCoreFormats.SIMPLE_MESSAGE,
"tile size must be a power of two plus one");
}