From 3143c72b3de0439ae0035520ea362527bc74f490 Mon Sep 17 00:00:00 2001
From: Jonathan Guinet <jonathan.guinet@c-s.fr>
Date: Tue, 7 Nov 2017 16:46:33 +0100
Subject: [PATCH] add comments in tutorial.
---
.../generators/GroundMeasurementGenerator.java | 9 +--------
.../generators/InterMeasurementGenerator.java | 9 +++------
.../refiningPleiades/metrics/LocalisationMetrics.java | 1 -
.../cs/examples/refiningPleiades/models/OrbitModel.java | 4 +++-
.../refiningPleiades/models/PleiadesViewingModel.java | 2 +-
5 files changed, 8 insertions(+), 17 deletions(-)
diff --git a/src/tutorials/java/fr/cs/examples/refiningPleiades/generators/GroundMeasurementGenerator.java b/src/tutorials/java/fr/cs/examples/refiningPleiades/generators/GroundMeasurementGenerator.java
index de9e085f..06192a02 100644
--- a/src/tutorials/java/fr/cs/examples/refiningPleiades/generators/GroundMeasurementGenerator.java
+++ 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);
}
}
diff --git a/src/tutorials/java/fr/cs/examples/refiningPleiades/generators/InterMeasurementGenerator.java b/src/tutorials/java/fr/cs/examples/refiningPleiades/generators/InterMeasurementGenerator.java
index 4e1864d7..fbe74b50 100644
--- a/src/tutorials/java/fr/cs/examples/refiningPleiades/generators/InterMeasurementGenerator.java
+++ b/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();
diff --git a/src/tutorials/java/fr/cs/examples/refiningPleiades/metrics/LocalisationMetrics.java b/src/tutorials/java/fr/cs/examples/refiningPleiades/metrics/LocalisationMetrics.java
index 50f86698..9071e5ac 100644
--- a/src/tutorials/java/fr/cs/examples/refiningPleiades/metrics/LocalisationMetrics.java
+++ b/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
diff --git a/src/tutorials/java/fr/cs/examples/refiningPleiades/models/OrbitModel.java b/src/tutorials/java/fr/cs/examples/refiningPleiades/models/OrbitModel.java
index 43f960a1..036391e6 100644
--- a/src/tutorials/java/fr/cs/examples/refiningPleiades/models/OrbitModel.java
+++ b/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 */
diff --git a/src/tutorials/java/fr/cs/examples/refiningPleiades/models/PleiadesViewingModel.java b/src/tutorials/java/fr/cs/examples/refiningPleiades/models/PleiadesViewingModel.java
index 8bc89c5f..bb17aa3a 100644
--- a/src/tutorials/java/fr/cs/examples/refiningPleiades/models/PleiadesViewingModel.java
+++ b/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
--
GitLab