Merge branch 'merge_rugged_refining' of https://www.orekit.org/git/rugged-main...

Merge branch 'merge_rugged_refining' of https://www.orekit.org/git/rugged-main into merge_rugged_refining

src/main/java/org/orekit/rugged/adjustment/GroundOptimizationProblemBuilder.java

@@ -46,8 +46,12 @@ import org.orekit.rugged.adjustment.measurements.Observables;
 import org.orekit.rugged.adjustment.measurements.SensorToGroundMapping;
 import org.orekit.utils.ParameterDriver;
 
-/** TODO GP description a completer.
+/** Ground optimization problem builder.
+ * builds the optimization problem relying on ground measurements.
  * @author Guylaine Prat
+ * @author Lucie Labat Allee
+ * @author Jonathan Guinet
+ * @author Luc Maisonobe
  * @since 2.0
  */
 public class GroundOptimizationProblemBuilder extends OptimizationProblemBuilder {
@@ -74,7 +78,7 @@ public class GroundOptimizationProblemBuilder extends OptimizationProblemBuilder
     private HashMap<String, double[] > targetAndWeight;
 
 
-    /** TODO GP description a completer.
+    /** Build a new instance of the optimization problem.
      * @param sensors list of sensors to refine
      * @param measurements set of observables
      * @param rugged name of rugged to refine

src/main/java/org/orekit/rugged/adjustment/InterSensorsOptimizationProblemBuilder.java

@@ -49,9 +49,12 @@ import org.orekit.rugged.utils.SpacecraftToObservedBody;
 import org.orekit.time.AbsoluteDate;
 import org.orekit.utils.ParameterDriver;
 
-/** TODO GP description a completer.
- * @author ???
+/** InterSensorsOptimizationProblemBuilder 
+ * Constructs the optimization problem for a list of tie points.
  * @author Guylaine Prat
+ * @author Lucie Labat Allee
+ * @author Jonathan Guinet
+ * @author Luc Maisonobe
  * @since 2.0
  */
 public class InterSensorsOptimizationProblemBuilder extends OptimizationProblemBuilder {

src/main/java/org/orekit/rugged/adjustment/LeastSquareAdjuster.java

@@ -24,7 +24,8 @@ import org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresProblem;
 import org.hipparchus.optim.nonlinear.vector.leastsquares.LevenbergMarquardtOptimizer;
 import org.orekit.rugged.errors.RuggedException;
 
-/** TODO GP description a completer.
+/** LeastSquareAdjuster
+ * class for setting least square algorithm chosen for solving optimization problem.
  * @author Guylaine Prat
  * @since 2.0
  */

src/main/java/org/orekit/rugged/adjustment/OptimizationProblemBuilder.java

@@ -43,7 +43,7 @@ import org.orekit.utils.ParameterDriver;
 /**
  * Builder for optimization problem.
  * <p>
- * TODO GP description a completer
+ * Constructs the optimization problem defined by a set of measurement and sensors.
  * </p>
  * @author Jonathan Guinet
  * @author Guylaine Prat
@@ -111,7 +111,6 @@ abstract class OptimizationProblemBuilder {
     final ConvergenceChecker<LeastSquaresProblem.Evaluation>
                             createChecker(final double parametersConvergenceThreshold) {
 
-        // TODO GP description a completer
         final ConvergenceChecker<LeastSquaresProblem.Evaluation> checker = (iteration, previous, current)
             -> current.getPoint().getLInfDistance(previous.getPoint()) <= parametersConvergenceThreshold;
 
@@ -151,7 +150,6 @@ abstract class OptimizationProblemBuilder {
     final ParameterValidator createParameterValidator() {
 
         // Prevent parameters to exceed their prescribed bounds
-        // TODO GP description a completer
         final ParameterValidator validator = params -> {
             try {
                 int i = 0;
@@ -210,7 +208,7 @@ abstract class OptimizationProblemBuilder {
 
         final DSFactory factory = new DSFactory(map.size(), 1);
 
-        // TODO GP description a completer
+        // Derivative Structure Generator
         return new DSGenerator() {
 
             /** {@inheritDoc} */

src/main/java/org/orekit/rugged/adjustment/measurements/Observables.java

@@ -63,8 +63,10 @@ public class Observables {
         interMappings.put(this.createKey(interMapping), interMapping);
     }
 
-    /** Add a ground mapping between ????
-     * TODO GP commentaire a completer
+    /** Add a ground mapping 
+     * <p>
+     * a ground mapping is defined by a set of GCPs 
+     * </p>
      * @param groundMapping sensor to ground mapping
      */
     public void addGroundMapping(final SensorToGroundMapping groundMapping) {
@@ -92,7 +94,6 @@ public class Observables {
     }
 
     /** Get the sensor to sensor values.
-     * TODO GP commentaire a completer
      * @return the inter-mappings
      */
     public Collection<SensorToSensorMapping> getInterMappings() {
@@ -108,7 +109,9 @@ public class Observables {
 
     /**
      * Get a sensor mapping for a sensor.
-     * TODO GP commentaire a completer
+     * <p>
+     * returns sensor to sensor mapping associated with specific sensors and related rugged instance.
+     * </p>
      * @param ruggedNameA Rugged name A
      * @param sensorNameA sensor name A
      * @param ruggedNameB Rugged name B

src/tutorials/java/fr/cs/examples/refiningPleiades/generators/GroundMeasurementGenerator.java

@@ -139,7 +139,7 @@ public class GroundMeasurementGenerator implements Measurable {
         final double meanGenerator[] =  {latErrorMean, lonErrorMean, mean[2]};
         final double stdGenerator[] = {latErrorStd, lonErrorStd, std[2]};
 
-        // TODO GP commentaire sur la seed du generator ???
+        // seed has been fixed for tests purpose
         final GaussianRandomGenerator rng = new GaussianRandomGenerator(new Well19937a(0xefac03d9be4d24b9l));
         final UncorrelatedRandomVectorGenerator rvg = new UncorrelatedRandomVectorGenerator(meanGenerator, stdGenerator, rng);
 
@@ -174,9 +174,6 @@ public class GroundMeasurementGenerator implements Measurable {
      * @throws RuggedException
      */
     private Vector3D estimateLatLongError() throws RuggedException {
-
-        // TODO GP add explanation
-
         final int pix = sensor.getNbPixels() / 2;
         final int line = (int) FastMath.floor(pix); // assumption : same number of line and pixels;
 
@@ -188,10 +185,6 @@ public class GroundMeasurementGenerator implements Measurable {
 
         final double latErr = FastMath.abs(gp_pix0.getLatitude() - gp_pix1.getLatitude());
         final double lonErr = FastMath.abs(gp_pix0.getLongitude() - gp_pix1.getLongitude());
-
-//        final double distanceX =  DistanceTools.computeDistanceInMeter(gp_pix0.getLongitude(), gp_pix0.getLatitude(), gp_pix1.getLongitude(), gp_pix0.getLatitude());
-//        final double distanceY =  DistanceTools.computeDistanceInMeter(gp_pix0.getLongitude(), gp_pix0.getLatitude(), gp_pix0.getLongitude(), gp_pix1.getLatitude());
-
         return new Vector3D(latErr, lonErr, 0.0);
     }
 }

src/tutorials/java/fr/cs/examples/refiningPleiades/generators/InterMeasurementGenerator.java

@@ -63,9 +63,6 @@ public class InterMeasurementGenerator implements Measurable {
     /** Number of measurements */
     private int measurementCount;
 
-    // TODO GP pas utilise ...
-    //   private String sensorNameA;
-
     /** Sensor name B */
     private String sensorNameB;
 
@@ -259,11 +256,11 @@ public class InterMeasurementGenerator implements Measurable {
         final double meanB[] = { mean[1], mean[1] };
         final double stdB[]  = { std[1], std[1] };
 
-        // TODO GP explanation about seed ???
+        // seed has been fixed for tests purpose
         final GaussianRandomGenerator rngA = new GaussianRandomGenerator(new Well19937a(0xefac03d9be4d24b9l));
         final UncorrelatedRandomVectorGenerator rvgA = new UncorrelatedRandomVectorGenerator(meanA, stdA, rngA);
 
-        // TODO GP explanation about seed ???
+        // seed has been fixed for tests purpose
         final GaussianRandomGenerator rngB = new GaussianRandomGenerator(new Well19937a(0xdf1c03d9be0b34b9l));
         final UncorrelatedRandomVectorGenerator rvgB = new UncorrelatedRandomVectorGenerator(meanB, stdB, rngB);
 
@@ -290,7 +287,7 @@ public class InterMeasurementGenerator implements Measurable {
                                                                      sensorB.getLOS(dateB, pixelB));
                     final double GEOdistance = DistanceTools.computeDistanceInMeter(gpA.getLongitude(), gpA.getLatitude(),
                                                                                     gpB.getLongitude(), gpB.getLatitude());
-                    // TODO GP explanation about computation here
+                    // create the inter mapping if distance is below outlier value
                     if (GEOdistance < outlier) {
 
                         final double[] vecRandomA = rvgA.nextVector();

src/tutorials/java/fr/cs/examples/refiningPleiades/metrics/LocalisationMetrics.java

@@ -33,7 +33,6 @@ import org.orekit.rugged.utils.SpacecraftToObservedBody;
 import org.orekit.time.AbsoluteDate;
 
 /**
- * TODO GP migrer sous tutorials
  * Class for testing geometric performances in absolute location.
  * Metrics are computed for two scenarios: ground points and liaison points.
  * @see SensorToSensorMapping

src/tutorials/java/fr/cs/examples/refiningPleiades/models/OrbitModel.java

@@ -60,8 +60,10 @@ import org.orekit.utils.TimeStampedPVCoordinates;
 import org.orekit.utils.AngularDerivativesFilter;
 
 /**
- * TODO GP add comments for tuto
  * Orbit Model class to generate positions-velocities and attitude quaternions.
+ * <p>
+ * the aim of this class is to simulate the orbit model of an LEO satellite
+ * </p>
  * @author Jonathan Guinet
  * @author Guylaine Prat
  * @since 2.0 */

src/tutorials/java/fr/cs/examples/refiningPleiades/models/PleiadesViewingModel.java

@@ -40,8 +40,8 @@ import org.orekit.rugged.errors.RuggedException;
 import org.orekit.errors.OrekitException;
 
 /**
- * TODO GP add comments for tuto
  * Pleiades viewing model class definition.
+ * the aim of this class is to simulate PHR sensor.
  * @author Jonathan Guinet
  * @author Lucie Labat-Allee
  * @since 2.0