diff --git a/Readme.md b/Readme.md
index 2cfd802177fc712378410ce3cadfc02967a39be6..aef43f6f8b22991f85f671f8d8a3e8ce17dff415 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,3 +1,17 @@
+<!--- Copyright 2013-2018 CS Systèmes d'Information
+ Licensed 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.
+-->
+
<h1 style="color:blue;" align="center">
Rugged
</h1>
@@ -16,7 +30,7 @@
</p>
-Rugged is an add-on for [Orekit](https://www.orekit.org/) handling Digital Elevation Models contribution to
+Rugged is an add-on for [Orekit](https://www.orekit.org/ "Orekit homepage") handling Digital Elevation Models contribution to
line of sight computation. It is a free software intermediate-level library written in Java.
It mainly provides direct and inverse location, i.e. it allows to compute accurately
@@ -32,39 +46,4 @@ ground and sensor is computed with a viewing model taking into account:
Direct and inverse location can be used to perform full ortho-rectification of
images and correlation between sensors observing the same area.
-Homepage: [www.orekit.org/rugged/](https://www.orekit.org/rugged/)
-
-
-
-## Introduction
-* [Overview](src/site/markdown/index.md)
-* [Getting the sources](src/site/markdown/sources.md)
-* [Building](src/site/markdown/building.md)
-* [Configuration](src/site/markdown/configuration.md)
-* [FAQ](src/site/markdown/faq.md)
-* [License](LICENSE.txt)
-* [Downloads](src/site/markdown/downloads.md)
-* [`Changes`](src/site/xdoc/changes.xml)
-* [Contact](src/site/markdown/contact.md)
-
-## Design
-
-
-* [Overview](src/site/markdown/design/overview.md)
-* [Technical choices](src/site/markdown/design/technical-choices.md)
-* [Digital Elevation Model](src/site/markdown/design/digital-elevation-model.md)
-* [Design of major functions](src/site/markdown/design/design.md)
-
-## Tutorial
-
-* [Direct location (with Rugged initialization example)](src/site/markdown/tutorials/direct-location.md)
-* [Direct location with DEM](src/site/markdown/tutorials/direct-location-with-DEM.md)
-* [Inverse location](src/site/markdown/tutorials/inverse-location.md)
-* [Example in Matlab](src/site/markdown/tutorials/matlab-example.md)
-
-## Development
-
-* [Contributing](src/site/markdown/contributing.md)
-* [Guidelines](src/site/markdown/guidelines.md)
-* [`Javadoc, development`](https://www.orekit.org/site-rugged-development/apidocs/index.html)
-* [`SOCIS|Summer Of Code In Space (SOCIS)`]()
+Homepage: [www.orekit.org/rugged/](https://www.orekit.org/rugged/ "Rugged homepage")
diff --git a/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java b/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java
index d65c995551d00f80412c360945391751f422673d..efccaf1d10109b2be69586b17e50b8914dde8130 100644
--- a/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java
+++ b/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java
@@ -26,7 +26,7 @@ import org.orekit.rugged.linesensor.SensorPixel;
import org.orekit.rugged.utils.NormalizedGeodeticPoint;
/**
- * Interface for atmospheric refraction model.
+ * Base class for atmospheric refraction model.
* @author Sergio Esteves
* @author Guylaine Prat
* @since 2.0
diff --git a/src/site/markdown/building.md b/src/site/markdown/building.md
index c40c95eb2e5d34091cac46b9fbe540d122abef18..7004177f0f31d6abf9efa1ddd17dde821788eefd 100644
--- a/src/site/markdown/building.md
+++ b/src/site/markdown/building.md
@@ -12,6 +12,8 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Building Rugged
Rugged can be built from source using several different tools.
@@ -22,7 +24,7 @@ distributions provide these tools in their packages repositories.
## Building with Maven 3
-[Maven](http://maven.apache.org/) is a build tool that goes far beyond
+[Maven](http://maven.apache.org/ "Maven homepage") is a build tool that goes far beyond
simply compiling and packaging a product. It is also able to resolve
dependencies (including downloading the appropriate versions from the public
repositories), to run automated tests, to launch various checking tools and
@@ -55,14 +57,14 @@ with the following command:
mvn install
For other commands like generating the site, or generating the
-[checkstyle](http://checkstyle.sourceforge.net/),
-[spotbugs](https://spotbugs.github.io/) or
-[jacoco](http://www.eclemma.org/jacoco/) reports, see the maven
-plugins documentation at [maven site](http://maven.apache.org/plugins/index.html).
+[checkstyle](http://checkstyle.sourceforge.net/ "Checkstyle homepage"),
+[spotbugs](https://spotbugs.github.io/ "Spotbugs homepage") or
+[jacoco](http://www.eclemma.org/jacoco/ "Jacoco homepage") reports, see the maven
+plugins documentation at [maven site](http://maven.apache.org/plugins/index.html "Maven plugins homepage").
## Building with Eclipse
-[Eclipse](http://www.eclipse.org/) is a very rich Integrated Development
+[Eclipse](http://www.eclipse.org/ "Eclipse homepage") is a very rich Integrated Development
Environment (IDE). It is a huge product and not a simple build tool.
For systems not providing eclipse as a package, it can be downloaded from its
@@ -90,3 +92,5 @@ The simplest way to use Rugged with Eclipse is to follow these steps:
and Orekit (available at Orekit
[download page](https://www.orekit.org/download.html))
in the libraries tab of the Configure Build Path dialog
+
+[Top of the page](#top)
\ No newline at end of file
diff --git a/src/site/markdown/configuration.md b/src/site/markdown/configuration.md
index 232f475f14240a9f2295001b17ee86f0fbcee5b4..e3567f09fdbf8abb950b43f50cf5779e717711bc 100644
--- a/src/site/markdown/configuration.md
+++ b/src/site/markdown/configuration.md
@@ -12,30 +12,32 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Configuration
-As Rugged relied on Orekit for the frames computation, Orekit
+As Rugged relied on [Orekit](https://www.orekit.org/ "Orekit homepage") for the frames computation, Orekit
must be properly initialized for Rugged to run.
-The simplest way to configure is to first retrieve the example orekit-data.zip
-file from Orekit, available in the [Orekit project download page](https://www.orekit.org/download.html) (Physical Data)
-and to unzip it in a known fixed location on your computer (let's assume it is on
-your home folder, and it creates an orekit-data subfolder there).
-
-Then near the start of your main program, and before Orekit is called for the
-first time, you will add the following code snippet:
+The simplest way to configure is to first retrieve the example `orekit-data-master.zip`
+file from Rugged download page, available in the [Rugged project download page](https://www.orekit.org/rugged/download.html)
+(Get the physical data)
+and to unzip it anywhere you want, rename the `orekit-data-master` folder that will be created
+into `orekit-data` and add the following lines at the start of your program (before Orekit is called for the
+first time):
- File home = new File(System.getProperty("user.home"));
- File orekitData = new File(home, "orekit-data");
+ File orekitData = new File("/path/to/the/folder/orekit-data");
DataProvidersManager.getInstance().addProvider(new DirectoryCrawler(orekitData));
This is sufficient to start working.
-Note that some of the data in the orekit-data folder needs to be updated,
+Note that some of the data in the orekit-data-master folder needs to be updated,
typically the UTC-TAI.history file, which is updated about once every 18 months
by IERS, and the files in the Earth-Orientation-Parameters folder which are updated
regularly by IERS. The update frequency depends on which file you use.
-The data provided in the example archive from Orekit site are example only and are
+The data provided in the example archive from Rugged site are example only and are
not kept up to date. The real operational data are live, and remain under the
-responsibility of the user.
\ No newline at end of file
+responsibility of the user.
+
+[Top of the page](#top)
diff --git a/src/site/markdown/contact.md b/src/site/markdown/contact.md
index a1f090100feccecbb77c888a20cf3143cdf14b99..a321ab0e3a4e8cdd3fe2f1c5e9d7c15a9c6c280f 100644
--- a/src/site/markdown/contact.md
+++ b/src/site/markdown/contact.md
@@ -12,25 +12,24 @@
limitations under the License.
-->
-# Contacts
-
-## Mailing lists
+<a name="top"></a>
-Most discussions should occur on the public mailing lists.
+# Contacts
-| topic | post address | subscribe URL | archive URL |
-|---------------|------------------------------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
-| announces | orekit-announces@orekit.org | [https://www.orekit.org/wws/subscribe/orekit-announces](https://www.orekit.org/wws/subscribe/orekit-announces) | [https://www.orekit.org/wws/arc/orekit-announces](https://www.orekit.org/wws/arc/orekit-announces) |
-| users | rugged-users@orekit.org | [https://www.orekit.org/wws/subscribe/rugged-users](https://www.orekit.org/wws/subscribe/rugged-users) | [https://www.orekit.org/wws/arc/rugged-users](https://www.orekit.org/wws/arc/rugged-users) |
-| developers | rugged-developers@orekit.org | [https://www.orekit.org/wws/subscribe/rugged-developers](https://www.orekit.org/wws/subscribe/rugged-developers) | [https://www.orekit.org/wws/arc/rugged-developers](https://www.orekit.org/wws/arc/rugged-developers) |
+## Forum
-Please register to these mailing lists before attempting to post!
+Most discussions should occur on the public forums [https://forum.orekit.org/](https://forum.orekit.org/).
+The main categories are:
-We're preventing unregistered members from posting in order to prevent spam. Thank you.
+| category | URL |
+|---------------|----------------------------------------------------------------------------------------------------|
+| announces | [https://forum.orekit.org/c/rugged-announcements](https://forum.orekit.org/c/rugged-announcements) |
+| users | [https://forum.orekit.org/c/rugged-usage](https://forum.orekit.org/c/rugged-usage) |
+| developers | [https://forum.orekit.org/c/rugged-development](https://forum.orekit.org/c/rugged-development) |
## Technical contact
-If for some reason you cannot use the public lists, you can reach the CS
+If for some reason you cannot use the public forums, you can reach the CS
Systèmes d'Information Rugged team for any question (either technically
oriented or administrative) at the following email address:
[rugged@c-s.fr](mailto:rugged@c-s.fr)
@@ -49,3 +48,6 @@ please use the following address:
phone: +33 5-61-17-66-66 (ask for Luc Maisonobe or Sébastien Harasse)
fax: +33 5-61-34-84-15
+
+[Top of the page](#top)
+
\ No newline at end of file
diff --git a/src/site/markdown/contributing.md b/src/site/markdown/contributing.md
index 7983d10c8f042d98d9841bd826fd893330afb45e..d19d24f27c3118959ddf1d75399dea7027f6263e 100644
--- a/src/site/markdown/contributing.md
+++ b/src/site/markdown/contributing.md
@@ -1,4 +1,4 @@
-<!--- Copyright 2013-2017 CS Systèmes d'Information
+<!--- Copyright 2013-2019 CS Systèmes d'Information
Licensed 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
@@ -12,8 +12,7 @@
limitations under the License.
-->
-Contributing to Ruggged
-=======================
+# Contributing to Ruggged
Rugged is free software, which means you can use the source code as you wish,
without charges, in your applications, and that you can improve it and have
diff --git a/src/site/markdown/design/design.md b/src/site/markdown/design/design.md
index 36fc4ca4d8c75e3832342b93a80c3ff5ffbc0dd4..ecd5054112b07de5638f9665182138af14b5f8e3 100644
--- a/src/site/markdown/design/design.md
+++ b/src/site/markdown/design/design.md
@@ -12,6 +12,8 @@
limitations under the License.
-->
+<a name="top"></a>
+
## Design of the major functions
@@ -119,4 +121,6 @@ be reallocated by the Tile. The loader only sees interfaces in the API and doesn
tiles that are used under the hood. Different DEM intersection algorithms can use different tiles implementations without
any change to the mission specific interface. One example of this independence corresponds to the Duvenhage algorithm, has
in addition to the raw elevation grid, the tile will also contain a min/max kd-tree, so there are both a dedicated specialized
-tile and a corresponding TileFactory in use when this algorithm is run.
\ No newline at end of file
+tile and a corresponding TileFactory in use when this algorithm is run.
+
+[Top of the page](#top)
diff --git a/src/site/markdown/design/digital-elevation-model.md b/src/site/markdown/design/digital-elevation-model.md
index b79f08996850f69b0bcefd8090688d0a067d7f08..e5b0f566df9e5e49cbbe97e50a58cbfcdbb0266a 100644
--- a/src/site/markdown/design/digital-elevation-model.md
+++ b/src/site/markdown/design/digital-elevation-model.md
@@ -12,11 +12,13 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Digital Elevation Model
## DEM intersection
-The page [technical choices](./technical-choices.md) explain how Rugged goes from an on-board pixel
+The page [technical choices](./technical-choices.html) explain how Rugged goes from an on-board pixel
line-of-sight to a ground-based line-of-sight arrival in the vicinity of the ellipsoid entry point. At
this step, we have a 3D line defined near the surface and want to compute where it exactly traverses the
Digital Elevation Model surface. There is no support for this computation at Orekit library level,
@@ -55,3 +57,5 @@ On the other hand, Rugged is not expected to parsed DEM files, so the algorithm
layer. In order to pass these data, a specific callback function is implemented in the mission specific interface layer and
registered to Rugged, which can call it to retrieve parts of the DEM, in the form of small cells. The implicit KD-tree is then
built from leafs to root and cached.
+
+[Top of the page](#top)
diff --git a/src/site/markdown/design/overview.md b/src/site/markdown/design/overview.md
index c7f2320caf9d766d5bdb29e665339d75270fa9f0..9e82015733c2ad5668da1ba01bc1d603ad104226 100644
--- a/src/site/markdown/design/overview.md
+++ b/src/site/markdown/design/overview.md
@@ -12,16 +12,18 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Design Overview
## Global architecture
Rugged is an intermediate level mission-independent library. It relies on
-the Orekit library and on the Hipparchus library. It is itself
+the [Orekit](https://www.orekit.org/ "Orekit homepage") library and on the [Hipparchus](https://hipparchus.org/ "Hipparchus homepage") library. It is itself
intended to be used from a mission-specific interface by one or more
image processing applications.
-
+
The Java platform provides the runtime environment, the Hipparchus
library provides the mathematical algorithms (3D geometry, root
@@ -67,7 +69,10 @@ The following table sorts out the various topics between the various layers.
| IERS data correction | Orekit |All frame transforms support the full set of IERS Earth Orientation Parameters corrections, including of course the large DUT1 time correction, but also the smaller corrections to older IAU-76/80 or newer IAU-2000/2006 precession nutation models as well as the polar wander. The frames level accuracy is at sub-millimeter level
| Grid-post elevation model | Rugged |Only raster elevation models are supported
|Triangulated Irregular Network elevation model | Not supported |If vector elevation models are needed, they must be converted to raster form in order to be used
-| Geoid computation | Orekit |Rugged expects the Digital Elevation Models to be provided with respect to a reference ellipsoid. Orekit can be used to convert a geoid-based DEM to an ellipsoid-based DEM, directly from any gravity field
+| Geoid computation | Orekit |Rugged expects the Digital Elevation Models to be provided with respect to a reference ellipsoid. Orekit can be used to convert a geoid-based DEM to an ellipsoid-based DEM, directly from any gravity field
| Time-dependent deformations | Interface/Rugged |Simple line-of-sight models (typically polynomial) can be used
| Calibration |Image processing or interface|The calibration phase remains at the mission-specific caller level (pixels geometry, clock synchronization …), the caller is required to provide the already calibrated line of sights
| DEM file parsing | Interface |The elevation models are dedicated to the mission and there are several formats (DTED, GeoTIFF, raw data …).Rugged only deals with raw elevation on small latitude/longitude cells
+| Atmospheric refraction | Abstract/Rugged |Atmospheric refraction correction is supported with a default multi-layer model provided. Some other models can be provided by the user
+
+[Top of the page](#top)
diff --git a/src/site/markdown/design/technical-choices.md b/src/site/markdown/design/technical-choices.md
index d54090afead4ba845917c52be4bca814f903bd09..f1fa862626a041e0204782d406663be2828fb8b6 100644
--- a/src/site/markdown/design/technical-choices.md
+++ b/src/site/markdown/design/technical-choices.md
@@ -11,11 +11,14 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+
+<a name="top"></a>
+
# Technical choices
## Earth frames
-As Rugged is built on top of Orekit and Hipparchus, all the flight dynamics and
+As Rugged is built on top of [Orekit](https://www.orekit.org/ "Orekit homepage") and [Hipparchus](https://hipparchus.org/ "Hipparchus homepage"), all the flight dynamics and
mathematical computation are delegated to these two libraries and the full accuracy available
is used. This implies for example that when computing frames conversions between the inertial
frame and the Earth frame, the complete set of IERS Earth Orientation Parameters (EOP)
@@ -33,7 +36,7 @@ regular signal with several harmonics, which correspond to the nutation componen
not in this older model. This error was small in the 80's but is much higher now (as of 2014,
it is of the order of magnitude of 3 meters). The error is steadily increasing.
-
+
Note that this error occurs when the initial data for spacecraft position is initially given in
inertial frame and must be converted to Earth frame. This typically occurs in mission analysis
@@ -59,7 +62,7 @@ better than the former ones. The much better accuracy of these new models can be
kind of plot as before, i.e. ignoring temporarily the IERS corrections. The following figure shows the
result.
-
+
The remaining error is very small, of the order of magnitude of 2 or 3 centimeters. Rugged is not
limited to the legacy MOD and TOD frames and can use the newer IERS recommended frames as well. From
@@ -158,7 +161,7 @@ time than the position of the spacecraft. The expected difference can be predict
light travel time, it is about 1.2m at equator, in the East-West direction. This effect is compensated by applying the so-called
light-time correction.
-
+
The delay is computed for each pixel as the travel time is shorter for pixels looking in the nadir direction than for pixels
looking at the edge of field of view. As Orekit frame transforms automatically include a local Taylor expansion of the transform,
@@ -175,7 +178,7 @@ This effect is a large one and can correspond to up to a 20m shift once projecte
As shown in next figure, from spacecraft point of view, the light incoming from the ground point seems to come from a fictitious
point “ahead†of the real point.
-
+
As a side note, aberration of light and light time correction can be linked or considered to be two aspects of a similar phenomenon,
even in classical (non-relativistic) physics. It depends on the frame in which we look at the various elements. If the source is
@@ -208,7 +211,7 @@ computing only two points10 introduces yet another error, which is transverse to
at middle point. This assumption is a flat-body assumption, i.e. it correspond to locally approximating the ellipsoid to its tangential
plane. The error is the sagitta due to the bending of the real line-of-sight in the geodetic space.
-
+
This error depends on the diving angle of the line-of-sight with respect to local vertical. It is zero for a diving angle of 90 degrees
(i.e. a pure nadir line-of-sight) and increases as the diving angle decreases. It can reach tremendous values (hundreds of meters or
@@ -235,3 +238,5 @@ The following table summarizes the error compensations performed in the Rugged l
| aberration of light | 20m | along track |depends on spacecraft velocity, can be switched off if compensated elsewhere in the processing chain
| flat-body | 0.8m | across line-of-sight |error increases a lot for large fields of view, can be switched off, but this is not recommended
| atmospheric refraction | < 2m | horizontal shift |for multi-layer atmospheric model
+
+[Top of the page](#top)
diff --git a/src/site/markdown/downloads.md b/src/site/markdown/downloads.md
index ed611bd08bf3db87e66f94abe1b8600843205635..a72452d784958ed1af7ba3755b43fa3a24f722d7 100644
--- a/src/site/markdown/downloads.md
+++ b/src/site/markdown/downloads.md
@@ -1,10 +1,10 @@
-<!--- Copyright 2013-2018 CS Systèmes d'Information
+<!--- Copyright 2013-2019 CS Systèmes d'Information
Licensed 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.
@@ -12,12 +12,14 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Downloads
## Development Library version
The development version of the Rugged library is always available to
-download from our version control system. We use [ Git](http://git-scm.com/)
+download from our version control system. We use [Git](http://git-scm.com/ "Git homepage")
as our SCM. The anonymous read access to our Git repository allows users who
need the latest features and the latest bug fixes to get them even before an
official release.
@@ -27,9 +29,7 @@ be easily adapted if you are using one of the numerous Git graphical
user interface available or if Git is supported by you integrated
development environment:
- git clone https://gitlab.orekit.org/orekit/rugged.git
-
- :interrobang: EXPLANATIONS TO ADD about branches : master, develop, ... :interrobang:
+ git clone -b develop https://gitlab.orekit.org/orekit/rugged.git
## Released Library versions
@@ -61,36 +61,39 @@ version 1.0 downloads (release date: 2016-02-10)
## Data
-For convenience, a zip archive containing some configuration data is
-available for download. Similar files can be custom made by users with updated data.
-Configuring data loading is explained in the configuration page For a start, the simplest configuration
-is to download the orekit-data.zip file from the download page, to unzip it anywhere you want, note the
-path of the orekit-data folder that will be created and add the following lines at the start of
-your program:
+For convenience, a zip archive containing some configuration data is available
+for download. Similar files can be custom made by users with updated data.
+Configuring data loading is explained in the configuration page. For a start,
+the simplest configuration is to download the
+[orekit-data-master.zip](https://gitlab.orekit.org/orekit/orekit-data/-/archive/master/orekit-data-master.zip)
+file from the forge, to unzip it anywhere you want, rename the `orekit-data-master` folder that will be created
+into `orekit-data` and add the following lines at the start of your program:
File orekitData = new File("/path/to/the/folder/orekit-data");
DataProvidersManager manager = DataProvidersManager.getInstance();
manager.addProvider(new DirectoryCrawler(orekitData));
-This file contents is:
+This file contains the following data sets. Note that the data is updated only
+from time to time, so users must check by themselves they cover the time range
+needed for their computation.
- * leap seconds data up to end of 2017,
+ * leap seconds data,
- * IERS Earth orientation parameters from 1973 to end 2017
- with predicted date to mid 2018 for some parameters (both IAU-1980 and IAU-2000),
+ * IERS Earth orientation parameters from 1973 (both IAU-1980 and IAU-2000),
- * Marshall Solar Activity Futur Estimation from 1999 to end 2017,
+ * Marshall Solar Activity Future Estimation from 1999,
* DE 430 planetary ephemerides from 1990 to 2069,
- * Eigen 06S gravity field,
+ * Eigen 06S gravity field.
- * FES 2004 ocean tides model.
There are no guarantees that this file will be available indefinitely or that its
content will be updated. It should be considered as a simple configuration example.
Users are encouraged to set up their own configuration data.
+The file is available by following the
+[download](https://gitlab.orekit.org/orekit/orekit-data/-/archive/master/orekit-data-master.zip)
+link in the project dedicated to Orekit Data in the forge.
-The orekit-data.zip file is available in the [Orekit project download page](https://www.orekit.org/download.html) (Physical Data).
-
+[Top of the page](#top)
diff --git a/src/site/markdown/faq.md b/src/site/markdown/faq.md
index 4f744f824708f69d8a7d4a7ce446e519c0fee463..353c270e063906f46b0993a3713b4f1f621c767e 100644
--- a/src/site/markdown/faq.md
+++ b/src/site/markdown/faq.md
@@ -1,4 +1,4 @@
-<!--- Copyright 2013-2018 CS Systèmes d'Information
+<!--- Copyright 2013-2019 CS Systèmes d'Information
Licensed 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
@@ -11,15 +11,26 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-# FAQ
+
+<a name="top"></a>
+
+# Frequently Asked Questions (FAQ)
## References
### Has Rugged already been used?
-Yes. Rugged is used operationally in the Image Processing Facility
+Yes, it has been used in successful operational missions.
+
+Rugged is used operationally in the Image Processing Facility
of the Sentinel 2 ESA mission, which was launched in June 2015.
+Rugged is used in the frame of ESA Scientific Exploitation of Operational Missions (SEOM),
+to calculate topographic shadow masks for Sentinel 2 products.
+
+Rugged has been used as a Research Library by the French Space Agency (CNES) for
+study on refining for VHR push broom sensors (Pleiades).
+
### Is Rugged validated?
Yes, Rugged has been validated, by comparison with other image
@@ -43,8 +54,8 @@ TOD and MOD frames are available for consistency with existing systems).
### What are the dependencies for Rugged?
-Rugged relies on the Orekit space flight dynamics library and on
-Hipparchus mathematical libraries. Both libraries are free
+Rugged relies on the [Orekit](https://www.orekit.org/ "Orekit homepage") space flight dynamics library and on
+[Hipparchus](https://hipparchus.org/ "Hipparchus homepage") mathematical libraries. Both libraries are free
software libraries distributed under the terms of the Apache Software
License version 2.0.
@@ -52,26 +63,30 @@ License version 2.0.
### I get an error "no IERS UTC-TAI history data loaded" (or something similar in another language). What does it mean?
-This error is probably the most frequent one, or at least it's the first one new users encounter.
+This error is probably *the* most frequent one, or at least it's the first one new users encounter.
Rugged relies on the Orekit library to perform all space flight related computation (typically
frames transforms). This library in turn needs some external data to be loaded in order to run.
This includes UTC-TAI history for leap seconds handling, Earth Orientation Parameters for
-transforms to and from Earth fixed frames, or planetar ephemerides for Sun direction, for example.
+transforms to and from Earth fixed frames, or planetary ephemerides for Sun direction, for example.
The error message "no IERS UTC-TAI history data loaded" means the UTC-TAI history file which is used for leap
seconds management was not found. As leap seconds are used each time a UTC date is used, this message is
often seen very early and is the first one unsuspecting users experience. It often means the user forgot
-to configure Orekit to load data.
+to configure Orekit to load data. Orekit supports by default either the IERS UTC-TAI.history file or the
+USNO tai-utc.dat file. If either file is found in the Orekit configuration, it will be automatically loaded
+and the message should not appear.
-Configuring data loading is explained in the configuration page For a start, the simplest configuration
-is to download the orekit-data.zip file available in the [Orekit project download page](https://www.orekit.org/download.html) (Physical Data)., to unzip it anywhere you
-want, note the path of the orekit-data folder that will be created and add the following lines at the start
-of your program:
+Configuring data loading is explained in the configuration page. For a start, the simplest configuration
+ is to download the [orekit-data-master.zip](https://gitlab.orekit.org/orekit/orekit-data/-/archive/master/orekit-data-master.zip)
+file from the forge, to unzip it anywhere you want, rename the `orekit-data-master` folder that will be created
+into `orekit-data` and add the following lines at the start of your program:
File orekitData = new File("/path/to/the/folder/orekit-data");
DataProvidersManager manager = DataProvidersManager.getInstance();
manager.addProvider(new DirectoryCrawler(orekitData));
Using a folder allows one to change the data in it after the initial download, e.g., adding new EOP files as they
-are published by IERS.
+are published by IERS. Updating the content of the orekit-data remains the responsibility of the user.
+
+[Top of the page](#top)
diff --git a/src/site/markdown/guidelines.md b/src/site/markdown/guidelines.md
index f5e87394b88e530adf53a38d373c087f09731188..678b21819f4b3f1837e1a042c4aa3df193251c9d 100644
--- a/src/site/markdown/guidelines.md
+++ b/src/site/markdown/guidelines.md
@@ -2,15 +2,18 @@
Licensed 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.
-->
+
+<a name="top"></a>
+
# Development Guidelines
The following guidelines are used for Rugged development.
@@ -31,7 +34,7 @@ operations. The main driving goals are the following ones:
The first goal, validation, implies tests must be as extensive as possible.
They should include realistic operational cases but also contingency cases.
-The [jacoco](http://www.eclemma.org/jacoco/) tool must be used to
+The [jacoco](http://www.eclemma.org/jacoco/ "Jacoco homepage") tool must be used to
monitor test coverage. A very high level of coverage is desired. We do not
set up mandatory objective figures, but only guidelines here. However,a 60%
line coverage would clearly not be acceptable at all and 80% would be considered
@@ -41,7 +44,7 @@ The second goal, robustness, has some specific implications for a low level
component like Rugged. In some sense, it can be considered an extension of the
previous goal as it can also be improved by testing. It can also be improved
by automatic checking tools that analyze either source code or binary code. The
-[spotbugs](https://spotbugs.github.io/) tool is already configured for
+[spotbugs](https://spotbugs.github.io/ "Spotbugs homepage") tool is already configured for
automatic checks of the library using a maven plugin.
This is however not sufficient. A library is intended to be used by applications
@@ -83,15 +86,15 @@ Orbits, dates, vectors, and rotations are all immutable objects.
## Source Control Management
-The source code control management system used is [Git](http://git-scm.com/). The
-main Rugged repository is located at [https://gitlab.orekit.org/orekit/rugged](https://gitlab.orekit.org/orekit/rugged).
+The source code control management system used is [Git](http://git-scm.com/ "Git homepage"). The
+main Rugged repository is located at [https://gitlab.orekit.org/orekit/rugged.git](https://gitlab.orekit.org/orekit/rugged.git).
Starting after version 2.0, the branch management workflow is adapted from
both [git flow](http://nvie.com/posts/a-successful-git-branching-model/) and
-from the [Orfeo ToolBox Workflow](https://wiki.orfeo-toolbox.org/index.php/Git#Workflow).
-It is the same as chosen for [Orekit branch management workflow](https://gitlab.orekit.org/orekit/orekit/blob/master/src/site/markdown/guidelines.md).
+from the [Orfeo ToolBox Workflow](https://wiki.orfeo-toolbox.org/index.php/Git#Workflow "OTB workflow").
+It is the same as chosen for Orekit.
-
+
This implies that development occurs on a develop branch only.
Developers create feature branches, and merge them on the develop
@@ -134,8 +137,7 @@ release branches or bugfix branches branches to it.
For reading ease and consistency, the existing code style should be
preserved for all new developments. The rules are common ones, inherited
-mainly from the Sun :interrobang:[Code Conventions for the Java
-Programming Language](http://java.sun.com/docs/codeconv/) :interrobang: guide style and
+mainly from the Sun Code Conventions for the Java Programming Language guide style and
from the default [checkstyle](http://checkstyle.sourceforge.net/) tool
configuration. A few of these rules are displayed below. The complete
definition is given by the checkstyle configuration file in the project
@@ -144,55 +146,55 @@ root directory.
* *header rule*
all source files start with the Apache license header,
-
+
* *indentation rules*
no tabs, 4 spaces indentation, no indentation for case statements,
-
+
* *operators wrapping rules*
lines are wrapped after operators (unlike Sun),
-
+
* *whitespace rules*
operators are surrounded by spaces, method parameters open parenthesis
is not preceded by space, lines do not end with white space,
-
+
* *curly brace rules*
open curly brace are at end of line, with the matching closing curly brace
aligned with the start of the corresponding keyword (_if_, _for_,
_while_, _case_ or _do_),
-
+
* *encoding rules*
characters encoding is _UTF8_, the git property _core.autocrlf_ should be
set to _input_ on Linux development machines and to _true_ on Windows
development machines (to ensure proper conversion on all operating systems),
-
+
* *naming rules*
classes names begin with upper case, instance methods and fields
names begin with lower case, class fields are all upper case with
words separated by underscores,
-
+
* *ordering rules*
class variables come first, followed by instance variables, followed
by constructors, and followed by methods, public modifiers come first,
followed by protected modifiers followed by private modifiers,
-
+
* *javadoc rules*
all elements have complete javadoc, even private fields and methods
(there are some rare exceptions, in case of code translated from
the fortran language and models with huge parameters sets),
-
+
* *robustness rules*
switch/case construct have a default argument, even when all possible
cases are already handled, as many classes as possible are immutable,
-
+
* *miscellaneous rules*
_star_ imports are forbidden, parameters and local variables are final
@@ -230,3 +232,6 @@ root directory.
* *checkstyle* (style)
fix _all_ errors and warnings found by checkstyle
+
+[Top of the page](#top)
+
\ No newline at end of file
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index bf445fc177bcc424c69884eb79d34c15a662d7dc..32ac5cff92546830dc61e1b29bd23bb90f296194 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -12,13 +12,15 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Overview
- Rugged is a sensor-to-terrain mapping tool which takes into account Digital Elevation Models (DEM)
+ Rugged is a sensor-to-terrain mapping tool which takes into account Digital Elevation Models (DEM)
in its line of sight computation. It is a free software
- intermediate-level library written in Java and implemented as an add-on for Orekit.
+ intermediate-level library written in Java and implemented as an add-on for [Orekit](https://www.orekit.org/ "Orekit homepage").
- 
+ 
It mainly provides direct and inverse location, i.e. it allows
to compute accurately which ground point is looked at from a specific
@@ -29,7 +31,7 @@
on-board sensor pixels individual line-of-sights, spacecraft motion and
attitude and several physical effects.
-
+
*Effects of taking into account the DEM in the computation of latitude, longitude and altitude*
Direct and inverse location can be used to perform full ortho-rectification
@@ -41,13 +43,13 @@
* Refinement
- * can support several types of Digital Elevation Models, including user-provided models
+ * Can support several types of Digital Elevation Models, including user-provided models
- * several intersection models algorithms available
+ * Several intersection models algorithms available
- * can propagate orbit by itself for preliminary mission analysis or data generation
+ * Can propagate orbit by itself for preliminary mission analysis or data generation
- * can propagate attitude by itself for preliminary mission analysis or data generation
+ * Can propagate attitude by itself for preliminary mission analysis or data generation
* *very* fast
@@ -56,7 +58,7 @@
* Mathews, Herring, Buffett (2002)
* Capitaine (2006)
- * complete set of corrections applied for greater accuracy
+ * Complete set of corrections applied for greater accuracy
* δΔψ, δΔε on precession nutation (about 3m correction since 2013, steadily increasing)
* ΔUTâ‚, lod on proper rotation (can theoretically reach up to 400m)
* u, v pole wander (polhody), (about 15m correction)
@@ -66,9 +68,9 @@
(0m at nadir, 10m at 30° dive angle, hundreds of meters for skimming los)
* atmospheric refraction
- * not limited to Earth
+ * Not limited to Earth
- * highly portable (Linux, Windows, MacOSX, ...)
+ * Highly portable (Linux, Windows, MacOSX, ...)
* Localized in several languages
@@ -87,7 +89,7 @@
Rugged is freely available both in source and binary formats, with all related
documentation and tests.
-It is distributed under the [Apache License Version 2.0](LICENSE.txt). This
+It is distributed under the [Apache License Version 2.0](./license.html). This
is a well known business-friendly license. This means anybody can use it to build
any application, free or not. There are no strings attached to your own code.
@@ -96,9 +98,15 @@ interoperability in space systems.
## Maintained library
-Rugged has been in development since 2014 inside [CS Systèmes
-d'Information](http://www.c-s.fr/) and is still used and maintained by its dual teams
+Rugged has been in development since 2014 inside [CS Systèmes d'Information](http://www.c-s.fr/ "CS SI homepage")
+and is still used and maintained by its dual teams
of space dynamics and image processing experts.
Rugged is used for image processing of the Sentinel 2 mission at European Space
-Agency (ESA).
+Agency (ESA), as well as in the frame of ESA Scientific Exploitation of Operational Missions (SEOM),
+to calculate topographic shadow masks for Sentinel 2 products.
+
+Rugged has been also used as a Research Library by the French Space Agency (CNES) for
+study on refining for VHR push broom sensors (Pleiades).
+
+[Top of the page](#top)
\ No newline at end of file
diff --git a/src/site/markdown/sources.md b/src/site/markdown/sources.md
index 622d66c047190a586e2103c95a86f6b97c3ca523..fcc10ebc0ca8ab9ad88995011b5106786f8ea935 100644
--- a/src/site/markdown/sources.md
+++ b/src/site/markdown/sources.md
@@ -2,9 +2,9 @@
Licensed 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.
@@ -12,30 +12,44 @@
limitations under the License.
-->
-# Getting the sources
+<a name="top"></a>
+# Getting the sources
## Released versions
In order to get the source for officially released versions, go to the
-[Downloads page](src/site/markdown/downloads.md) and select one of the
-rugged-x.y-sources.zip files.
-The x.y part in the name specifies the version.
+[Release page](https://gitlab.orekit.org/orekit/rugged/tags) in Rugged
+forge and select one of the `rugged-x.y-sources.zip` files. The `x.y` part in the name
+specifies the version.
+
+If this is the first time you download the library and
+you have not yet set up your own data set with UTC-TAI history, JPL ephemerides,
+IERS Earth Orientation Parameters ... you may want to also download the
+`orekit-data.zip` file which is an example file suitable for a quick start (see
+[configuration](./configuration.html) for further reading about data configuration).
+
+It is also possible to retrieve published versions from the Git repository
+(see next section below), if retrieving either release-x.y branches or the
+master branch.
## Development version
-The development of the Rugged project is done using the [Git](http://git-scm.com/)
-source code control system. Rugged Git master repository is available online.
+The development of the Rugged project is done using the [Git](http://git-scm.com/ "Git homepage")
+source code control system. Rugged Git master repository is available online.
+The latest developments are in the develop branch. This is the one you want to retrieve
+if you need the latest feature before they are published in an official release.
+See [guidelines](./guidelines.html) for the branching workflow used in Rugged.
-You can browse it using the [Repository](https://gitlab.orekit.org/orekit/rugged)
+ * you can browse it using the [Repository](https://gitlab.orekit.org/orekit/rugged/tree/develop)
tab in Rugged Gitlab.
-`You can clone it anonymously with the command:`
+ * you can clone it anonymously with the command:
+
+ git clone -b develop https://gitlab.orekit.org/orekit/rugged.git
- git clone https://gitlab.orekit.org/orekit/rugged.git
+ * if you are a committer, you can clone it using your ssh credentials with the command:
-`If you are a committer, you can clone it using your ssh credentials with the command:`
+ git clone -b develop git@gitlab.orekit.org:orekit/rugged.git
- git clone git@gitlab.orekit.org:orekit/rugged.git
-
-:interrobang:`In both cases, the development version is under the branch develop TO BE COMPLETED`.:interrobang:
+[Top of the page](#top)
\ No newline at end of file
diff --git a/src/site/markdown/tutorials/direct-location-with-DEM.md b/src/site/markdown/tutorials/direct-location-with-DEM.md
index 04aceaae754226a960e8bc4ef66cb692210155d6..63f8e26a04303f1d742a479126ae1e73fbfef1c4 100644
--- a/src/site/markdown/tutorials/direct-location-with-DEM.md
+++ b/src/site/markdown/tutorials/direct-location-with-DEM.md
@@ -12,6 +12,8 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Direct Location with a DEM
The aim of this tutorial is to compute a direct location grid by intersection of
@@ -20,7 +22,7 @@ This algorithm is the most performant one in Rugged.
The following figure shows the effects of taking into account the DEM in the computation of latitude, longitude and altitude:
-
+
## Feeding Rugged with DEM tiles
@@ -44,18 +46,18 @@ In this tutorial, we will not include real DEM data. Instead we are going to cre
representing a volcano in a form of a perfect cone, similar to the Mayon volcano
in the Philippines, except that we will locate it somewhere just below our satellite.
This example is already part of Rugged tests cases, the source code is available
-in the package *org.orekit.rugged.raster*, file VolcanicConeElevationUpdater.java.
+in the package `org.orekit.rugged.raster`, file VolcanicConeElevationUpdater.java.
-The class *VolcanicConeElevationUpdater* implements the interface *TileUpdater* with its method *updateTile*.
+The class `VolcanicConeElevationUpdater` implements the interface `TileUpdater` with its method `updateTile`.
The method is in charge of loading a tile. The extent of the tile must be such that it covers
at least the ground point with coordinates (latitude, longitude) which are passed as arguments to the method.
-The tile is an object of type *UpdatableTile* which has two methods :
+The tile is an object of type `UpdatableTile` which has two methods :
-* *setGeometry(minLatitude, minLongitude, latitudeStep, longitudeStep, latitudeRows, longitudeRows)* : initializes the extent of the new tile before loading
+* `setGeometry(minLatitude, minLongitude, latitudeStep, longitudeStep, latitudeRows, longitudeRows)` : initializes the extent of the new tile before loading
-* *setElevation(latIdx, longIdx, elevation)* : fills the tile buffer at indices (latIdx, lonIdx) with value elevation
+* `setElevation(latIdx, longIdx, elevation)` : fills the tile buffer at indices (latIdx, lonIdx) with value elevation
-Here's the source code of the class *VolcanicConeElevationUpdater* :
+Here's the source code of the class `VolcanicConeElevationUpdater` :
import org.hipparchus.util.FastMath;
import org.orekit.rugged.raster.TileUpdater;
@@ -106,21 +108,21 @@ Here's the source code of the class *VolcanicConeElevationUpdater* :
### Important notes on DEM tiles :
-* Ground point elevation are obtained by bilinear interpolation between 4 neighbouring cells. There is no specific algorithm for border management. As a consequence, a point falling on the border of the tile is considered outside. **DEM tiles must be overlapping by at least one line/column in all directions**, :interrobang: in a similar way as for the SRTM DEMs. :interrobang:
+* Ground point elevation are obtained by bilinear interpolation between 4 neighbouring cells. There is no specific algorithm for border management. As a consequence, a point falling on the border of the tile is considered outside. **DEM tiles must be overlapping by at least one line/column in all directions**.
* In Rugged terminology, the minimum latitude and longitude correspond to the centre of the farthest Southwest cell of the DEM. Be careful if using GDAL to pass the correct information as there is half a pixel shift with respect to the lower left corner coordinates in gdalinfo.
The following diagram illustrates proper DEM tiling with one line/column overlaps between neighbouring tiles :
-
+
This diagram tries to represent the meaning of the different parameters in the definition of a tile :
-
+
## Initializing Rugged with a DEM
-The initialization step differs slightly from the first tutorial [Direct location](direct-location.md),
+The initialization step differs slightly from the first tutorial [Direct location](./direct-location.html),
as we need to pass the information about our TileUpdater.
Instantiate an object derived from TileUpdater :
@@ -146,7 +148,7 @@ Initialize Rugged with these parameters :
## Computing a direct location grid
-In a similar way as in the first tutorial [Direct Location](direct-location.md),
+In a similar way as in the first tutorial [Direct Location](./direct-location.html),
we call Rugged direct location method. This time it is called in a loop so as to generate a full grid on disk.
DataOutputStream dos = new DataOutputStream(new FileOutputStream("demDirectLoc.c1"));
@@ -189,4 +191,6 @@ we call Rugged direct location method. This time it is called in a loop so as to
}
## Source code
-The source code is available in [DirectLocationWithDEM.java](src/tutorials/java/fr/cs/examples/DirectLocationWithDEM.java) (package fr.cs.examples under src/tutorials)
+The source code is available in DirectLocationWithDEM.java (package fr.cs.examples under src/tutorials)
+
+[Top of the page](#top)
diff --git a/src/site/markdown/tutorials/direct-location.md b/src/site/markdown/tutorials/direct-location.md
index d350cf39402514efce0cf276c43e3952b8e2e091..9b87aa83d4895185c808b8e69ffc0520a4a51cda 100644
--- a/src/site/markdown/tutorials/direct-location.md
+++ b/src/site/markdown/tutorials/direct-location.md
@@ -12,6 +12,8 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Rugged initialization and direct location
This tutorial explains how to initialize Rugged and use it to geolocate a satellite image.
@@ -21,7 +23,7 @@ list of positions, velocities and attitude quaternions recorded during the acqui
passing all this information to Rugged, we will be able to precisely locate each point of
the image on the Earth. Well, not exactly precise, as this first tutorial does not use a
Digital Elevation Model, but considers the Earth as an ellipsoid. The DEM will be added in
-a second tutorial: [Direct location with a DEM](direct-location-with-DEM.md). The objective
+a second tutorial: [Direct location with a DEM](./direct-location-with-DEM.html). The objective
here is limited to explain how to initialize everything Rugged needs to know about the sensor
and the acquisition.
@@ -127,9 +129,9 @@ which frames we are using and convert if necessary.
Conversion from inertial to Earth-rotating frame is transparent to the user and is based on the most
recent precession/nutation model on top of which corrections published by the IERS are applied. IERS
-bulletins and other physical data are provided within the orekit-data folder. There are several ways
+bulletins and other physical data are provided within the orekit data folder. There are several ways
to configure Orekit to use this data. More information is given
-[here](https://gitlab.orekit.org/orekit/orekit/tree/master/src/site/markdown/configuration.md).
+[here](../configuration.html)
In our application, we simply need to know the name of the frames we are working with. Positions and
velocities are given in the ITRF terrestrial frame, while the quaternions are given in EME2000
@@ -164,7 +166,7 @@ where, for instance, gpsDateAsString is set to "2009-12-11T10:49:55.899994"
### Positions and velocities
-Similarly the positions and velocities will be set in a list of *TimeStampedPVCoordinates*. Before being
+Similarly the positions and velocities will be set in a list of `TimeStampedPVCoordinates`. Before being
added to the list, they must be transformed to EME2000:
import org.orekit.utils.TimeStampedPVCoordinates;
@@ -217,17 +219,17 @@ returns the builder instance, and therefore another setter can be called directl
The *setAlgorithm* setter specifies the intersection algorithm to use. As this tutorial is intended to be very
simple for a beginning, we choose to use directly the ellipsoid and not a real Digital Elevation Model,
-so we can use *AlgorithmId.IGNORE_DEM_USE_ELLIPSOID* as the single parameter of this setter.
+so we can use `AlgorithmId.IGNORE_DEM_USE_ELLIPSOID` as the single parameter of this setter.
The *setDigitalElevationModel* setter specifies the Digital Elevation Model. In fact, as we decided to ignore the Digital
Elevation Model in this tutorial, we could have omitted this call and it would have worked correctly.
We preferred to let it in so users do not forget to set the Digital Elevation Model for intersection
algorithms that really use them. As the model will be ignored, we can put the parameters for this
-setter to *null* and *0*. Of course if another algorithm had been chosen, null parameters would clearly
-not work, this is explained in another tutorial: [Direct location with a DEM](direct-location-with-DEM.md).
+setter to `null` and `0`. Of course if another algorithm had been chosen, null parameters would clearly
+not work, this is explained in another tutorial: [Direct location with a DEM](./direct-location-with-DEM.html).
The *setEllipsoid* setter defines the shape and orientation of the ellipsoid. We use simple predefined enumerates:
-*EllipsoidId.WGS84*, *InertialFrameId.EME2000*, but could also use a custom ellipsoid if needed.
+`EllipsoidId.WGS84`, `InertialFrameId.EME2000`, but could also use a custom ellipsoid if needed.
The *setTimeSpan* setter is used to define the global time span of the search algorithms (direct and inverse
location). Four parameters are used for this: acquisitionStartDate, acquisitionStopDate,
@@ -249,18 +251,18 @@ timeTolerance = 5 / lineSensor.getRate(0)).
The *setTrajectory* setter defines the spacecraft evolution. The arguments are the list of time-stamped positions and
velocities as well as the inertial frame with respect to which they are defined and options for interpolation:
number of points to use and type of filter for derivatives. The interpolation polynomials for nbPVPoints
-without any derivatives (case of *CartesianDerivativesFilter.USE_P*: only positions are used, without velocities)
+without any derivatives (case of `CartesianDerivativesFilter.USE_P`: only positions are used, without velocities)
have a degree nbPVPoints - 1. In case of computation with velocities included (case of
-*CartesianDerivativesFilter.USE_PV*), the interpolation polynomials have a degree 2*nbPVPoints - 1. If the
+`CartesianDerivativesFilter.USE_PV`), the interpolation polynomials have a degree 2*nbPVPoints - 1. If the
positions/velocities data are of good quality and separated by a few seconds, one may choose only a few points
but interpolate with both positions and velocities; in other cases, one may choose more points but interpolate
only with positions. We find similar arguments for the attitude quaternions.
-The last setter used, *addLineSensor*, registers a line sensor. As can be deduced from its prefix (*add* instead of *set*), it
+The last setter used, *addLineSensor*, registers a line sensor. As can be deduced from its prefix (`add` instead of `set`), it
can be called several time to register several sensors that will all be available in the built Rugged instance.
We have called the method only once here, so we will use only one sensor.
-After the last setter has been called, we call the *build()* method which really build the Rugged instance
+After the last setter has been called, we call the `build()` method which really build the Rugged instance
(and not a RuggedBuilder instance has the setter did).
Rugged takes into account by default some corrections for more accurate locations:
@@ -272,7 +274,7 @@ Not compensating the delay or the velocity composition are mainly useful for val
that do not compensate it. When the pixels line of sight already includes the aberration of light correction,
one must obviously deactivate the correction.
-If those corrections should be ignored, some other setters must be inserted before the call to *build()*:
+If those corrections should be ignored, some other setters must be inserted before the call to `build()`:
setXxxx().
setLightTimeCorrection(false).
@@ -280,9 +282,9 @@ If those corrections should be ignored, some other setters must be inserted befo
build();
The various setters can be called in any order. The only important thing is that once a Rugged instance
-has been created by calling the *build()* method, it is independent from the builder so later calls
+has been created by calling the `build()` method, it is independent from the builder so later calls
to setters will not change the build instance. In fact, it is possible to create a builder, then
-call its *build()* method to create a first Rugged instance, and then to modify the builder configuration
+call its `build()` method to create a first Rugged instance, and then to modify the builder configuration
by calling again some of the setters and building a second Rugged instance from the new configuration.
This allows to perform comparisons between two different configurations in the same program and without
having to recreate everything. For instance, one can procede in three steps like this:
@@ -320,4 +322,6 @@ Otherwise an ArrayIndexOutOfBoundsException will be thrown.
## Source code
-The source code is available in [DirectLocation.java](src/tutorials/java/fr/cs/examples/DirectLocation.java) (package fr.cs.examples under src/tutorials)
+The source code is available in DirectLocation.java (package fr.cs.examples under src/tutorials)
+
+[Top of the page](#top)
diff --git a/src/site/markdown/tutorials/inverse-location.md b/src/site/markdown/tutorials/inverse-location.md
index de6deca815b12b6dcb97ca343798aae0b211cd01..f4fa8dac7b08df913c49ea137d6261553be59984 100644
--- a/src/site/markdown/tutorials/inverse-location.md
+++ b/src/site/markdown/tutorials/inverse-location.md
@@ -12,6 +12,8 @@
limitations under the License.
-->
+<a name="top"></a>
+
# Inverse Location
The aim of this tutorial is to compute the inverse location of a point on Earth
@@ -21,7 +23,7 @@ We will also explain how to find the date at which sensor sees a ground point,
which is a kind of inverse location only focusing on date.
## Inverse location of a point on Earth
-The initialization of Rugged is similar as in the [Direct location](direct-location.md) tutorial up to rugged initialization..
+The initialization of Rugged is similar as in the [Direct location](./direct-location.html) tutorial up to rugged initialization..
### Point defined by its latitude, longitude and altitude
Once Rugged initialized, one can compute the line number and the pixel number of a point defined by its Geodetic coordinates:
@@ -82,4 +84,6 @@ then one can compute the inverse location:
SensorPixel sensorPixel = rugged.inverseLocation(sensorName, gp, minLineRough, maxLineRough);
## Source code
-The source code is available in [InverseLocation.java](src/tutorials/java/fr/cs/examples/InverseLocation.java) (package fr.cs.examples under src/tutorials)
+The source code is available in InverseLocation.java (package fr.cs.examples under src/tutorials)
+
+[Top of the page](#top)
diff --git a/src/site/markdown/tutorials/matlab-example.md b/src/site/markdown/tutorials/matlab-example.md
index 6171709007473043d3b29c410893e80704f2c04b..faec9b8e5d3875b1f3e8f881bdf9a9bb13d0b8b9 100644
--- a/src/site/markdown/tutorials/matlab-example.md
+++ b/src/site/markdown/tutorials/matlab-example.md
@@ -1,11 +1,25 @@
+<!--- Copyright 2013-2018 CS Systèmes d'Information
+ Licensed 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.
+-->
+
# Calling Rugged from Matlab
Examples of direct and inverse location were provided by the Centre de Techniques Spatiales of the Algerian Space Agency.
-If you have any question about the examples, please contact issam.boukerch@yahoo.fr, researcher at the CTS.
-
-* [Direct location](src/site/resources/sources/matlab-examples/DirectLocation.m)
-* [Inverse location](src/site/resources/sources/matlab-examples/InverseLocation.m)
-* [Function to parse a DIMAP file](src/site/resources/sources/matlab-examples/dim2rugged.m)
+Under `src/site/resources/sources/matlab-examples/` :
+
+ * Direct location: `DirectLocation.m`
+ * Inverse location: `InverseLocation.m`
+ * Function to parse a DIMAP file: `dim2rugged.m`
-Thank you Issam for your contribution!
\ No newline at end of file
+If you have any question about the examples, please contact issam.boukerch@yahoo.fr, researcher at the CTS.
diff --git a/src/site/resources/images/rugged-architecture.odg b/src/site/resources/images/rugged-architecture.odg
new file mode 100644
index 0000000000000000000000000000000000000000..e1449e7299ab529ff5854e316977a4ad006bb011
Binary files /dev/null and b/src/site/resources/images/rugged-architecture.odg differ
diff --git a/src/site/resources/images/rugged-architecture.png b/src/site/resources/images/rugged-architecture.png
index f947765ed55c9eeb71f1941d8edb27848c1651f3..d0304d24a51fe6806cba404af5f64a6380b9c14a 100644
Binary files a/src/site/resources/images/rugged-architecture.png and b/src/site/resources/images/rugged-architecture.png differ
diff --git a/src/site/site.xml b/src/site/site.xml
index 9b7f20f6acbd6744515a95cabc5d117373c2caa4..c21fdbcefff6104209df756e048f28038a367673 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
- Copyright 2013-2017 CS Systèmes d'Information
+ Copyright 2013-2019 CS Systèmes d'Information
Licensed 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
@@ -46,6 +46,7 @@
<item name="Direct location" href="/tutorials/direct-location.html" />
<item name="Direct location with DEM" href="/tutorials/direct-location-with-DEM.html" />
<item name="Inverse location" href="/tutorials/inverse-location.html" />
+ <item name="Matlab examples" href="/tutorials/matlab-example.html" />
</menu>
<menu name="Development">
<item name="Contributing" href="/contributing.html" />