From 052847d47e317299e111bf45f82b742bdd0c804a Mon Sep 17 00:00:00 2001 From: Luc Maisonobe <luc@orekit.org> Date: Tue, 10 Jun 2014 12:46:17 +0200 Subject: [PATCH] Fixed tables in markdown syntax. --- src/site/markdown/contact.md | 3 +- src/site/markdown/guidelines.md | 54 +++++++++++++++++---------------- src/site/markdown/index.md | 9 +++++- 3 files changed, 37 insertions(+), 29 deletions(-) diff --git a/src/site/markdown/contact.md b/src/site/markdown/contact.md index 06209bee..6e01fbd3 100644 --- a/src/site/markdown/contact.md +++ b/src/site/markdown/contact.md @@ -51,7 +51,6 @@ please use the following address: | BP 15872 | | 31506 Toulouse CEDEX 5 | | FRANCE | -|:---------------------------------------------------------------------| +| | | phone: +33 5-61-17-66-66 (ask for Luc Maisonobe or Aude Espesset) | | fax: +33 5-61-34-84-15 | -|:---------------------------------------------------------------------| diff --git a/src/site/markdown/guidelines.md b/src/site/markdown/guidelines.md index b1c879c3..c56fd4c2 100644 --- a/src/site/markdown/guidelines.md +++ b/src/site/markdown/guidelines.md @@ -84,8 +84,8 @@ difficult to catch bugs are caused by mutable objects that are changed in some d buried code and have an impact on user code that forgot to perform a defensive copy. Orbits, dates, vectors, and rotations are all immutable objects. -Style ------ +Style Rules +----------- For reading ease and consistency, the existing code style should be preserved for all new developments. The rules are common ones, inherited @@ -142,27 +142,29 @@ root directory. : _star_ imports are forbidden, parameters and local variables are final wherever possible. -Rules summary -------------- - -|---|-----------------|----------------------------------------------------------------------------------| -| 1 | validation | seek for a line test coverage of at least 80% (more is better) | -|---|-----------------|----------------------------------------------------------------------------------| -| 2 | robustness | fix _all_ errors and warnings found by findbugs | -|---|-----------------|----------------------------------------------------------------------------------| -| 3 | robustness | do not make assumptions on the runtime environment of applications using Rugged | -| | | (they may be embedded with no console, no possible user interaction, no network, | -| | | no writable file system, no stoppable main program, have memory constraints, | -| | | time constraints, be run in different linguistic contexts ...) | -|---|-----------------|----------------------------------------------------------------------------------| -| 4 | maintainability | follow Occam's razor principle | -| | | or its declination in computer science: KISS (Keep It Simple, Stupid) | -|---|-----------------|----------------------------------------------------------------------------------| -| 5 | efficiency | seek efficiency, but do not overstep robustness and maintainability | -|---|-----------------|----------------------------------------------------------------------------------| -| 6 | robustness | use immutable objects as much as possible | -| | maintainability | | -| | efficiency | | -|---|-----------------|----------------------------------------------------------------------------------| -| 7 | style | fix _all_ errors and warnings found by checkstyle | -|---|-----------------|----------------------------------------------------------------------------------| +Design Rules +------------ + +*coverage* (validation) +: seek for a line test coverage of at least 80% (more is better) + +*findbugs* (robustness) +: fix _all_ errors and warnings found by findbugs + +*no runtime assumptions* (robustness) +: do not make assumptions on the runtime environment of applications using Rugged + (they may be embedded with no console, no possible user interaction, no network, + no writable file system, no stoppable main program, have memory constraints, + time constraints, be run in different linguistic contexts ...) + +*simplicity* (maintainability) +: follow Occam's razor principle or its declination in computer science: KISS (Keep It Simple, Stupid) + +*balanced design* (efficiency) +: seek efficiency, but do not overstep robustness and maintainability + +*immutable objects* (robustness, maintainability) +: use immutable objects as much as possible + +*checkstyle* (style) +: fix _all_ errors and warnings found by checkstyle diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md index 3d8121af..24f79f53 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/index.md @@ -22,7 +22,14 @@ Overview It mainly provides direct and inverse localization, i.e. it allows to compute accurately which ground point is looked at from a specific pixel in a spacecraft instrument, and conversely which pixel will - see a specified ground point. + see a specified ground point. This mapping between ground and sensor + is computed with a viewing model taking into account ground Digital + Elevation Model, Earth rotation will all its tiny irregularities, + on-board sensor pixels individual line-of-sights, spacecraft motion and + attitude and several physical effects. + + Direct and inverse localization can be used to perform full ortho-rectification + of images and correlation between sensors observing the same area. Features -------- -- GitLab