Earth Observation Mission CFI Software
Usage Guide for Object Oriented Software
| Internal Code: | P/SUM/DMS/01/026-077 |
| Project code | EO-MA-DMS-GS-027 |
| Issue | 4.26 |
| Date | 31/10/23 |
| | Name | Function | Signature |
| Prepared by: | EOCFI Team | Project Engineers | |
| Checked by: | Inês Estrela | Project Manager | |
| Approved by: | Antonio Gutierrez | Division Head | |
DOCUMENT INFORMATION
| Contract Data | Classification |
| Contract Number: | 4000102614/1O/NL/FF/ef | Internal | |
| Public | |
| Contract Issuer: | ESA / ESTEC | Industry | X |
| Confidential | |
| External Distribution |
| Name | Organization | Copies |
| | | |
| Electronic handling |
| Document generator: | Doxygen 1.7.1 |
| Electronic file name: | eo-ma-dms-gs-0002-21 |
Document Status Log
| Issue | Change Description | Date | Approval |
| 1.0 | New document | 27/03/09 | |
| 4.1 | EOCFI 4.1 release | 07/05/10 | |
| 4.2 | EOCFI 4.2 release | 31/01/11 | |
| 4.3 | EOCFI 4.3 release | 06/02/12 | |
| 4.4 | EOCFI 4.4 release | 05/07/12 | |
| 4.5 | EOCFI 4.5 release | 01/03/13 | |
| 4.6 | EOCFI 4.6 release | 03/10/13 | |
| 4.7 | EOCFI 4.7 release | 28/03/14 | |
| 4.8 | EOCFI 4.8 release | 29/10/14 | |
| 4.9 | EOCFI 4.9 release | 23/04/15 | |
| 4.10 | EOCFI 4.10 release | 29/10/15 | |
| 4.11 | EOCFI 4.11 release | 15/04/16 | |
| 4.12 | EOCFI 4.12 release | 03/11/16 | |
| 4.13 | EOCFI 4.13 release | 05/04/17 | |
| 4.14 | EOCFI 4.14 release | 16/11/17 | |
| 4.15 | EOCFI 4.15 release | 20/04/18 | |
| 4.16 | EOCFI 4.16 release | 09/11/18 | |
| 4.17 | EOCFI 4.17 release | 10/05/19 | |
| 4.18 | EOCFI 4.18 release | 08/11/19 | |
| 4.19 | EOCFI 4.19 release | 29/05/20 | |
| 4.20 | EOCFI 4.20 release | 30/11/20 | |
| 4.21 | EOCFI 4.21 release | 23/06/21 | |
| 4.22 | EOCFI 4.22 release | 22/12/21 | |
| 4.23 | EOCFI 4.23 release | 23/06/22 | |
| 4.24 | EOCFI 4.24 release | 29/11/22 | |
| 4.25 | EOCFI 4.25 release | 10/05/23 | |
| 4.26 | EOCFI 4.26 release | 31/10/23 |
|
ACRONYMS, NOMENCLATURE AND TERMINOLOGY
Acronyms
| ANX | Ascending Node Crossing |
| CFI | Customer Furnished Item |
| CS | Coordinate System |
| DEM | Digital Elevation model |
| ESA | European Space Agency |
| ESTEC | European Space Technology and Research Centre |
| EOCFI | Earth Observation CFI software |
| OSF | Orbit Scenario File |
| OSV | Orbit State Vector |
| POF | Predicted Orbit File |
| RA | Right Ascension |
| ROF | Restituted Orbit File |
| SDF | Swath Definition File |
| STF | Swath Template File |
| SUM | Software User Manual |
Nomenclature
| CFI | A group of CFI classes, and related software and documentation that will be distributed by ESA to the users as an independent unit |
| CFI Class | A single class within a CFI that can be called by the user |
| Library | A software library containing all the CFI classes included within a CFI plus the supporting functions used by those CFI functions (transparently to the user) |
Notes in Terminology
In order to keep compatibility with legacy CFI libraries, the Earth Observation Mission CFI Software makes use of terms that are linked with missions already or soon in the operational phase like the Earth Explorers. This may be reflected in the rest of the document when examples of Mission CFI Software usage are proposed or description of Mission Files is given.
APPLICABLE AND REFERENCE DOCUMENTS
Reference Documents
| [MCD] | Earth Observation Mission CFI Software. Conventions Document. EO-MA-DMS-GS-0001. Issue 4.26 31/10/23. |
| [MSC] | Earth Observation Mission CFI Software. Mission Specific Customizations. EO-MA-DMS-GS-0018. Issue 4.26 31/10/23. |
| [GEN_SUM] | Earth Observation Mission CFI Software. General Software User Manual. EO-MA-DMS-GS-0017. Issue 4.26 31/10/23. |
| [EE_COMMON_SUM] | Earth Observation Mission CFI Software. EE Common Software User Manual. EO-MA-DMS-GS-0003. Issue 4.26 31/10/23. |
| [F_H_SUM] | Earth Observation Mission CFI Software. FileHandling Software User Manual. EO-MA-DMS-GS-0008. Issue 4.26 31/10/23. |
| [D_H_SUM] | Earth Observation Mission CFI Software. DataHandling Software User Manual. EO-MA-DMS-GS-0007. Issue 4.26 31/10/23. |
| [LIB_SUM] | Earth Observation Mission CFI Software. Lib Software User Manual. EO-MA-DMS-GS-0003. Issue 4.26 31/10/23. |
| [ORBIT_SUM] | Earth Observation Mission CFI Software. Orbit Software User Manual. EO-MA-DMS-GS-0004. Issue 4.26 31/10/23. |
| [POINT_SUM] | Earth Observation Mission CFI Software. Pointing Software User Manual. EO-MA-DMS-GS-0005. Issue 4.26 31/10/23. |
| [VISIB_SUM] | Earth Observation Mission CFI Software. Visibility Software User Manual. EO-MA-DMS-GS-0006. Issue 4.26 31/10/23. |
INTRODUCTION
The Earth Observation Mission CFI Software is a collection of software functions performing accurate computations of mission related parameters for Earth Observation missions. The functions are delivered as software libraries gathering functions that share similar functionalities:
-
EECommon: Classes to provide general functionalities and the error handling for the other libraries.
-
FileHandling: Software for reading and writing files in XML format.
-
DataHandling: Software for reading and writing Earth Observation Mission files.
-
Lib: Software for time transformations, coordinate transformations and other basic computations.
-
Orbit: Software for computing orbit information.
-
Pointing: Software for target calculations.
-
Visibility: Software for swath generation and visibility computation.
The purpose of the current document is to give a quick explanation of the CFI functionality and usage strategies. Information about the CFI from a software point of view (installation, libraries dependencies, hardware and software requirements...), consult [GEN_SUM]. To get a detailed information about the classes and interfaces, see other SUMs
EARTH OBSERVATION CFI SOFTWARE USAGE CASES
The usage cases of the CFI can be classified in the categories listed below. For every case there is a description of how to use the Earth Observation CFI (classes and methods to use, data flow, the calling sequence and examples). Besides the information provided in these sections, the Earth Observation CFI installation package contain a more detailed example program for each library (in JAVA or C++) that can be used for reference (see [GEN_SUM] for more info about the example program)
1.7.1