diff --git a/src/main/java/org/orekit/rugged/adjustment/GroundOptimizationProblemBuilder.java b/src/main/java/org/orekit/rugged/adjustment/GroundOptimizationProblemBuilder.java index 8051de2f8720a961e0dbdcf8494f3261c1dbfd24..3773d5c73c9b17226e81157a0c237afded58f006 100644 --- a/src/main/java/org/orekit/rugged/adjustment/GroundOptimizationProblemBuilder.java +++ b/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 diff --git a/src/main/java/org/orekit/rugged/adjustment/InterSensorsOptimizationProblemBuilder.java b/src/main/java/org/orekit/rugged/adjustment/InterSensorsOptimizationProblemBuilder.java index 1bb3d88227b8439491435a0c03a997eaf36d6147..72dd108a952829ec5bc2475f4734070b35198e73 100644 --- a/src/main/java/org/orekit/rugged/adjustment/InterSensorsOptimizationProblemBuilder.java +++ b/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 { diff --git a/src/main/java/org/orekit/rugged/adjustment/LeastSquareAdjuster.java b/src/main/java/org/orekit/rugged/adjustment/LeastSquareAdjuster.java index f2dbb85f0edd12109b44dc4ece4b642f6f6c8161..5fc15bfd000ceaae7e07ac4ee041ce7625fb3dc1 100644 --- a/src/main/java/org/orekit/rugged/adjustment/LeastSquareAdjuster.java +++ b/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 */ diff --git a/src/main/java/org/orekit/rugged/adjustment/OptimizationProblemBuilder.java b/src/main/java/org/orekit/rugged/adjustment/OptimizationProblemBuilder.java index 8282028d3465e9e403375954df4d9096d093fe8a..2c607efedfb653e61ecad5606f6c0c12a1720da8 100644 --- a/src/main/java/org/orekit/rugged/adjustment/OptimizationProblemBuilder.java +++ b/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} */ diff --git a/src/main/java/org/orekit/rugged/adjustment/measurements/Observables.java b/src/main/java/org/orekit/rugged/adjustment/measurements/Observables.java index 7e534ad93d55f07fb0d05a115a8897e11eb0d70c..710699f7b543666f3f7853aa9c59d43e8322eb3f 100644 --- a/src/main/java/org/orekit/rugged/adjustment/measurements/Observables.java +++ b/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