Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • orekit/rugged
  • sdinot/rugged
  • yzokras/rugged
  • youngcle/rugged-mod
4 results
Show changes
Hide whitespace changes
Inline Side-by-side
Showing
with 2527 additions and 406 deletions
geotiff/src/main/resources/assets/org/orekit/rugged/AsterMessages_en.utf8 deleted 100644 → 0
View file @ ad214983
# no Digital Elevation Model data for point {0}, {1}
NO_DEM_DATA_FOR_POINT = no Digital Elevation Model data for point {0}, {1}
# error parsing file {0}: {1}
ERROR_PARSING_FILE = error parsing file {0}: {1}
# missing pixel scale GeoTIFF tag in file {0}
MISSING_PIXEL_SCALE = missing pixel scale GeoTIFF tag in file {0}
# missing tie point GeoTIFF tag in file {0}
MISSING_TIE_POINT = missing tie point GeoTIFF tag in file {0}
# unsupported GeoTIFF version {0}/{1}.{2} in file {3} (expected {4}/{5}.{6})
UNSUPPORTED_GEOTIFF_VERSION = unsupported GeoTIFF version {0}/{1}.{2} in file {3} (expected {4}/{5}.{6})
# unable to retrieve value for key {0} in file {1}
UNABLE_TO_RETRIEVE_VALUE_FOR_KEY = unable to retrieve value for key {0} in file {1}
# unexpected GeoTIFF key {0} in file {1}
UNEXPECTED_GEOKEY = unexpected GeoTIFF key {0} in file {1}
# GeoTIFF key {0} in file {1} has unexpected value {2} (expected {3})
UNEXPECTED_GEOKEY_VALUE = GeoTIFF key {0} in file {1} has unexpected value {2} (expected {3})
geotiff/src/main/resources/assets/org/orekit/rugged/AsterMessages_fr.utf8 deleted 100644 → 0
View file @ ad214983
# no Digital Elevation Model data for point {0}, {1}
NO_DEM_DATA_FOR_POINT = pas de données de Modèle Numérique de Terrain pour le point {0}, {1}
# error parsing file {0}: {1}
ERROR_PARSING_FILE = erreur lors de l''analyse du fichier {0} : {1}
# missing pixel scale GeoTIFF tag in file {0}
MISSING_PIXEL_SCALE = méta-donnée « pixel scale » GeoTIFF manquante dans le fichier {0}
# missing tie point GeoTIFF tag in file {0}
MISSING_TIE_POINT = méta-donnée « tie point » GeoTIFF manquante dans le fichier {0}
# unsupported GeoTIFF version {0}/{1}.{2} in file {3} (expected {4}/{5}.{6})
UNSUPPORTED_GEOTIFF_VERSION = version GeoTIFF {0}/{1}.{2} du fichier {3} non prise en compte (version attendue : {4}/{5}.{6})
# unable to retrieve value for key {0} in file {1}
UNABLE_TO_RETRIEVE_VALUE_FOR_KEY = impossible de récupérer la valeur pour le clef {0} dans le fichier {1}
# unexpected GeoTIFF key {0} in file {1}
UNEXPECTED_GEOKEY = clef GeoTIFF {0} inattendue dans le fichier {1}
# GeoTIFF key {0} in file {1} has unexpected value {2} (expected {3})
UNEXPECTED_GEOKEY_VALUE = la clef GeoTIFF {0} du fichier {1} a la valeur inattendue {2} (valeur attendue : {3})
geotiff/src/test/java/org/orekit/rugged/geotiff/AsterMessagesTest.java deleted 100644 → 0
View file @ ad214983
/* Copyright 2002-2014 CS Systèmes d'Information
* Licensed to CS Systèmes d'Information (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.orekit.rugged.geotiff;
import java.text.MessageFormat;
import java.util.Enumeration;
import java.util.Locale;
import java.util.ResourceBundle;
import org.junit.Assert;
import org.junit.Test;
public class AsterMessagesTest {
@Test
public void testMessageNumber() {
Assert.assertEquals(8, AsterMessages.values().length);
}
@Test
public void testAllKeysPresentInPropertiesFiles() {
for (final String language : new String[] { "en", "fr" } ) {
ResourceBundle bundle =
ResourceBundle.getBundle("assets/org/orekit/rugged/AsterMessages",
new Locale(language), new AsterMessages.UTF8Control());
for (AsterMessages message : AsterMessages.values()) {
final String messageKey = message.toString();
boolean keyPresent = false;
for (final Enumeration<String> keys = bundle.getKeys(); keys.hasMoreElements();) {
keyPresent |= messageKey.equals(keys.nextElement());
}
Assert.assertTrue("missing key \"" + message.name() + "\" for language " + language,
keyPresent);
}
Assert.assertEquals(language, bundle.getLocale().getLanguage());
}
}
@Test
public void testAllPropertiesCorrespondToKeys() {
for (final String language : new String[] { "en", "fr" } ) {
ResourceBundle bundle =
ResourceBundle.getBundle("assets/org/orekit/rugged/AsterMessages",
new Locale(language), new AsterMessages.UTF8Control());
for (final Enumeration<String> keys = bundle.getKeys(); keys.hasMoreElements();) {
final String propertyKey = keys.nextElement();
try {
Assert.assertNotNull(AsterMessages.valueOf(propertyKey));
} catch (IllegalArgumentException iae) {
Assert.fail("unknown key \"" + propertyKey + "\" in language " + language);
}
}
Assert.assertEquals(language, bundle.getLocale().getLanguage());
}
}
@Test
public void testNoMissingFrenchTranslation() {
for (AsterMessages message : AsterMessages.values()) {
String translated = message.getLocalizedString(Locale.FRENCH);
Assert.assertFalse(message.name(), translated.toLowerCase().contains("missing translation"));
}
}
@Test
public void testNoOpEnglishTranslation() {
for (AsterMessages message : AsterMessages.values()) {
String translated = message.getLocalizedString(Locale.ENGLISH);
Assert.assertEquals(message.getSourceString(), translated);
}
}
@Test
public void testVariablePartsConsistency() {
for (final String language : new String[] { "en", "fr" } ) {
Locale locale = new Locale(language);
for (AsterMessages message : AsterMessages.values()) {
MessageFormat source = new MessageFormat(message.getSourceString());
MessageFormat translated = new MessageFormat(message.getLocalizedString(locale));
Assert.assertEquals(message.name() + " (" + language + ")",
source.getFormatsByArgumentIndex().length,
translated.getFormatsByArgumentIndex().length);
}
}
}
}
geotiff/src/test/java/org/orekit/rugged/geotiff/AsterTileUpdaterTest.java deleted 100644 → 0
View file @ ad214983
/* Copyright 2013-2014 CS Systèmes d'Information
* Licensed to CS Systèmes d'Information (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.orekit.rugged.geotiff;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.math3.util.FastMath;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.orekit.rugged.api.RuggedException;
import org.orekit.rugged.core.raster.SimpleTile;
import org.orekit.rugged.core.raster.SimpleTileFactory;
import org.orekit.rugged.core.raster.TileFactory;
public class AsterTileUpdaterTest {
@Test
public void testAster() throws RuggedException {
File folder = warningFile.getParentFile();
List<int[]> corners = getCorners(folder);
if (corners.isEmpty()) {
// no ASTER data available in the test resources
// warn user, but don't allow the test to fail
displayWarning();
} else {
TileFactory<SimpleTile> factory = new SimpleTileFactory();
AsterTileUpdater updater = new AsterTileUpdater(folder);
for (int[] corner : corners) {
SimpleTile tile = factory.createTile();
updater.updateTile(FastMath.toRadians(corner[0] + 0.2),
FastMath.toRadians(corner[1] + 0.7),
tile);
tile.tileUpdateCompleted();
Assert.assertEquals(corner[0] + 1.0 / 7200.0, FastMath.toDegrees(tile.getMinimumLatitude()), 1.0e-10);
Assert.assertEquals(corner[1] - 1.0 / 7200.0, FastMath.toDegrees(tile.getMinimumLongitude()), 1.0e-10);
Assert.assertEquals(1.0 / 3600.0, FastMath.toDegrees(tile.getLatitudeStep()), 1.0e-10);
Assert.assertEquals(1.0 / 3600.0, FastMath.toDegrees(tile.getLongitudeStep()), 1.0e-10);
Assert.assertTrue(tile.getMinElevation() < 9000.0);
Assert.assertTrue(tile.getMaxElevation() > -1000.0);
}
}
}
@Before
public void setUp() {
try {
String warningResource = "org/orekit/rugged/geotiff/ASTER-files-warning.txt";
URL url = AsterTileUpdaterTest.class.getClassLoader().getResource(warningResource);
warningFile = new File(url.toURI().getPath());
} catch (URISyntaxException urise) {
Assert.fail(urise.getLocalizedMessage());
}
}
private List<int[]> getCorners(File folder) {
Pattern patter = Pattern.compile("ASTGTM2_([NS]\\d\\d)([EW]\\d\\d\\d)\\.zip$");
List<int[]> asterCorners = new ArrayList<int[]>();
for (final File file : folder.listFiles()) {
Matcher matcher = patter.matcher(file.getName());
if (matcher.matches()) {
int latCode = (matcher.group(1).startsWith("N") ? 1 : -1) * Integer.parseInt(matcher.group(1).substring(1));
int lonCode = (matcher.group(2).startsWith("E") ? 1 : -1) * Integer.parseInt(matcher.group(2).substring(1));
asterCorners.add(new int[] { latCode, lonCode });
}
}
return asterCorners;
}
private void displayWarning() {
try {
System.err.println("###### " + warningFile.getAbsolutePath() + " ######");
BufferedReader reader = new BufferedReader(new FileReader(warningFile));
for (String line = reader.readLine(); line != null; line = reader.readLine()) {
System.err.println(line);
}
reader.close();
System.err.println("###### " + warningFile.getAbsolutePath() + " ######");
} catch (IOException ioe) {
Assert.fail(ioe.getLocalizedMessage());
}
}
private File warningFile;
}
geotiff/src/test/resources/org/orekit/rugged/geotiff/ASTER-files-warning.txt deleted 100644 → 0
View file @ ad214983
For test purposes, some ASTER files should be put in the same folder as this file.
ASTER stands for Advanced Spaceborne Thermal Emission and Reflection Radiometer
and is a joint effort of the Ministry of Economy, Trade, and Industry (METI) of
Japan and the United States National Aeronautics and Space Administration (NASA).
More information on how to get the files is available here:
http://asterweb.jpl.nasa.gov/gdem.asp
The Rugged library cannot distribute such test files, so the distributed folder
contains only this warning text file and no real ASTER files. If the folder still does
not contain any ASTER files at tests run time, the content of this file is displayed
as a warning but the tests won't fail.
If users want to really perform tests, they have to retrieve ASTER files by themselves
and copy them in the folder. Then the files will automatically been picked up and used
for the tests. The files must have a name of the form ASTGTM2_v##h###.zip, where v
stands for either N or S, h stands for either E or W and # stands for digits. The zip
files themselves are used for the tests, users should not extract the _dem.tif files.
pom.xml
View file @ acf902ea
...@@ -4,9 +4,10 @@ ...@@ -4,9 +4,10 @@
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>org.orekit</groupId> <groupId>org.orekit</groupId>
<artifactId>rugged</artifactId> <artifactId>rugged</artifactId>
<version>1.0-SNAPSHOT</version> <version>3.0</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<name>Rugged Core</name> <name>Rugged</name>
<url>https://www.orekit.org/rugged</url>
<inceptionYear>2014</inceptionYear> <inceptionYear>2014</inceptionYear>
<description> <description>
...@@ -14,6 +15,52 @@ ...@@ -14,6 +15,52 @@
contribution to line of sight computation contribution to line of sight computation
</description> </description>
<properties>
<!-- COTS version -->
<rugged.orekit.version>11.2</rugged.orekit.version>
<rugged.junit.version>4.13.2</rugged.junit.version>
<!-- Compilers and Tools version -->
<rugged.compiler.source>1.8</rugged.compiler.source>
<rugged.compiler.target>1.8</rugged.compiler.target>
<rugged.implementation.build>${git.revision}; ${maven.build.timestamp}</rugged.implementation.build>
<!-- sonar related properties -->
<sonar.host.url>https://sonar.orekit.org/</sonar.host.url>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<rugged.spotbugs-maven-plugin.version>4.5.3.0</rugged.spotbugs-maven-plugin.version>
<rugged.jacoco-maven-plugin.version>0.8.7</rugged.jacoco-maven-plugin.version>
<rugged.maven-bundle-plugin.version>5.1.4</rugged.maven-bundle-plugin.version>
<rugged.maven-changes-plugin.version>2.12.1</rugged.maven-changes-plugin.version>
<rugged.maven-checkstyle-plugin.version>3.1.2</rugged.maven-checkstyle-plugin.version>
<rugged.checkstyle.version>9.3</rugged.checkstyle.version>
<rugged.maven-clean-plugin.version>3.1.0</rugged.maven-clean-plugin.version>
<rugged.maven-compiler-plugin.version>3.9.0</rugged.maven-compiler-plugin.version>
<rugged.maven-javadoc-plugin.version>3.3.1</rugged.maven-javadoc-plugin.version>
<rugged.maven-jar-plugin.version>3.2.2</rugged.maven-jar-plugin.version>
<rugged.maven-jxr-plugin.version>3.1.1</rugged.maven-jxr-plugin.version>
<rugged.plantuml-maven-plugin.version>1.2</rugged.plantuml-maven-plugin.version>
<rugged.plantuml.version>1.2022.1</rugged.plantuml.version>
<rugged.maven-project-info-reports-plugin.version>3.2.1</rugged.maven-project-info-reports-plugin.version>
<rugged.maven-resources-plugin.version>3.2.0</rugged.maven-resources-plugin.version>
<rugged.maven-site-plugin.version>3.10.0</rugged.maven-site-plugin.version>
<rugged.maven-source-plugin.version>3.2.1</rugged.maven-source-plugin.version>
<!-- Surefire 2.22.2 is the last to support CentOS/RedHat 7 due to
https://issues.apache.org/jira/browse/SUREFIRE-1628 -->
<rugged.maven-surefire-plugin.version>2.22.2</rugged.maven-surefire-plugin.version>
<rugged.maven-surefire-report-plugin.version>3.0.0-M5</rugged.maven-surefire-report-plugin.version>
<rugged.jgit.buildnumber.version>1.2.10</rugged.jgit.buildnumber.version>
<rugged.build-helper-maven-plugin.version>3.3.0</rugged.build-helper-maven-plugin.version>
<rugged.nexus-staging-maven-plugin.version>1.6.8</rugged.nexus-staging-maven-plugin.version>
<rugged.maven-gpg-plugin.version>3.0.1</rugged.maven-gpg-plugin.version>
<rugged.maven-install-plugin.version>3.0.0-M1</rugged.maven-install-plugin.version>
</properties>
<developers> <developers>
<developer> <developer>
<name>Luc Maisonobe</name> <name>Luc Maisonobe</name>
...@@ -23,38 +70,99 @@ ...@@ -23,38 +70,99 @@
<role>developer</role> <role>developer</role>
</roles> </roles>
</developer> </developer>
<developer>
<name>Guylaine Prat</name>
<id>guylaine</id>
<roles>
<role>developer</role>
</roles>
</developer>
<developer>
<name>Jonathan Guinet</name>
<id>jonathan</id>
<roles>
<role>developer</role>
</roles>
</developer>
<developer>
<name>Lucie Labat-all&#233;e</name>
<id>lucie</id>
<roles>
<role>developer</role>
</roles>
</developer>
</developers> </developers>
<contributors> <contributors>
<contributor>
<name>Lucian B&#259;rbulescu</name>
</contributor>
<contributor>
<name>Silvia R&#237;os Berganti&#241;os</name>
</contributor>
<contributor>
<name>Espen Bj&#248;rntvedt</name>
</contributor>
<contributor>
<name>Francesco Coccoluto</name>
</contributor>
<contributor> <contributor>
<name>Aude Espesset</name> <name>Aude Espesset</name>
</contributor> </contributor>
<contributor>
<name>Marina Ludwig</name>
</contributor>
<contributor>
<name>Lars N&#230;sbye Christensen</name>
</contributor>
<contributor>
<name>Beatriz Salazar</name>
</contributor>
</contributors> </contributors>
<organization> <organization>
<name>CS Syst&#232;mes d&#039;Information</name> <name>CS GROUP</name>
<url>http://www.c-s.fr/</url> <url>https://www.csgroup.eu/</url>
</organization> </organization>
<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
<scm>
<connection>scm:git:https://gitlab.orekit.org/orekit/rugged.git</connection>
<developerConnection>scm:git:ssh://git@gitlab.orekit.org/orekit/rugged.git</developerConnection>
<url>https://gitlab.orekit.org/orekit/rugged/tree/master</url>
</scm>
<issueManagement>
<system>Gitlab</system>
<url>https://gitlab.orekit.org/orekit/rugged/issues</url>
</issueManagement>
<distributionManagement>
<site>
<id>website</id>
<name>Rugged Website</name>
<url>scp://cochise@spoutnik.orekit.org/var/www/mvn-sites/site-rugged-${project.version}</url>
</site>
</distributionManagement>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>org.orekit</groupId> <groupId>org.orekit</groupId>
<artifactId>orekit</artifactId> <artifactId>orekit</artifactId>
<version>6.1</version> <version>${rugged.orekit.version}</version>
<type>jar</type>
<optional>false</optional>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-math3</artifactId>
<version>3.2</version>
<type>jar</type> <type>jar</type>
<optional>false</optional> <optional>false</optional>
</dependency> </dependency>
<dependency> <dependency>
<groupId>junit</groupId> <groupId>junit</groupId>
<artifactId>junit</artifactId> <artifactId>junit</artifactId>
<version>4.8.2</version> <version>${rugged.junit.version}</version>
<type>jar</type> <type>jar</type>
<scope>test</scope> <scope>test</scope>
<optional>false</optional> <optional>false</optional>
...@@ -66,49 +174,61 @@ ...@@ -66,49 +174,61 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version> <version>${rugged.maven-compiler-plugin.version}</version>
<configuration> <configuration>
<source>1.6</source> <source>${rugged.compiler.source}</source>
<target>1.6</target> <target>${rugged.compiler.target}</target>
<encoding>UTF-8</encoding> <compilerArgument>-Xlint:deprecation</compilerArgument>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId> <artifactId>maven-jar-plugin</artifactId>
<version>2.4</version> <version>${rugged.maven-jar-plugin.version}</version>
<configuration> <configuration>
<archive> <archive>
<manifest> <manifestFile>${project.build.directory}/osgi/MANIFEST.MF</manifestFile>
<addClasspath>true</addClasspath> <manifestEntries>
<classpathPrefix>lib/</classpathPrefix> <X-Compile-Source-JDK>${rugged.compiler.source}</X-Compile-Source-JDK>
</manifest> <X-Compile-Target-JDK>${rugged.compiler.target}</X-Compile-Target-JDK>
</archive> </manifestEntries>
</configuration> </archive>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.4</version>
<configuration>
<descriptors>
<descriptor>src/main/assembly/source-assembly.xml</descriptor>
<descriptor>src/main/assembly/binary-assembly.xml</descriptor>
</descriptors>
</configuration> </configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>${rugged.maven-resources-plugin.version}</version>
<executions> <executions>
<execution> <execution>
<id>make-assembly</id> <phase>process-resources</phase>
<phase>package</phase>
<goals> <goals>
<goal>single</goal> <goal>copy-resources</goal>
</goals> </goals>
<configuration>
<outputDirectory>${project.build.outputDirectory}/META-INF</outputDirectory>
<resources>
<resource>
<directory>.</directory>
<includes>
<include>LICENSE.txt</include>
<include>NOTICE.txt</include>
</includes>
</resource>
</resources>
</configuration>
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>${rugged.maven-clean-plugin.version}</version>
</plugin>
<plugin> <plugin>
<groupId>org.jacoco</groupId> <groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId> <artifactId>jacoco-maven-plugin</artifactId>
<version>0.6.3.201306030806</version> <version>${rugged.jacoco-maven-plugin.version}</version>
<executions> <executions>
<execution> <execution>
<id>prepare-agent</id> <id>prepare-agent</id>
...@@ -116,6 +236,11 @@ ...@@ -116,6 +236,11 @@
<goals> <goals>
<goal>prepare-agent</goal> <goal>prepare-agent</goal>
</goals> </goals>
<configuration>
<excludes>
<exclude>fr/cs/examples/**/*.class</exclude>
</excludes>
</configuration>
</execution> </execution>
<execution> <execution>
<id>report</id> <id>report</id>
...@@ -123,6 +248,11 @@ ...@@ -123,6 +248,11 @@
<goals> <goals>
<goal>report</goal> <goal>report</goal>
</goals> </goals>
<configuration>
<excludes>
<exclude>fr/cs/examples/**/*.class</exclude>
</excludes>
</configuration>
</execution> </execution>
<execution> <execution>
<id>check</id> <id>check</id>
...@@ -168,27 +298,60 @@ ...@@ -168,27 +298,60 @@
</rule> </rule>
</rules> </rules>
<haltOnFailure>false</haltOnFailure> <haltOnFailure>false</haltOnFailure>
<excludes>
<exclude>fr/cs/examples/**/*.class</exclude>
</excludes>
</configuration> </configuration>
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>${rugged.maven-site-plugin.version}</version>
<dependencies>
<dependency><!-- add support for ssh/scp -->
<groupId>org.apache.maven.wagon</groupId>
<artifactId>wagon-ssh</artifactId>
<version>3.3.4</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>${rugged.maven-project-info-reports-plugin.version}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
<version>${rugged.maven-changes-plugin.version}</version>
</plugin>
<plugin> <plugin>
<groupId>com.github.jeluard</groupId> <groupId>com.github.jeluard</groupId>
<artifactId>maven-plantuml-plugin</artifactId> <artifactId>plantuml-maven-plugin</artifactId>
<version>7940</version> <version>${rugged.plantuml-maven-plugin.version}</version>
<configuration> <configuration>
<charset>UTF-8</charset>
<sourceFiles> <sourceFiles>
<directory>${basedir}</directory> <directory>${basedir}/src/design</directory>
<includes> <includes>
<include> <include>
design/**/*.puml *.puml
</include> </include>
</includes> </includes>
</sourceFiles> </sourceFiles>
<outputDirectory> <outputDirectory>
${basedir}/target/site/images/design ${project.build.directory}/site/images/design
</outputDirectory> </outputDirectory>
</configuration> </configuration>
<dependencies>
<dependency>
<groupId>net.sourceforge.plantuml</groupId>
<artifactId>plantuml</artifactId>
<version>${rugged.plantuml.version}</version>
</dependency>
</dependencies>
<executions> <executions>
<execution> <execution>
<phase>pre-site</phase> <phase>pre-site</phase>
...@@ -197,13 +360,48 @@ ...@@ -197,13 +360,48 @@
</goals> </goals>
</execution> </execution>
</executions> </executions>
</plugin>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<version>${rugged.maven-bundle-plugin.version}</version>
<extensions>true</extensions>
<configuration>
<archive>
<forced>true</forced>
</archive>
<manifestLocation>${project.build.directory}/osgi</manifestLocation>
<instructions>
<Export-Package>org.orekit.rugged.*;version=${project.version};-noimport:=true</Export-Package>
<Bundle-DocURL>${project.url}</Bundle-DocURL>
</instructions>
</configuration>
<executions>
<execution>
<id>bundle-manifest</id>
<phase>process-classes</phase>
<goals>
<goal>manifest</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${rugged.maven-checkstyle-plugin.version}</version>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>net.sourceforge.plantuml</groupId> <groupId>com.puppycrawl.tools</groupId>
<artifactId>plantuml</artifactId> <artifactId>checkstyle</artifactId>
<version>7986</version> <version>${rugged.checkstyle.version}</version>
</dependency> </dependency>
</dependencies> </dependencies>
<configuration>
<configLocation>${basedir}/checkstyle.xml</configLocation>
<enableRulesSummary>false</enableRulesSummary>
<headerLocation>${basedir}/license-header.txt</headerLocation>
</configuration>
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
...@@ -213,38 +411,39 @@ ...@@ -213,38 +411,39 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId> <artifactId>maven-site-plugin</artifactId>
<version>3.3</version> <version>${rugged.maven-site-plugin.version}</version>
<configuration>
<inputEncoding>UTF-8</inputEncoding>
<outputEncoding>UTF-8</outputEncoding>
</configuration>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.jacoco</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>jacoco-maven-plugin</artifactId> <artifactId>maven-project-info-reports-plugin</artifactId>
<version>0.6.3.201306030806</version> <version>${rugged.maven-project-info-reports-plugin.version}</version>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.codehaus.mojo</groupId> <groupId>com.github.spotbugs</groupId>
<artifactId>findbugs-maven-plugin</artifactId> <artifactId>spotbugs-maven-plugin</artifactId>
<version>2.5.3</version> <version>${rugged.spotbugs-maven-plugin.version}</version>
<configuration> <configuration>
<threshold>Normal</threshold> <threshold>Normal</threshold>
<effort>Default</effort> <effort>Default</effort>
<excludeFilterFile>${basedir}/findbugs-exclude-filter.xml</excludeFilterFile> <onlyAnalyze>org.orekit.rugged.*</onlyAnalyze>
</configuration> <excludeFilterFile>${basedir}/spotbugs-exclude-filter.xml</excludeFilterFile>
</configuration>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId> <artifactId>maven-surefire-plugin</artifactId>
<version>2.16</version> <version>${rugged.maven-surefire-plugin.version}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
<version>${rugged.maven-surefire-report-plugin.version}</version>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId> <artifactId>maven-checkstyle-plugin</artifactId>
<version>2.11</version> <version>${rugged.maven-checkstyle-plugin.version}</version>
<configuration> <configuration>
<encoding>UTF-8</encoding>
<configLocation>${basedir}/checkstyle.xml</configLocation> <configLocation>${basedir}/checkstyle.xml</configLocation>
<enableRulesSummary>false</enableRulesSummary> <enableRulesSummary>false</enableRulesSummary>
<headerLocation>${basedir}/license-header.txt</headerLocation> <headerLocation>${basedir}/license-header.txt</headerLocation>
...@@ -260,9 +459,9 @@ ...@@ -260,9 +459,9 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId> <artifactId>maven-changes-plugin</artifactId>
<version>2.9</version> <version>${rugged.maven-changes-plugin.version}</version>
<configuration> <configuration>
<xmlPath>${basedir}/src/site/xdoc/changes.xml</xmlPath> <teamlist>team.html</teamlist>
</configuration> </configuration>
<reportSets> <reportSets>
<reportSet> <reportSet>
...@@ -275,26 +474,25 @@ ...@@ -275,26 +474,25 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId> <artifactId>maven-jxr-plugin</artifactId>
<version>2.3</version> <version>${rugged.maven-jxr-plugin.version}</version>
<configuration> <configuration>
<outputEncoding>UTF-8</outputEncoding>
<linkJavadoc>false</linkJavadoc> <linkJavadoc>false</linkJavadoc>
<bottom><![CDATA[Copyright &copy; ${project.inceptionYear}-{currentYear} <a href="https://www.csgroup.eu/">CS GROUP</a>. All rights reserved.]]></bottom>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version> <version>${rugged.maven-javadoc-plugin.version}</version>
<configuration> <configuration>
<overview>${basedir}/src/main/java/org/orekit/rugged/overview.html</overview> <bottom><![CDATA[Copyright &copy; ${project.inceptionYear}-{currentYear} <a href="https://www.csgroup.eu/">CS GROUP</a>. All rights reserved.]]></bottom>
<links> <links>
<link>http://download.oracle.com/javase/1.6.0/docs/api/</link> <link>https://docs.oracle.com/javase/8/docs/api/</link>
<link>http://commons.apache.org/math/apidocs/</link> <link>https://www.hipparchus.org/apidocs/</link>
<link>https://www.orekit.org/static/apidocs/index.html</link> <link>https://www.orekit.org/site-orekit-${rugged.orekit.version}/apidocs/</link>
</links> </links>
<charset>UTF-8</charset> <source>${rugged.compiler.source}</source>
<docencoding>UTF-8</docencoding> <doclint>none</doclint>
<encoding>UTF-8</encoding>
</configuration> </configuration>
<reportSets> <reportSets>
<reportSet> <reportSet>
...@@ -304,29 +502,213 @@ ...@@ -304,29 +502,213 @@
</reportSet> </reportSet>
</reportSets> </reportSets>
</plugin> </plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>${rugged.jacoco-maven-plugin.version}</version>
</plugin>
</plugins> </plugins>
</reporting> </reporting>
<profiles> <profiles>
<profile>
<id>git</id>
<activation>
<file>
<exists>.git</exists>
</file>
</activation>
<build>
<plugins>
<plugin>
<groupId>ru.concerteza.buildnumber</groupId>
<artifactId>maven-jgit-buildnumber-plugin</artifactId>
<version>${rugged.jgit.buildnumber.version}</version>
<executions>
<execution>
<phase>prepare-package</phase>
<goals>
<goal>extract-buildnumber</goal>
</goals>
</execution>
</executions>
<configuration>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>${rugged.maven-jar-plugin.version}</version>
<configuration>
<archive>
<manifestFile>${project.build.directory}/osgi/MANIFEST.MF</manifestFile>
<manifestEntries>
<Implementation-Build>${rugged.implementation.build}</Implementation-Build>
<X-Compile-Source-JDK>${rugged.compiler.source}</X-Compile-Source-JDK>
<X-Compile-Target-JDK>${rugged.compiler.target}</X-Compile-Target-JDK>
<Automatic-Module-Name>org.orekit.rugged</Automatic-Module-Name>
</manifestEntries>
</archive>
</configuration>
</plugin>
</plugins>
</build>
</profile>
<profile> <profile>
<id>release</id> <id>release</id>
<!-- distributionManagement>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
</repository>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement-->
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId> <artifactId>maven-source-plugin</artifactId>
<version>2.1.2</version> <version>${rugged.maven-source-plugin.version}</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${rugged.maven-javadoc-plugin.version}</version>
<executions> <executions>
<execution> <execution>
<id>create-source-jar</id> <id>attach-javadocs</id>
<goals> <goals>
<goal>jar</goal> <goal>jar</goal>
</goals> </goals>
<phase>package</phase>
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>${rugged.nexus-staging-maven-plugin.version}</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>false</autoReleaseAfterClose>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>${rugged.build-helper-maven-plugin.version}</version>
<executions>
<execution>
<id>attach-artifacts</id>
<phase>verify</phase>
<goals>
<goal>attach-artifact</goal>
</goals>
<configuration>
<artifacts>
<artifact>
<file>${basedir}/target/rugged-${project.version}-sources.jar</file>
<type>source-jar</type>
</artifact>
</artifacts>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>${rugged.maven-gpg-plugin.version}</version>
<configuration>
<gpgArguments>
<arg>--digest-algo=SHA512</arg>
</gpgArguments>
<!-- keyname>0802AB8C87B0B1AEC1C1C5871550FDBD6375C33B</keyname-->
</configuration>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<version>${rugged.maven-install-plugin.version}</version>
<configuration>
<createChecksum>true</createChecksum>
</configuration>
</plugin>
</plugins> </plugins>
</build>
</profile>
<profile>
<!-- A profile to configure staging deployment (for continuous integration process) -->
<id>ci-deploy</id>
<distributionManagement>
<repository>
<id>ci-releases</id>
<url>https://packages.orekit.org/repository/maven-releases/</url>
</repository>
<snapshotRepository>
<id>ci-snapshots</id>
<url>https://packages.orekit.org/repository/maven-snapshots/</url>
</snapshotRepository>
</distributionManagement>
</profile>
<profile>
<id>eclipse</id>
<activation>
<property>
<name>m2e.version</name>
</property>
</activation>
<build>
<pluginManagement>
<plugins>
<plugin>
<!--This plugin's configuration is used to store Eclipse m2e settings only. It has no influence on the Maven build itself.-->
<groupId>org.eclipse.m2e</groupId>
<artifactId>lifecycle-mapping</artifactId>
<version>1.0.0</version>
<configuration>
<lifecycleMappingMetadata>
<pluginExecutions>
<pluginExecution>
<pluginExecutionFilter>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<versionRange>[${rugged.maven-bundle-plugin.version},)</versionRange>
<goals>
<goal>manifest</goal>
</goals>
</pluginExecutionFilter>
<action>
<ignore></ignore>
</action>
</pluginExecution>
</pluginExecutions>
</lifecycleMappingMetadata>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build> </build>
</profile> </profile>
</profiles> </profiles>
......
spotbugs-exclude-filter.xml 0 → 100644
View file @ acf902ea
<?xml version="1.0"?>
<!--
This file contains some false positive bugs detected by spotbugs. Their
false positive nature has been analyzed individually and they have been
put here to instruct findbugs it must ignore them.
-->
<FindBugsFilter>
<!-- The following internal representation exposure are intentional,
They are used to pass data back and forth between classes
-->
<Match>
<Class name="org.orekit.rugged.adjustment.AdjustmentContext"/>
<Method name="&lt;init>"
params="java.util.Collection,
org.orekit.rugged.adjustment.measurements.Observables"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.adjustment.GroundOptimizationProblemBuilder"/>
<Method name="&lt;init>"
params="java.util.List,org.orekit.rugged.adjustment.measurements.Observables,
org.orekit.rugged.api.Rugged"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.adjustment.measurements.SensorToSensorMapping"/>
<Or>
<Method name="getBodyDistances"
params=""
returns="java.util.List" />
<Method name="getLosDistances"
params=""
returns="java.util.List" />
</Or>
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.api.Rugged"/>
<Or>
<Method name="getEllipsoid"
params=""
returns="org.orekit.rugged.utils.ExtendedEllipsoid" />
<Method name="getRefractionCorrection"
params=""
returns="org.orekit.rugged.refraction.AtmosphericRefraction" />
</Or>
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.api.RuggedBuilder"/>
<Or>
<Method name="getEllipsoid"
params=""
returns="org.orekit.rugged.utils.ExtendedEllipsoid" />
<Method name="getPositionsVelocities"
params=""
returns="java.util.List" />
<Method name="getQuaternions"
params=""
returns="java.util.List" />
<Method name="getRefractionCorrection"
params=""
returns="org.orekit.rugged.refraction.AtmosphericRefraction" />
</Or>
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.api.RuggedBuilder"/>
<Or>
<Method name="setRefractionCorrection"
params="org.orekit.rugged.refraction.AtmosphericRefraction"
returns="org.orekit.rugged.api.RuggedBuilder" />
<Method name="setTrajectory"
params="double,
int,
org.orekit.utils.CartesianDerivativesFilter,
org.orekit.utils.AngularDerivativesFilter,
org.orekit.propagation.Propagator"
returns="org.orekit.rugged.api.RuggedBuilder" />
<Method name="setTrajectory"
params="org.orekit.frames.Frame,
java.util.List,
int,
org.orekit.utils.CartesianDerivativesFilter,
java.util.List,
int,
org.orekit.utils.AngularDerivativesFilter"
returns="org.orekit.rugged.api.RuggedBuilder" />
</Or>
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.errors.RuggedExceptionWrapper"/>
<Method name="getException"
params=""
returns="org.orekit.rugged.errors.RuggedException" />
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.errors.RuggedExceptionWrapper"/>
<Method name="&lt;init>"
params="org.orekit.rugged.errors.RuggedException"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.linesensor.LineSensor"/>
<Method name="getPosition"
params=""
returns="org.hipparchus.geometry.euclidean.threed.Vector3D" />
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.linesensor.LineSensor"/>
<Method name="&lt;init>"
params="java.lang.String,
org.orekit.rugged.linesensor.LineDatation,
org.hipparchus.geometry.euclidean.threed.Vector3D,
org.orekit.rugged.los.TimeDependentLOS"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.linesensor.SensorMeanPlaneCrossing"/>
<Method name="getMeanPlaneNormal"
params=""
returns="org.hipparchus.geometry.euclidean.threed.Vector3D" />
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.linesensor.SensorMeanPlaneCrossing"/>
<Method name="&lt;init>"
params="org.orekit.rugged.linesensor.LineSensor,
org.orekit.rugged.utils.SpacecraftToObservedBody,
int,
int,
boolean,
boolean,
int,
double,
org.hipparchus.geometry.euclidean.threed.Vector3D,
java.util.stream.Stream"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.linesensor.SensorMeanPlaneCrossing$CrossingResult"/>
<Or>
<Method name="getTarget"
params=""
returns="org.hipparchus.geometry.euclidean.threed.Vector3D" />
<Method name="getTargetDirection"
params=""
returns="org.hipparchus.geometry.euclidean.threed.Vector3D" />
<Method name="getTargetDirectionDerivative"
params=""
returns="org.hipparchus.geometry.euclidean.threed.Vector3D" />
</Or>
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.linesensor.SensorMeanPlaneCrossing$CrossingResult"/>
<Method name="&lt;init>"
params="org.orekit.time.AbsoluteDate,
double,
org.hipparchus.geometry.euclidean.threed.Vector3D,
org.hipparchus.geometry.euclidean.threed.Vector3D,
org.hipparchus.geometry.euclidean.threed.Vector3D"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.los.FixedRotation"/>
<Method name="&lt;init>"
params="java.lang.String,
org.hipparchus.geometry.euclidean.threed.Vector3D,double"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.los.LOSBuilder"/>
<Method name="&lt;init>"
params="java.util.List"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.los.PolynomialRotation"/>
<Method name="&lt;init>"
params="java.lang.String,
org.hipparchus.geometry.euclidean.threed.Vector3D,
org.orekit.time.AbsoluteDate,
double[]"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.refraction.AtmosphericRefraction"/>
<Method name="getComputationParameters"
params=""
returns="org.orekit.rugged.refraction.AtmosphericComputationParameters" />
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.orekit.rugged.refraction.MultiLayerModel"/>
<Or>
<Method name="&lt;init>"
params="org.orekit.rugged.utils.ExtendedEllipsoid"
returns="void" />
<Method name="&lt;init>"
params="org.orekit.rugged.utils.ExtendedEllipsoid,
java.util.List"
returns="void" />
</Or>
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.utils.RoughVisibilityEstimator"/>
<Method name="&lt;init>"
params="org.orekit.bodies.OneAxisEllipsoid,
org.orekit.frames.Frame,java.util.List"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<Match>
<Class name="org.orekit.rugged.utils.SpacecraftToObservedBody"/>
<Method name="&lt;init>"
params="org.orekit.frames.Frame,
org.orekit.frames.Frame,
org.orekit.time.AbsoluteDate,
org.orekit.time.AbsoluteDate,
double,
double,
java.util.List,
java.util.List"
returns="void" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
</FindBugsFilter>
src/changes/changes.xml 0 → 100644
View file @ acf902ea
<?xml version="1.0" encoding="UTF-8" ?>
<!-- Copyright 2013-2022 CS GROUP
Licensed to CS GROUP (CS) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
CS licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Rugged Changes</title>
</properties>
<body>
<release version="3.0" date="2022-07-05" description="This is a major release.
It fixes a few bugs.
This version depends on Orekit 11.2 and Hipparchus 2.1.">
<action dev="luc" type="update" issue="388">
Fixed longitude normalization issue with tiles.
</action>
<action dev="guylaine" type="update" issue="391">
Fixed inverse location issue with atmospheric refraction.
</action>
<action dev="luc" type="update" issue="387">
Updated dependencies to Orekit 11.2 (and Hipparchus 2.1 ).
</action>
<action dev="guylaine" type="update" issue="390">
Changed CS Group website URL.
</action>
<action dev="guylaine" type="update">
Updated link to Sergeï Tanygin's paper about attitude interpolation in documentation.
</action>
</release>
<release version="2.2" date="2020-07-31" description="This is a minor release.
It adds access to algorithm identifier,
corrects an Earth constant for model IERS96,
improves documentation and fixes a few bugs.
Automatic building, release and code analysis are available with Gitlab CI.
This version depends on Orekit 10.2 and Hipparchus 1.7.">
<action dev="guylaine" type="update" issue="383">
Updated dependencies to Orekit 10.2 (and Hipparchus 1.7).
</action>
<action dev="guylaine" type="fix" issue="384">
Add connection with Gitlab CI to allow automatic building and release,
as well as automatic code analysis (https://sonar.orekit.org/dashboard?id=org.orekit%3Arugged).
</action>
<action dev="luc" type="fix" issue="386">
Fix a unit test due to CI specificity.
</action>
<action dev="guylaine" type="update" issue="381">
Give access to algorithm identifier (DUVENHAGE,
CONSTANT_ELEVATION_OVER_ELLIPSOID, ...) with the new method getAlgorithmId().
</action>
<action dev="guylaine" type="update" issue="385">
Use the new Derivative&lt;T&gt; interface from Hipparchus.
</action>
<action dev="guylaine" type="fix" issue="379">
Correct erroneous Earth flattening for model IERS96 in RuggedBuilder.
</action>
<action dev="guylaine" type="update" issue="378">
Replace in RuggedBuilder hard-coded constants by Orekit Earth constants.
</action>
<action dev="guylaine" type="update">
Update building explanations in static site and remove redundant BUILDING.txt.
</action>
<action dev="guylaine" type="add">
Create a release guide in static site.
</action>
<action dev="guylaine" type="update">
Update deprecated method of Orekit DataProvidersManager class.
</action>
<action dev="guylaine" type="update" issue="382">
Remove explicit dependency to Hipparchus library.
</action>
<action dev="guylaine" type="add">
Add package-info documentation.
</action>
</release>
<release version="2.1" date="2019-03-14" description="This is a minor release.
It adds refraction in inverse location and fixes a few bugs. This version depends
on Orekit 9.3.1 and Hipparchus 1.4.">
<action dev="guylaine" type="update">
Updated dependencies to Orekit 9.3.1 and Hipparchus 1.4.
</action>
<action dev="luc" type="fix" issue="376">
Direct location may result to a null result in some very rugged region.
In Duvenhage algorithm, in the refineIntersection method for the DEM,
some rare cases led to no intersection (as a result from SimpleTile.cellIntersection)
with the closeGuess given as input of refineIntersection.By shifting the solution
along the LOS direction, with an iterative process, we are able to find the intersection.
</action>
<action dev="guylaine" type="fix" issue="377">
Add the possibility to suspend and resume the dump.
When performing a dump, in some cases, some extra informations are dumped
but are not relevant.
For instance when updating a tile for a SRTM tile, we need to add the geoid
value of the current point. In the dump file, the geoid tile is also dumped
and it leads to bad results when performing the DumpReplayer, as the geoid
elevations are read instead of the real elevations.
</action>
<action dev="guylaine" type="update">
Enable null in dump of direct or inverse location results.
If direct or inverse location gave "null" as a result, it was not dumped.
</action>
<action dev="guylaine" type="update">
Improve test coverage of classes related to dump (org.orekit.rugged.errors).
</action>
<action dev="guylaine" type="fix" issue="373">
Changed RuggedException from checked to unchecked exception.
Most functions do throw such exceptions. As they are unchecked, they are
not advertised in either `throws` statements in the function signature or
in the javadoc. So users must consider that as soon as they use any Rugged
feature, an unchecked `RuggedException` may be thrown. In most cases, users
will not attempt to recover for this but will only use them to display or
log a meaningful error message.
</action>
<action dev="guylaine" type="fix" issue="372">
Add (optional) atmospheric refraction for inverse location.
In Rugged 2.0, only the direct location can take into account the atmospheric refraction.
</action>
<action dev="guylaine" type="add" due-to="Issam Boukerch">
Changed terms for refining tutorials.
The "fulcrum points" term is changed into "Ground Control Points (GCP)" and
the "liaison points" term into "tie points".
</action>
<action dev="luc" type="fix" issue="371">
For refining computation, correct the constructor of the class
adjustment.measurements.SensorToGroundMapping due to a parameters reversal error.
</action>
<action dev="guylaine" type="fix" issue="256">
Bad check of maxDate validity in utils.SpacecraftToObservedBody.SpacecraftToObservedBody
method.
</action>
<action dev="luc" type="add" due-to="Lars Næsbye Christensen">
Updated Danish translations of error messages.
</action>
<action dev="luc" type="add" due-to="Roberto Alacevich">
Updated Italian translations of error messages.
</action>
<action dev="guylaine" type="add" due-to="Espen Bjørntvedt">
Updated Norwegian translations of error messages.
</action>
<action dev="luc" type="add" due-to="Beatriz Salazar García">
Updated Spanish translations of error messages.
</action>
</release>
<release version="2.0" date="2017-12-19" description="This is a major release.
It mainly provides a refinement feature (i.e. adjusting the viewing model
parameters to match ground control points.">
<action dev="guylaine" type="update">
Updated dependencies to Orekit 9.1 and Hipparchus 1.2.
</action>
<action dev="guylaine" type="add" due-to="Jonathan Guinet, Lucie Labat-Allée">
Added refinement feature, to adjust viewing model parameters
</action>
<action dev="luc" type="add" due-to="Lars Næsbye Christensen" issue="343">
Added Danish translations.
</action>
<action dev="luc" type="update">
Updated dependency to Hipparchus 1.1, released on 2017, March 16th.
</action>
<action dev="luc" type="add" due-to="Sergio Esteves">
Added atmospheric refraction.
This work was done under the frame of ESA SOCIS 2016 program.
Implements feature #185.
</action>
<action dev="luc" type="update">
Replaced the ad-hoc parameters with Orekit ParameterDriver that are
used in Orekit orbit determination feature.
</action>
<action dev="luc" type="update">
Updated dependencies to Orekit 8.0 and Hipparchus 1.0.
</action>
<action dev="guylaine" type="update">
Converted Rugged to use the Hipparchus library.
</action>
</release>
<release version="1.0" date="2016-02-10"
description="This is the first official release of Rugged. It includes direct and
inverse location for push-broom sensors.">
<action dev="luc" type="add">
Added a getAlgorithm method at Rugged level. This allows for example to
retrieve the DEM elevation for a latitude/longitude pair.
</action>
<action dev="luc" type="add" >
Added a utility to help estimate visibility and set up min/max search lines.
</action>
<action dev="luc" type="fix" >
Improved latitude crossing robustness.
</action>
<action dev="luc" type="add" >
Added a protection against infinite loops in Duvenhage algorithm.
</action>
<action dev="luc" type="add" >
Added a CONSTANT_ELEVATION_OVER_ELLIPSOID algorithm, similar in spirit
to the IGNORE_DEM_USE_ELLIPSOID, but with a user-specified elevation
instead of always using 0.0 elevation.
Implements feature #187.
</action>
<action dev="luc" type="add" due-to="Espen Bjørntvedt">
Added Norwegian translation of error messages.
</action>
<action dev="luc" type="update">
Updated Apache Commons Version as 3.4 has now been released.
</action>
<action dev="luc" type="add" >
Added partial derivatives for line-of-sights with respect to transforms parameters.
This is the first step towards los calibration.
</action>
<action dev="luc" type="add" >
Added sequences of transforms for lines-of-sight.
</action>
<action dev="luc" type="add" >
Added a builder for line-of-sight lists.
</action>
<action dev="luc" type="update" >
Reorganized packages.
</action>
<action dev="luc" type="add" >
Added getters to the RuggedBuilder.
</action>
<action dev="luc" type="fix" >
Force reset of builder interpolator when time span is changed.
</action>
<action dev="luc" type="add" due-to="Lucian Barbulescu">
Added Romanian translation of error messages.
</action>
<action dev="luc" type="update" >
Use builder pattern and fluent interface to create the top level Rugged instance.
</action>
<action dev="luc" type="fix" >
Force geodetic points to remain in the same longitude range as the tile of the
Digital Elevation Model they belong to.
</action>
<action dev="luc" type="fix" >
Added a protection agains some extremely rare numerical problems
in Duvenhage algorithm.
</action>
<action dev="luc" type="add" due-to="Silvia Ríos Bergantiños and Beatriz Salazar">
Added Spanish and Galician translations of error messages.
</action>
<action dev="luc" type="add" due-to="Marina Ludwig">
Added German translation of error messages.
</action>
<action dev="luc" type="add" due-to="Francesco Coccoluto">
Added Italian translation of error messages.
</action>
<action dev="luc" type="fix">
Added detection of wrong position/line-of-sight that misses the ground.
</action>
<action dev="luc" type="add">
Added a way to reuse transform interpolator from one run to another
by dumping its state into a file, thus avoiding costly initialization.
</action>
<action dev="luc" type="add">
Time step for internal transform caching is now user-configurable.
</action>
<action dev="luc" type="update">
Switched maven configuration to multi-modules.
</action>
<action dev="luc" type="update">
Updated UML diagrams.
</action>
<action dev="luc" type="update">
Moved TileUpdate to raster package.
</action>
<action dev="luc" type="update">
Finalized direct location diagrams.
</action>
<action dev="luc" type="update">
renamed core package into intersection.
</action>
<action dev="luc" type="update">
Created a utils package.
</action>
<action dev="luc" type="update">
Moved raster package one level up.
</action>
<action dev="luc" type="fix">
Fixed top package name.
</action>
<action dev="luc" type="update">
Updated maven plugins versions.
</action>
<action dev="luc" type="update">
Updated Apache Commons Version as 3.3 has now been released.
</action>
<action dev="luc" type="update">
Updated Orekit version.
</action>
<action dev="luc" type="update">
Improved performance.
</action>
<action dev="luc" type="update">
Disabled timing test for inverse location.
</action>
<action dev="luc" type="update">
Improved inverse location speed again!
</action>
<action dev="luc" type="update">
Added inverse location from latitude and longitude only.
When only latitude and longitude are specified, the elevation is
automatically computed from the Digital Elevation Model.
</action>
<action dev="luc" type="update">
Simplified direct location.
</action>
<action dev="luc" type="update">
Improved inverse location performances.
</action>
<action dev="luc" type="update">
Added rate to the LineDatation interface.
</action>
<action dev="luc" type="update">
Disable timing test by default.
</action>
<action dev="luc" type="update">
Renamed setLineSensor into addLineSensor.
The new name explains more clearly that several sensors can be set up at
once.
</action>
<action dev="luc" type="fix">
First working version of inverse location.
</action>
<action dev="luc" type="update">
Streamlined line sensor model.
We now use a single position for all pixels (but of course still
different line-of-sight vectors), as it doesn't really make sense to
consider different positions as pixels are only a few microns away from
each other.
</action>
<action dev="luc" type="update">
Ensure sensor mean plane normal has a deterministic orientation.
</action>
<action dev="luc" type="update">
Slightly changed the intersection refinement in flat-body.
</action>
<action dev="luc" type="update">
Added a flat-body implementation of refineIntersection.
The former implementation ignored the flat-body flag and in fact
corrected the flat-body ...
</action>
<action dev="luc" type="fix">
Fixed mean reference point position.
</action>
<action dev="luc" type="update">
Improved light time correction.
The current altitude must be considered when computing light time
correction. Previous computation was slightly wrong as it only computed
light time from the ellipsoid. This induced problems when computing
inverse correction.
</action>
<action dev="luc" type="fix">
Fixed computation of latitude crossings for line of sight.
In some cases, the line of sight has two intersections with a given
iso-latitude cone, and the selecting the closes one to spacecraft was
not always the appropriate choice. An hint from the caller was needed,
as a point close to the desired intersection.
</action>
<action dev="luc" type="fix">
Fixed non-bracketing error near start of sensor line.
</action>
<action dev="luc" type="update">
Moved reference date from Rugged top class to LineDatation model.
</action>
<action dev="luc" type="update">
Remove check for context, which is ensured since construction.
</action>
<action dev="luc" type="update">
Improved speed of inverse location test.
</action>
<action dev="luc" type="fix">
First working version of inverse location.
It works in simple cases (no light time correction and no aberration of
light correction), and is still really slow.
</action>
<action dev="luc" type="add">
Started implementation of inverse location (not working yet).
</action>
<action dev="luc" type="update">
Removed a check that is not needed anymore.
The indices are now checked at caller level.
</action>
<action dev="luc" type="update">
Added an option to use Duvenhage algorithm with flat-Earth hypothesis.
This option is mainly intended for comparison with existing systems. It
should not be used for operational systems and the full Duvenhage
algorithm with line-of-sight bending in geodetic coordinates should be
used instead.
</action>
<action dev="luc" type="fix">
Avoid array bounds error when interpolating exactly at tile edges.
</action>
<action dev="luc" type="update">
Added automatic mean plane computation for line sensors.
This will allow implementing inverse location.
</action>
<action dev="luc" type="update">
Allow direct use of Orekit inertial frames and ellipsoids.
</action>
<action dev="luc" type="update">
Added optional aberration of light correction.
</action>
<action dev="luc" type="update">
Renamed ligth travel time compensation into light time correction.
This better matches physics naming conventions.
</action>
<action dev="luc" type="update">
Moved light travel compensation setting out of construction.
This setting is not intended to be used often (in fact it should be used
only for validation against other systems), so forcing user to set it in
all cases was a bad idea. Now the default configuration is to compensate
and if user does not want to compensate, he can inhibate it by calling a
separate method after construction.
</action>
<action dev="luc" type="update">
Fixing light travel time or not is now a user setting.
</action>
<action dev="luc" type="update">
Configure tiles updater at construction time.
</action>
<action dev="luc" type="update">
Replaced setGeneralContext with constructors.
</action>
<action dev="luc" type="update">
Replaced Rugged interface with a class.
</action>
<action dev="luc" type="update">
Moved enumerates out of Rugged top level interface.
</action>
<action dev="luc" type="update">
Removed SatellitePV and SatelliteQ classes.
We now use directly Orekit PVCoordinates and Apache Commons Math
Rotation classes.
</action>
<action dev="luc" type="update">
Remove GroundPoint class.
We use directly the Orekit NormalizedGeodeticPoint now.
</action>
<action dev="luc" type="add">
Added ITRF equinox, for applications that rely on it...
</action>
<action dev="luc" type="fix">
Fixed virtual "wall" appearing at tiles boundaries.
</action>
<action dev="luc" type="fix">
Avoid an infinite loop near tiles boundaries.
</action>
<action dev="luc" type="fix">
Fixed error loading elevation from Aster files.
</action>
<action dev="luc" type="update">
Improved accuracy by taking speed of light into account in transforms.
</action>
<action dev="luc" type="update">
Slight speed-up with a dedicated pointOnGround method.
</action>
<action dev="luc" type="update">
Added writing of grid file to full test.
</action>
<action dev="luc" type="update">
Don't use a numerical propagator within direct location.
As the time between each line is really small (milliseconds), it is
better to propagate first and use an ephemeris later.
</action>
<action dev="luc" type="add">
New global test (temporary, much too computing intensive).
</action>
<action dev="luc" type="add">
Added a default linear model for line datation.
</action>
<action dev="luc" type="update">
Avoid line-of-sight splitting before its start.
</action>
<action dev="luc" type="fix">
Fixed a numerical issue at tile exit.
The low point at tile minimum elevation was computed with a tiny
positive error, meaning the point really was above min elevation (at
micrometer level). The line segment between entry and exit stopped just
before traversing the Digital Elevation Model, and an error was
triggered.
The solution was to take some margin when computing the segment
endpoints at entry and exit: we now start above max elevation and end
below min elevation so the intersection should be really on the line.
</action>
<action dev="luc" type="update">
Greatly improved accuracy of direct location.
There were some small errors (at centimeter level) as result points may
be slightly out of line of sight. These errors seemed to be due to the
final linear line-of-sight model that is used at pixel level.
An iterative correction step is performed to ensure the point is really
on the line-of-sight.
The residual error is now at nanometer level.
</action>
<action dev="luc" type="add">
Allow tolerance for intersections close to pixel edges.
</action>
<action dev="luc" type="update">
Use the four corners of each pixel to initialize min/max kd-tree.
</action>
<action dev="luc" type="update">
Use point and direction rather than two points for pixel intersection.
</action>
<action dev="luc" type="update">
Added a los conversion between Cartesian and geodetic coordinates.
The conversion is of course accurate only in the neighborhood of the
reference point, as a straight line in Cartesian is not a straight line
in geodetic coordinates. What is converted is the initial direction so
the two curves are tangent at the reference point.
Near Earth surface, the two curves remain within one millimeter of each
other after about 100 m travel.
</action>
<action dev="luc" type="fix">
First working version of Duvenhage algorithm!
</action>
<action dev="luc" type="fix">
Handle degenerate intersection cases.
The cases handled include linear cases (when Digital Elevation Model has
zero curvature) and constant cases (no curvature and line-of-sight
parallel to tile, both in or out-of-tile).
</action>
<action dev="luc" type="fix">
First working version of BasicScanAlgorithm.
The case where the line-of-sight enters the Digital Elevation Model in
one tile on top and exit it in another tile on bottom is not tested yet.
</action>
<action dev="luc" type="add">
Added tests for BasicScanAlgorithm.
</action>
<action dev="luc" type="update">
Don't exclude endpoints when un-merging tiles.
</action>
<action dev="luc" type="update">
Changed private method arguments order for easier understanding.
</action>
<action dev="luc" type="fix">
Fixed computation of sub-tiles crossings.
</action>
<action dev="luc" type="update">
Added library setup test, with and without Orekit.
</action>
<action dev="luc" type="add">
Prepared framework for more complete flight dynamics tests.
</action>
<action dev="luc" type="update">
Implemented intersection at pixel level.
</action>
<action dev="luc" type="update">
Delegate final pixel intersection to Tile.
</action>
<action dev="luc" type="fix">
Added a basic scan algorithm, for testing and validation purposes.
</action>
<action dev="luc" type="update">
Added line-of-sight splitting at sub-tiles boundaries.
</action>
<action dev="luc" type="update">
Added test for level 0 merging row and tall tile.
</action>
<action dev="luc" type="update">
Added methods getLatitudeAtIndex and getLongitudeAtIndex in Tile.
</action>
<action dev="luc" type="update">
Changed semantics of merge methods so they refer to current level.
</action>
<action dev="luc" type="update">
Renamed package dem into raster.
</action>
<action dev="luc" type="update">
Work In Progress on duvenhage algorithm.
</action>
<action dev="luc" type="update">
Added getMergingRow and getMergingColumn methods.
These methods are essential to identify where to split the line-of-sight
in the Duvenhage algorithm, when going from one level in the min/max
kd-tree to the next level.
</action>
<action dev="luc" type="update">
Added isColumnMerging predicate.
</action>
<action dev="luc" type="update">
Added a tolerance around tile for elevation interpolation.
Elevation is going to be interpolated at tiles entry and exit points,
which are computed from geodetic conversions. The result points may be
very slightly out of tiles, at numerical accuracy level. These points
should nevertheless be allowed to be interpolated using the closest
pixel data, so a tolerance was needed.
The SimpleTile class uses a fixed tolerance, arbitrarily set to 1/8
pixel.
</action>
<action dev="luc" type="fix">
Fixed interpolation error.
</action>
<action dev="luc" type="add">
started implementation of the Duvenhage algorithm.
</action>
<action dev="luc" type="update">
Added getLatitudeIndex and getLongitudeIndex in Tile.
</action>
<action dev="luc" type="fix">
Handle properly tiles boundaries.
Tiles are expected to have no inter-tile gap, i.e. the boundary row/columns are repeated in neighboring tiles.
</action>
<action dev="luc" type="update">
Improved identification of point location with respect to tile.
</action>
<action dev="luc" type="update">
Sensor directly uses points and vectors, and no more Line.
</action>
<action dev="luc" type="update">
Intersection algorithms can use the new ExtendedEllipsoid.
This allows them to chop off line-of-sight at DEM cells boundaries.
</action>
<action dev="luc" type="fix">
Fixed wrong package in tests.
</action>
<action dev="luc" type="add">
Added ExtendedEllipsoid to chop off line-of-sight according to DEM.
</action>
<action dev="luc" type="update">
Split top level class from DEM intersection algorithm.
</action>
<action dev="luc" type="update">
Line numbers are double.
</action>
<action dev="luc" type="add">
Started implementation of direct location ...
</action>
<action dev="luc" type="update">
Added a protection against unknown sensors.
</action>
<action dev="luc" type="add">
Added configuration for sensor lines of sight.
</action>
<action dev="luc" type="update">
Use an offset from a reference date for all computation.
</action>
<action dev="luc" type="update">
Added a getMergeLevel method to identify when pixels share min/max.
This is a first step towards duvenhage's algorithm.
</action>
<action dev="luc" type="fix">
Working version of min/max kd-tree tile.
</action>
<action dev="luc" type="add">
Started implementation of min/max KD-tree tile.
This is work in progress, the min/max computation seems wrong for now.
</action>
<action dev="luc" type="update">
pixels are double.
</action>
<action dev="luc" type="update">
Added protection against empty tiles.
</action>
<action dev="luc" type="update">
Removed AbastractTile.
Specialized tiles should directly extend SimpleTile.
</action>
<action dev="luc" type="add">
Added global min/max handling for any tile.
</action>
<action dev="luc" type="add">
Prepared first implementation for Duvenhage algorithm.
For now, only the (incomplete) API and classes hierarchy has been set
up. The tile is still a simple tile and does not yet creates the min/max
kd-tree. The algorithm doesn't do anything.
</action>
<action dev="luc" type="update">
Boilerplate part for Rugged interface implementation.
</action>
<action dev="luc" type="update">
Added API for global context initialization.
</action>
<action dev="luc" type="update">
Added containers for parsed position/velocity and attitude.
</action>
<action dev="luc" type="update">
Added a hook called after tile update completion.
</action>
<action dev="luc" type="update">
Force use of factory to create simple tiles.
</action>
<action dev="luc" type="update">
Extract an AbstractTile from SimpleTile
</action>
<action dev="luc" type="update">
Added a simple container for inverse location result.
</action>
<action dev="luc" type="update">
Expanded API.
</action>
<action dev="luc" type="update">
Use new specialized exceptions.
</action>
<action dev="luc" type="update">
Added error messages handling, with translation.
</action>
<action dev="luc" type="update">
Added design document and diagrams.
</action>
<action dev="luc" type="update">
Implemented TilesCache.
</action>
<action dev="luc" type="update">
Added factory for tiles.
The factory is to be implemented by the DEM intersection algorithm, at
very low level (typically tiles based on min/max kd-tree for Duvenhage
algorithm).
The tile updater on the other hand is the responsibility of the mission
specific interface.
</action>
<action dev="luc" type="update">
Added method to check ground point coverage.
</action>
<action dev="luc" type="update">
Reference latitude/longitude must be the minimum.
This ensures simple search for tiles given a ground point.
</action>
</release>
</body>
</document>
design/dem-loading-class-diagram.puml → src/design/dem-loading-class-diagram.puml
View file @ acf902ea
' Copyright 2013-2014 CS Systèmes d'Information ' Copyright 2013-2022 CS GROUP
' Licensed to CS Systèmes d'Information (CS) under one or more ' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with ' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership. ' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0 ' CS licenses this file to You under the Apache License, Version 2.0
...@@ -25,40 +25,53 @@ ...@@ -25,40 +25,53 @@
skinparam NoteFontColor #691616 skinparam NoteFontColor #691616
skinparam ClassFontSize 11 skinparam ClassFontSize 11
package fr.cs.rugged #ECEBD8 package org.orekit.rugged #ECEBD8 {
package api #DDEBD8 package raster #DDEBD8 {
interface UpdatableTile { interface UpdatableTile {
+setGeometry(φref, λref, δφ, δλ, rows, columns) +setGeometry(φ₀, λ₀, δφ, δλ, rows, columns)
+setElevation(i, j, h) +setElevation(i, j, h)
} }
interface TileUpdater { interface TileUpdater {
+updateTile(φ, λ, UpdatableTile) +updateTile(φ, λ, UpdatableTile)
} }
UpdatableTile <-- TileUpdater : updates TileUpdater --> UpdatableTile : updates
end package
package dem #DDEBD8
interface Tile
class SpecializedTile
interface "TileFactory<T extends Tile>" as TileFactory_T_ { interface "TileFactory<T extends Tile>" as TileFactory_T_ {
+T createTile() +T createTile()
} }
class "TilesCache<T extends Tile>" as TilesCache_T_ { class "TilesCache<T extends Tile>" as TilesCache_T_ {
+ T getTile(φ, λ) + T getTile(φ, λ)
} }
Tile --|> UpdatableTile interface Tile {
Tile <|-- SpecializedTile + double interpolateElevation(φ, λ)
SpecializedTile "*" <--o "1" TilesCache_T_ }
TileUpdater "1" <--o "1" TilesCache_T_ : triggers UpdatableTile <|.. Tile
TileFactory_T_ "1" <--o "1" TilesCache_T_ : triggers Tile <|-- SimpleTile
TileFactory_T_ --> SpecializedTile : creates TilesCache_T_ "1" o--> "*" Tile
end package TilesCache_T_ "1" o--> "1" TileUpdater : triggers
TilesCache_T_ "1" o--> "1" TileFactory_T_ : triggers
}
package intersection.duvenhage #DDEBD8 {
TileFactory_T_ <|-- MinMaxTreeTileFactory
SimpleTile <|-- MinMaxTreeTile
MinMaxTreeTileFactory -left-> MinMaxTreeTile : creates
note left
tile extended with Duvenhage
specific min/max kd-tree
end note
}
end package }
package specific.interface #ECEBD8 package mission.specific #C4D2C5 {
class MissionSpecificDEM #D5E0D5/E2EBE2
TileUpdater <|-- MissionSpecificDEM TileUpdater <|-- MissionSpecificDEM
end package note top #E2EBE2
user provides DEM loading
by implementing TileUpdater
end note
}
@enduml @enduml
src/design/direct-location-class-diagram.puml 0 → 100644
View file @ acf902ea
' Copyright 2013-2022 CS GROUP
' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0
' (the "License"); you may not use this file except in compliance with
' the License. You may obtain a copy of the License at
'
' http://www.apache.org/licenses/LICENSE-2.0
'
' Unless required by applicable law or agreed to in writing, software
' distributed under the License is distributed on an "AS IS" BASIS,
' WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
' See the License for the specific language governing permissions and
' limitations under the License.
@startuml
skinparam svek true
skinparam ClassBackgroundColor #F3EFEB/CCC9C5
skinparam ClassArrowColor #691616
skinparam ClassBorderColor #691616
skinparam NoteBackgroundColor #F3EFEB
skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616
skinparam ClassFontSize 11
package rugged #ECEBD8 {
package raster #DDEBD8 {
interface Tile {
+interpolateElevation(φ, λ)
+pixelIntersection(NormalizedGeodeticPoint, los, φ index, λ index)
}
}
package intersection #DDEBD8 {
interface IntersectionAlgorithm {
+intersection(ellipsoid, position, los)
+refineIntersection(ellipsoid, position, los, closeGuess)
}
Tile <-- IntersectionAlgorithm : evaluate DEM
}
package utils #DDEBD8 {
class ExtendedEllipsoid {
+pointAtLatitude(position, los, φ, closereference)
+pointAtLongitude(position, los, λ)
+pointAtAltitude(position, los, h)
+pointOnGround(position, los)
}
class SpacecraftToObservedBody
IntersectionAlgorithm --> ExtendedEllipsoid : compute grid points crossings
}
package api #DDEBD8 {
class Rugged {
+directLocation(sensorName, line)
}
IntersectionAlgorithm "1" <--o Rugged : delegate DEM intersection
ExtendedEllipsoid <-- Rugged : convert geodetic points
SpacecraftToObservedBody <-- Rugged : convert positions/directions
}
package linesensor #DDEBD8 {
class LineSensor
Rugged --> LineSensor : getLOS(date, pixel)
Rugged --> LineSensor : getDate(line)
}
}
package mission.specific #C4D2C5 {
class UserMain #D5E0D5/E2EBE2
UserMain --> Rugged
}
@enduml
design/direct-localization-sequence-diagram.puml → src/design/direct-location-sequence-diagram.puml
View file @ acf902ea
' Copyright 2013-2014 CS Systèmes d'Information ' Copyright 2013-2022 CS GROUP
' Licensed to CS Systèmes d'Information (CS) under one or more ' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with ' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership. ' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0 ' CS licenses this file to You under the Apache License, Version 2.0
...@@ -21,6 +21,7 @@ ...@@ -21,6 +21,7 @@
skinparam NoteBorderColor #691616 skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616 skinparam NoteFontColor #691616
skinparam SequenceActorBorderColor #6A584B skinparam SequenceActorBorderColor #6A584B
skinparam SequenceActorBackgroundColor #F3EFEB/CCC9C5
skinparam SequenceParticipantBackgroundColor #F3EFEB/CCC9C5 skinparam SequenceParticipantBackgroundColor #F3EFEB/CCC9C5
skinparam SequenceParticipantBorderColor #6A584B skinparam SequenceParticipantBorderColor #6A584B
skinparam SequenceLifeLineBackgroundColor #CCC9C5/F3EFEB skinparam SequenceLifeLineBackgroundColor #CCC9C5/F3EFEB
...@@ -31,40 +32,61 @@ ...@@ -31,40 +32,61 @@
hide footbox hide footbox
participant "Application" as A actor "UserMain" as A
participant "Interface" as I
participant "Rugged" as R participant "Rugged" as R
participant "Orekit" as O participant "LineSensor" as LS
participant "SpacecraftToObservedBody" as S
participant "ExtendedEllipsoid" as E
participant "IntersectionAlgorithm" as G
participant "Tile" as T
activate A activate A
A -> I : directLocalization(line) A -> R : directLocation(name, number)
activate I activate R
I -> R : directLocalization(line) R -> LS : apply time stamping model
R -> S : get transforms at line date
R -> R : loop over line pixels pₖ
activate R activate R
R -> R : apply time stamping model R -> R : fix aberration of light
R -> R : apply combined transform provider at date R -> E : approximate point on ground
R -> R : loop over line pixels pₖ R -> R : fix speed of light delay in transforms
activate R R -> G : intersection(ellipsoid, line-of-sight)
R -> O : convert(line-of-sight) activate G
activate O G -> E : grid points crossings
O --> R : line-of-sight in Earth frame G -> T : elevation(φₖ, λₖ)
deactivate O activate T
R -> O : intersection(ellipsoid, line-of-sight) T -> A : DEM callback
activate O A --> T : DEM raw data cell
O --> R : geodetic point T --> G : h(φₖ, λₖ)
deactivate O deactivate T
R -> R : DEM intersection G -> E : grid points crossings
activate R G -> T : elevation(φₖ, λₖ)
R -> I : DEM callback activate T
I --> R : DEM raw data cell T --> G : h(φₖ, λₖ)
R --> R : φₖ, λₖ, hₖ deactivate T
deactivate R G -> E : grid points crossings
R --> R : list(φₖ, λₖ, hₖ) G -> T : elevation(φₖ, λₖ)
deactivate R activate T
R --> I : list(φₖ, λₖ, hₖ) T --> G : h(φₖ, λₖ)
deactivate T
G -> T : pixel intersection(los)
activate T
T --> G : φₖ, λₖ, hₖ
deactivate T
G --> R : φₖ, λₖ, hₖ
deactivate G
R -> R : refine speed of light delay in transforms
R -> G : refine intersection(ellipsoid, line-of-sight)
activate G
G -> T : refine pixel intersection(los)
activate T
T --> G : φₖ, λₖ, hₖ
deactivate T
deactivate G
R --> R : array(φₖ, λₖ, hₖ)
deactivate R deactivate R
I --> A : list(φₖ, λₖ, hₖ) R --> A : array(φₖ, λₖ, hₖ)
deactivate I deactivate R
deactivate A deactivate A
@enduml @enduml
src/design/duvenhage-inner-recursion-activity-diagram.puml 0 → 100644
View file @ acf902ea
' Copyright 2013-2022 CS GROUP
' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0
' (the "License"); you may not use this file except in compliance with
' the License. You may obtain a copy of the License at
'
' http://www.apache.org/licenses/LICENSE-2.0
'
' Unless required by applicable law or agreed to in writing, software
' distributed under the License is distributed on an "AS IS" BASIS,
' WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
' See the License for the specific language governing permissions and
' limitations under the License.
@startuml
skinparam svek true
skinparam NoteBackgroundColor #F3EFEB
skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616
skinparam ActivityStartColor #6A584B
skinparam ActivityEndColor #6A584B
skinparam ActivityBarColor #6A584B
skinparam ActivityBorderColor #691616
skinparam ActivityBackgroundColor #F3EFEB/CCC9C5
skinparam ActivityArrowColor #691616
skinparam ActivityFontSize 11
start
if (recursion depth > 30?) then (yes)
: search failed;
stop
endif
if (compare start and end point) then (same pixel)
: intersection ⇦ pixel intersection, with bilinear model;
: return intersection;
note left
this is the nominal return,
at final recursion level
end note
stop
endif
:compute kd-tree deepest\nlevel sub-tile containing\nboth segment endpoints;
if (compare segment and sub-tile maximum elevation) then (fully above)
: return null;
note left
when the line-of-sight segment is fully above
Digital Elevation Model, we can safely reject
it and proceed immediately to next segment
end note
stop
endif
:previous ⇦ start;
: crossings ⇦ line-of-sight segment crossings of next level sub-tiles;
note right
crossings can be computed either
using flat body hypothesis
or taking curvature into account
end note
repeat
:intersection ⇦ recurse(previous, crossing);
if (intersection found?) then (yes)
: return intersection;
stop
endif
:previous ⇦ crossing;
repeat while (more crossings?)
:intersection ⇦ recurse(previous, end);
: return intersection;
stop
@enduml
design/initialization-sequence-diagram.puml → src/design/duvenhage-top-loop-activity-diagram.puml
View file @ acf902ea
' Copyright 2013-2014 CS Systèmes d'Information ' Copyright 2013-2022 CS GROUP
' Licensed to CS Systèmes d'Information (CS) under one or more ' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with ' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership. ' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0 ' CS licenses this file to You under the Apache License, Version 2.0
...@@ -20,51 +20,53 @@ ...@@ -20,51 +20,53 @@
skinparam NoteBackgroundColor #F3EFEB skinparam NoteBackgroundColor #F3EFEB
skinparam NoteBorderColor #691616 skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616 skinparam NoteFontColor #691616
skinparam SequenceActorBorderColor #6A584B skinparam ActivityStartColor #6A584B
skinparam SequenceParticipantBackgroundColor #F3EFEB/CCC9C5 skinparam ActivityEndColor #6A584B
skinparam SequenceParticipantBorderColor #6A584B skinparam ActivityBarColor #6A584B
skinparam SequenceLifeLineBackgroundColor #CCC9C5/F3EFEB skinparam ActivityBorderColor #691616
skinparam SequenceLifeLineBorderColor #6A584B skinparam ActivityBackgroundColor #F3EFEB/CCC9C5
skinparam SequenceArrowColor #6A584B skinparam ActivityArrowColor #691616
skinparam SequenceBorderColor #6A584B skinparam ActivityFontSize 11
skinparam SequenceFontSize 11
hide footbox start
: gp₀ ⇦ point at altitude 0;
participant "Application" as A : select tile containing gp₀;
participant "Interface" as I : current point ⇦ null;
participant "Rugged" as R : hmax ⇦ tile maximum elevation;
participant "Orekit" as O while (current point is null)
: current ⇦ point at altitude hmax;
activate A if (locate current point) then (in selected tile)
A -> I : init else (outside of selected tile)
activate I : select tile containing current point;
I -> I : loadModels : hmax ⇦ max(hmax, tile maximum elevation);
I -> R : initiliaze(sensors, ephemeris) : current point ⇦ null;
activate R endif
R -> R : unfoldOpticalPath(sensors) endwhile
activate R repeat
R -> O : composeTransforms : exit ⇦ line-of-sight exit point from tile;
activate O : intersection ⇦ Duvenhage(current, exit);
O --> R : sensors transforms if (intersection found?) then (yes)
deactivate O : return intersection;
deactivate R stop
R -> O : createPropagator(ephemeris) endif
activate O if (tile exit) then (bottom)
O --> R : interpolating propagator : searching ⇦ false;
deactivate O else (side)
R -> O : createTransformProvider(sensors transforms, propagator) : forward point ⇦ point slightly after exit point;
activate O : select tile containing forward point;
O --> R : combined TransformProvider with caching feature if (DEM traversed between\ncurrent and forward points?) then (yes)
deactivate O : return current point;
deactivate R note right
I -> R : registerLineTimeStampingModel extremely rare case!
activate R end note
deactivate R stop
I -> R : registerDEMCallback endif
activate R : current point ⇦ forward point;
deactivate R endif
deactivate I repeat while (searching ?)
deactivate A :search failed;
note left
this should never happen
end note
@enduml @enduml
src/design/initialization-class-diagram.puml 0 → 100644
View file @ acf902ea
' Copyright 2013-2022 CS GROUP
' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0
' (the "License"); you may not use this file except in compliance with
' the License. You may obtain a copy of the License at
'
' http://www.apache.org/licenses/LICENSE-2.0
'
' Unless required by applicable law or agreed to in writing, software
' distributed under the License is distributed on an "AS IS" BASIS,
' WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
' See the License for the specific language governing permissions and
' limitations under the License.
@startuml
skinparam svek true
skinparam ClassBackgroundColor #F3EFEB/CCC9C5
skinparam ClassArrowColor #691616
skinparam ClassBorderColor #691616
skinparam NoteBackgroundColor #F3EFEB
skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616
skinparam ClassFontSize 11
package orekit #ECEBD8 {
class OneAxisEllipsoid
class PVCoordinatesProvider
class Frame
class AttitudeProvider
}
package mission.specific #C4D2C5 {
class UserMain #D5E0D5/E2EBE2
note top #E2EBE2
user configures Rugged either by
selecting from a few predefined
choices or by directly building
Orekit objects
end note
class MissionSpecificDEM #D5E0D5/E2EBE2
MissionSpecificDEM <-left- UserMain : creates
}
package rugged #ECEBD8 {
package utils #DDEBD8 {
class ExtendedEllipsoid
class SpacecraftToObservedBody
OneAxisEllipsoid <|-- ExtendedEllipsoid
Frame "2" <--o SpacecraftToObservedBody
PVCoordinatesProvider "1" <--o SpacecraftToObservedBody
AttitudeProvider "1" <--o SpacecraftToObservedBody
}
package raster #DDEBD8 {
interface TileUpdater
}
package api #DDEBD8 {
class Rugged {
+setLightTimeCorrection(boolean)
+setAberrationOfLightCorrection(boolean)
+addLineSensor(lineSensor)
}
enum AlgorithmId {
+DUVENHAGE
+DUVENHAGE_FLAT_BODY
+BASIC_SCAN
+IGNORE_DEM
}
enum EllipsoidId {
+GRS80
+WGS84
+IERS96
+IERS2003
}
enum BodyRotatingFrameId {
+ITRF
+ITRF_EQUINOX
+GTOD
}
enum InertialFrameId {
+GCRF
+EME2000
+MOD
+TOD
+VEIS1950
}
ExtendedEllipsoid "1" <--o Rugged
SpacecraftToObservedBody "1" <--o Rugged
Rugged --> AlgorithmId
Rugged --> EllipsoidId
Rugged --> BodyRotatingFrameId
Rugged --> InertialFrameId
MissionSpecificDEM --|> TileUpdater
UserMain --> Rugged : configures
}
package linesensor #DDEBD8 {
class LineSensor
Rugged o--> "*" LineSensor
UserMain --> LineSensor : creates
}
}
@enduml
design/geometry-at-date-sequence-diagram.puml → src/design/initialization-sequence-diagram.puml
View file @ acf902ea
' Copyright 2013-2014 CS Systèmes d'Information ' Copyright 2013-2022 CS GROUP
' Licensed to CS Systèmes d'Information (CS) under one or more ' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with ' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership. ' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0 ' CS licenses this file to You under the Apache License, Version 2.0
...@@ -21,6 +21,7 @@ ...@@ -21,6 +21,7 @@
skinparam NoteBorderColor #691616 skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616 skinparam NoteFontColor #691616
skinparam SequenceActorBorderColor #6A584B skinparam SequenceActorBorderColor #6A584B
skinparam SequenceActorBackgroundColor #F3EFEB/CCC9C5
skinparam SequenceParticipantBackgroundColor #F3EFEB/CCC9C5 skinparam SequenceParticipantBackgroundColor #F3EFEB/CCC9C5
skinparam SequenceParticipantBorderColor #6A584B skinparam SequenceParticipantBorderColor #6A584B
skinparam SequenceLifeLineBackgroundColor #CCC9C5/F3EFEB skinparam SequenceLifeLineBackgroundColor #CCC9C5/F3EFEB
...@@ -31,27 +32,53 @@ ...@@ -31,27 +32,53 @@
hide footbox hide footbox
participant "Caller" as C actor "UserMain" as A
participant "MissionSpecificDEM" as B
participant "Rugged" as R participant "Rugged" as R
participant "ExtendedEllipsoid" as E
participant "SpacecraftToObservedBody" as S
participant "LineSensor" as LS
participant "Orekit" as O participant "Orekit" as O
activate C activate A
C -> R : compute geometry at date A -> A : loadModels
A -> B : create
activate B
deactivate B
A -> A : unfoldOpticalPath
activate A
deactivate A
A -> R : create(DEM, algorithm, frames, ellipsoid, ephemeris)
activate R activate R
R -> O : interpolate(date) R -> E : create
activate E
deactivate E
R -> O : createProviders(ephemeris)
activate O activate O
O --> R : orbite/attitude O --> R : position/velocity/atttitude providers
deactivate O deactivate O
R -> O : getTransform(date) R -> S : create
activate O activate S
O --> R : Earth to inertial transform deactivate S
deactivate O deactivate R
R -> O : compose transforms A -> LS : create
activate O activate LS
O --> R : spacecraft to Earth transform deactivate LS
deactivate O A -> R : addLineSensor
R --> C : spacecraft to Earth transform activate R
deactivate R
A -> LS : create
activate LS
deactivate LS
A -> R : addLineSensor
activate R
deactivate R
A -> LS : create
activate LS
deactivate LS
A -> R : addLineSensor
activate R
deactivate R deactivate R
deactivate C deactivate A
@enduml @enduml
design/inverse-localization-sequence-diagram.puml → src/design/inverse-location-sequence-diagram.puml
View file @ acf902ea
' Copyright 2013-2014 CS Systèmes d'Information ' Copyright 2013-2022 CS GROUP
' Licensed to CS Systèmes d'Information (CS) under one or more ' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with ' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership. ' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0 ' CS licenses this file to You under the Apache License, Version 2.0
...@@ -21,6 +21,7 @@ ...@@ -21,6 +21,7 @@
skinparam NoteBorderColor #691616 skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616 skinparam NoteFontColor #691616
skinparam SequenceActorBorderColor #6A584B skinparam SequenceActorBorderColor #6A584B
skinparam SequenceActorBackgroundColor #F3EFEB/CCC9C5
skinparam SequenceParticipantBackgroundColor #F3EFEB/CCC9C5 skinparam SequenceParticipantBackgroundColor #F3EFEB/CCC9C5
skinparam SequenceParticipantBorderColor #6A584B skinparam SequenceParticipantBorderColor #6A584B
skinparam SequenceLifeLineBackgroundColor #CCC9C5/F3EFEB skinparam SequenceLifeLineBackgroundColor #CCC9C5/F3EFEB
...@@ -31,57 +32,66 @@ ...@@ -31,57 +32,66 @@
hide footbox hide footbox
participant "Application" as A actor "UserMain" as A
participant "Interface" as I
participant "Rugged" as R participant "Rugged" as R
participant "Orekit" as O participant "SensorMeanPlaneCrossing" as P
participant "SensorPixelCrossing" as X
participant "SpacecraftToObservedBody" as S
participant "ExtendedEllipsoid" as E
participant "Transform" as T
participant "Math" as M participant "Math" as M
activate A activate A
A -> I : inverseLocalization(φ, λ) A -> R : inverseLocation
activate I activate R
I -> R : inverseLocalization(φ, λ) R -> P : getMeanPlaneFinder
activate R activate P
R -> R : elevation(φ, λ) P -> S : getTransform(each line)
activate R note left
R -> I : DEM callback transforms are computed
I --> R : DEM raw data cell only once and reused
R --> R : h(φ, λ) across successive inverse
deactivate R location calls
R -> O : convert(ellipsoid, φ, λ, h) end note
activate O activate S
O --> R : P(φ, λ, h) in Earth frame S -> T : create
deactivate O activate T
R -> R : createSwathOffset(P, interpolator) deactivate T
activate R deactivate S
R --> R : function f(t) deactivate P
deactivate R R -> E : transform(φ, λ, h)
R -> M : solve f(t₀) = 0 activate E
activate M E --> R : x, y, z
M --> R : evaluate f(t) deactivate E
activate R R -> P : findCrossing(ground target)
R -> R : apply combined transform provider at date activate P
R --> M : f(t) P -> T : interpolate
deactivate R activate T
M --> R : evaluate f(t) deactivate T
activate R note left
R -> R : apply combined transform provider at date algorithm converges
R --> M : f(t) in 2 or 3 iterations
deactivate R end note
M --> R : evaluate f(t) P -> T : interpolate
activate R activate T
R -> R : apply combined transform provider at date deactivate T
R --> M : f(t) P --> R : target direction at mean plane crossing\n(with time derivative)
deactivate R deactivate P
M --> R : t₀ R -> X : create(target direction at crossing time)
deactivate M activate X
R -> R : apply combined transform provider at date deactivate X
R -> R : apply inverse time stamping model R -> X : locatePixel
R -> R : locate pixel in line for solved geometry activate X
R --> I : pixel coordinates X -> M : solve f(x) = 0
deactivate R activate M
I --> A : pixel coordinates M --> X : x₀
deactivate I deactivate M
X --> R : coarse pixel crossing
deactivate X
R -> R : fix line, considering closest pixel position
R -> R : fix pixel
R --> A : accurate line/pixel
deactivate R
deactivate A deactivate A
@enduml @enduml
src/design/mayon-volcano.png 0 → 100644
View file @ acf902ea
src/design/mayon-volcano.png

92.5 KiB

src/design/parametric-los-class-diagram.puml 0 → 100644
View file @ acf902ea
' Copyright 2013-2022 CS GROUP
' Licensed to CS GROUP (CS) under one or more
' contributor license agreements. See the NOTICE file distributed with
' this work for additional information regarding copyright ownership.
' CS licenses this file to You under the Apache License, Version 2.0
' (the "License"); you may not use this file except in compliance with
' the License. You may obtain a copy of the License at
'
' http://www.apache.org/licenses/LICENSE-2.0
'
' Unless required by applicable law or agreed to in writing, software
' distributed under the License is distributed on an "AS IS" BASIS,
' WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
' See the License for the specific language governing permissions and
' limitations under the License.
@startuml
skinparam svek true
skinparam ClassBackgroundColor #F3EFEB/CCC9C5
skinparam ClassArrowColor #691616
skinparam ClassBorderColor #691616
skinparam NoteBackgroundColor #F3EFEB
skinparam NoteBorderColor #691616
skinparam NoteFontColor #691616
skinparam ClassFontSize 11
package org.orekit.rugged #ECEBD8 {
package utils #DDEBD8 {
interface ParametricModel {
+getNbEstimatedParameters()
+getEstimatedParameters(parameters, start, length)
+setEstimatedParameters(parameters, start, length)
}
enum ParameterType {
+FIXED
+ESTIMATED
}
}
package linesensor #DDEBD8 {
class LineSensor
}
package los #DDEBD8 {
interface TimeDependentLOS {
+getNbPixels()
+getLOS(index, date)
+getLOS(index, date, parameters)
}
interface LOSTransform {
+transformLOS(i, los, date)
}
interface TimeIndependentLOSTransform {
+transformLOS(i, los)
}
class LOSBuilder {
+LOSBuilder(List<Vector3D> rawLOS)
+LOSBuilder addTransform(TimeIndependentLOSTransform transform)
+LOSBuilder addTransform(LOSTransform transform)
+TimeDependentLOS build()
}
ParametricModel <|.. TimeDependentLOS
ParametricModel <|.. LOSTransform
ParametricModel <|.. TimeIndependentLOSTransform
PolynomialRotation --|> LOSTransform
ParameterType <--* PolynomialRotation
FixedRotation --|> TimeIndependentLOSTransform
ParameterType <--* FixedRotation
TimeDependentLOS <-- LOSBuilder : builds
TimeIndependentLOSTransform <-- LOSBuilder : combines
LOSTransform <-- LOSBuilder : combines
LineSensor "1" *--> TimeDependentLOS
}
}
package o.a.c.m.analysis.differentiation #C4D2C5 {
class DerivativeStructure #D5E0D5/E2EBE2 {
+getOrder()
+getValue()
+getPartialDerivatives(order1, order2, ...)
}
LOSTransform --> DerivativeStructure
TimeIndependentLOSTransform --> DerivativeStructure
}
@enduml
src/main/java/org/orekit/rugged/adjustment/AdjustmentContext.java 0 → 100644
View file @ acf902ea
/* Copyright 2013-2022 CS GROUP
* Licensed to CS GROUP (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.orekit.rugged.adjustment;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresOptimizer.Optimum;
import org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresProblem;
import org.orekit.rugged.adjustment.measurements.Observables;
import org.orekit.rugged.api.Rugged;
import org.orekit.rugged.errors.RuggedException;
import org.orekit.rugged.errors.RuggedMessages;
import org.orekit.rugged.linesensor.LineSensor;
/** Create adjustment context for viewing model refining.
* @author Lucie LabatAllee
* @author Jonathan Guinet
* @author Luc Maisonobe
* @author Guylaine Prat
* @since 2.0
*/
public class AdjustmentContext {
/** List of Rugged instances to optimize. */
private final Map<String, Rugged> viewingModel;
/** Set of measurements. */
private final Observables measurements;
/** Least square optimizer choice.*/
private OptimizerId optimizerID;
/** Build a new instance.
* The default optimizer is Gauss Newton with QR decomposition.
* @param viewingModel viewing model
* @param measurements control and tie points
*/
public AdjustmentContext(final Collection<Rugged> viewingModel, final Observables measurements) {
this.viewingModel = new HashMap<String, Rugged>();
for (final Rugged r : viewingModel) {
this.viewingModel.put(r.getName(), r);
}
this.measurements = measurements;
this.optimizerID = OptimizerId.GAUSS_NEWTON_QR;
}
/** Setter for optimizer algorithm.
* @param optimizerId the chosen algorithm
*/
public void setOptimizer(final OptimizerId optimizerId)
{
this.optimizerID = optimizerId;
}
/**
* Estimate the free parameters in viewing model to match specified sensor
* to ground mappings.
* <p>
* This method is typically used for calibration of on-board sensor
* parameters, like rotation angles polynomial coefficients.
* </p>
* <p>
* Before using this method, the {@link org.orekit.utils.ParameterDriver viewing model
* parameters} retrieved by calling the
* {@link LineSensor#getParametersDrivers() getParametersDrivers()} method
* on the desired sensors must be configured. The parameters that should be
* estimated must have their {@link org.orekit.utils.ParameterDriver#setSelected(boolean)
* selection status} set to {@code true} whereas the parameters that should
* retain their current value must have their
* {@link org.orekit.utils.ParameterDriver#setSelected(boolean) selection status} set to
* {@code false}. If needed, the {@link org.orekit.utils.ParameterDriver#setValue(double)
* value} of the estimated/selected parameters can also be changed before
* calling the method, as this value will serve as the initial value in the
* estimation process.
* </p>
* <p>
* The method solves a least-squares problem to minimize the residuals
* between test locations and the reference mappings by adjusting the
* selected viewing models parameters.
* </p>
* <p>
* The estimated parameters can be retrieved after the method completes by
* calling again the {@link LineSensor#getParametersDrivers()
* getParametersDrivers()} method on the desired sensors and checking the
* updated values of the parameters. In fact, as the values of the
* parameters are already updated by this method, if users want to use the
* updated values immediately to perform new direct/inverse locations, they
* can do so without looking at the parameters: the viewing models are
* already aware of the updated parameters.
* </p>
*
* @param ruggedNameList list of rugged to refine
* @param maxEvaluations maximum number of evaluations
* @param parametersConvergenceThreshold convergence threshold on normalized
* parameters (dimensionless, related to parameters scales)
* @return optimum of the least squares problem
*/
public Optimum estimateFreeParameters(final Collection<String> ruggedNameList, final int maxEvaluations,
final double parametersConvergenceThreshold) {
final List<Rugged> ruggedList = new ArrayList<>();
final List<LineSensor> selectedSensors = new ArrayList<>();
for (String ruggedName : ruggedNameList) {
final Rugged rugged = this.viewingModel.get(ruggedName);
if (rugged == null) {
throw new RuggedException(RuggedMessages.INVALID_RUGGED_NAME);
}
ruggedList.add(rugged);
selectedSensors.addAll(rugged.getLineSensors());
}
final LeastSquareAdjuster adjuster = new LeastSquareAdjuster(this.optimizerID);
LeastSquaresProblem theProblem = null;
// builder
switch (ruggedList.size()) {
case 1:
final Rugged rugged = ruggedList.get(0);
final GroundOptimizationProblemBuilder groundOptimizationProblem = new GroundOptimizationProblemBuilder(selectedSensors, measurements, rugged);
theProblem = groundOptimizationProblem.build(maxEvaluations, parametersConvergenceThreshold);
break;
case 2:
final InterSensorsOptimizationProblemBuilder interSensorsOptimizationProblem = new InterSensorsOptimizationProblemBuilder(selectedSensors, measurements, ruggedList);
theProblem = interSensorsOptimizationProblem.build(maxEvaluations, parametersConvergenceThreshold);
break;
default :
throw new RuggedException(RuggedMessages.UNSUPPORTED_REFINING_CONTEXT, ruggedList.size());
}
return adjuster.optimize(theProblem);
}
}
src/main/java/org/orekit/rugged/adjustment/GroundOptimizationProblemBuilder.java 0 → 100644
View file @ acf902ea
/* Copyright 2013-2022 CS GROUP
* Licensed to CS GROUP (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.orekit.rugged.adjustment;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.hipparchus.analysis.differentiation.Gradient;
import org.hipparchus.linear.Array2DRowRealMatrix;
import org.hipparchus.linear.ArrayRealVector;
import org.hipparchus.linear.RealMatrix;
import org.hipparchus.linear.RealVector;
import org.hipparchus.optim.ConvergenceChecker;
import org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresBuilder;
import org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresProblem;
import org.hipparchus.optim.nonlinear.vector.leastsquares.MultivariateJacobianFunction;
import org.hipparchus.optim.nonlinear.vector.leastsquares.ParameterValidator;
import org.hipparchus.util.FastMath;
import org.hipparchus.util.Pair;
import org.orekit.bodies.GeodeticPoint;
import org.orekit.rugged.adjustment.measurements.Observables;
import org.orekit.rugged.adjustment.measurements.SensorToGroundMapping;
import org.orekit.rugged.api.Rugged;
import org.orekit.rugged.errors.RuggedException;
import org.orekit.rugged.errors.RuggedMessages;
import org.orekit.rugged.linesensor.LineSensor;
import org.orekit.rugged.linesensor.SensorPixel;
import org.orekit.utils.ParameterDriver;
/** 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 {
/** Key for target. */
private static final String TARGET = "Target";
/** Key for weight. */
private static final String WEIGHT = "Weight";
/** Rugged instance to refine.*/
private final Rugged rugged;
/** Sensor to ground mapping to generate target tab for optimization.*/
private List<SensorToGroundMapping> sensorToGroundMappings;
/** Minimum line for inverse location estimation.*/
private int minLine;
/** Maximum line for inverse location estimation.*/
private int maxLine;
/** Target and weight (the solution of the optimization problem).*/
private HashMap<String, double[] > targetAndWeight;
/** 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
*/
public GroundOptimizationProblemBuilder(final List<LineSensor> sensors,
final Observables measurements, final Rugged rugged) {
super(sensors, measurements);
this.rugged = rugged;
this.initMapping();
}
/** {@inheritDoc} */
@Override
protected void initMapping() {
final String ruggedName = rugged.getName();
this.sensorToGroundMappings = new ArrayList<>();
for (final LineSensor lineSensor : this.getSensors()) {
final SensorToGroundMapping mapping = this.getMeasurements().getGroundMapping(ruggedName, lineSensor.getName());
if (mapping != null) {
this.sensorToGroundMappings.add(mapping);
}
}
}
/** {@inheritDoc} */
@Override
protected void createTargetAndWeight() {
int n = 0;
for (final SensorToGroundMapping reference : this.sensorToGroundMappings) {
n += reference.getMapping().size();
}
if (n == 0) {
throw new RuggedException(RuggedMessages.NO_REFERENCE_MAPPINGS);
}
final double[] target = new double[2 * n];
final double[] weight = new double[2 * n];
double min = Double.POSITIVE_INFINITY;
double max = Double.NEGATIVE_INFINITY;
int k = 0;
for (final SensorToGroundMapping reference : this.sensorToGroundMappings) {
for (final Map.Entry<SensorPixel, GeodeticPoint> mapping : reference.getMapping()) {
final SensorPixel sp = mapping.getKey();
weight[k] = 1.0;
target[k++] = sp.getLineNumber();
weight[k] = 1.0;
target[k++] = sp.getPixelNumber();
min = FastMath.min(min, sp.getLineNumber());
max = FastMath.max(max, sp.getLineNumber());
}
}
this.minLine = (int) FastMath.floor(min - ESTIMATION_LINE_RANGE_MARGIN);
this.maxLine = (int) FastMath.ceil(max - ESTIMATION_LINE_RANGE_MARGIN);
this.targetAndWeight = new HashMap<String, double[]>();
this.targetAndWeight.put(TARGET, target);
this.targetAndWeight.put(WEIGHT, weight);
}
/** {@inheritDoc} */
@Override
protected MultivariateJacobianFunction createFunction() {
// model function
final MultivariateJacobianFunction model = point -> {
// set the current parameters values
int i = 0;
for (final ParameterDriver driver : this.getDrivers()) {
driver.setNormalizedValue(point.getEntry(i++));
}
final double[] target = this.targetAndWeight.get(TARGET);
// compute inverse loc and its partial derivatives
final RealVector value = new ArrayRealVector(target.length);
final RealMatrix jacobian = new Array2DRowRealMatrix(target.length, this.getNbParams());
int l = 0;
for (final SensorToGroundMapping reference : this.sensorToGroundMappings) {
for (final Map.Entry<SensorPixel, GeodeticPoint> mapping : reference.getMapping()) {
final GeodeticPoint gp = mapping.getValue();
final Gradient[] ilResult = this.rugged.inverseLocationDerivatives(reference.getSensorName(), gp, minLine, maxLine, this.getGenerator());
if (ilResult == null) {
value.setEntry(l, minLine - 100.0); // arbitrary
// line far
// away
value.setEntry(l + 1, -100.0); // arbitrary
// pixel far away
} else {
// extract the value
value.setEntry(l, ilResult[0].getValue());
value.setEntry(l + 1, ilResult[1].getValue());
// extract the Jacobian
final int[] orders = new int[this.getNbParams()];
int m = 0;
for (final ParameterDriver driver : this.getDrivers()) {
final double scale = driver.getScale();
orders[m] = 1;
jacobian.setEntry(l, m,
ilResult[0]
.getPartialDerivative(orders) *
scale);
jacobian.setEntry(l + 1, m,
ilResult[1]
.getPartialDerivative(orders) *
scale);
orders[m] = 0;
m++;
}
}
l += 2;
}
}
// inverse loc result with Jacobian for all reference points
return new Pair<RealVector, RealMatrix>(value, jacobian);
};
return model;
}
/** Least square problem builder.
* @param maxEvaluations maxIterations and evaluations
* @param convergenceThreshold parameter convergence threshold
* @return the least square problem
*/
@Override
public final LeastSquaresProblem build(final int maxEvaluations, final double convergenceThreshold) {
this.createTargetAndWeight();
final double[] target = this.targetAndWeight.get(TARGET);
final double[] start = this.createStartTab();
final ParameterValidator validator = this.createParameterValidator();
final ConvergenceChecker<LeastSquaresProblem.Evaluation> checker = this.createChecker(convergenceThreshold);
final MultivariateJacobianFunction model = this.createFunction();
return new LeastSquaresBuilder()
.lazyEvaluation(false).maxIterations(maxEvaluations)
.maxEvaluations(maxEvaluations).weight(null).start(start)
.target(target).parameterValidator(validator).checker(checker)
.model(model).build();
}
}