User Manual 4.10 Celestial bodies - Historique des versions

Admin : /* Introduction */

2022-11-15T09:36:17Z

Introduction

← Version précédente		Version du 15 novembre 2022 à 09:36
Ligne 28 :		Ligne 28 :
	=== Useful Documents ===		=== Useful Documents ===
	None as of now.		None as of now.

			=== Package Overview ===
			None.

	== Features Description ==		== Features Description ==

Admin : /* Introduction */

2022-11-15T09:32:01Z

Introduction

← Version précédente		Version du 15 novembre 2022 à 09:32
Ligne 28 :		Ligne 28 :
	=== Useful Documents ===		=== Useful Documents ===
	None as of now.		None as of now.

	~~=== Package Overview ===~~
	~~[[File:bodiesorekit.JPG\|center]]~~
	~~This package overview is from the OREKIT website, under apache license.~~

	== Features Description ==		== Features Description ==

Admin : /* BodyShape and ExtendedOneAxisEllipsoid */

2022-11-15T08:38:46Z

BodyShape and ExtendedOneAxisEllipsoid

← Version précédente		Version du 15 novembre 2022 à 08:38
Ligne 435 :		Ligne 435 :
	</syntaxhighlight>		</syntaxhighlight>

	==== BodyShape and ~~ExtendedOneAxisEllipsoid~~ ====		==== BodyShape and OneAxisEllipsoid ====

	~~ExtendedOneAxisEllipsoid~~ implements the BodyShape interface.		OneAxisEllipsoid implements the EllipsoidBodyShape interface, which extends the BodyShape interface.
	See the [MIS_SENSORS_PatriusBodySpheroid specific page] for more details.		See the [MIS_SENSORS_PatriusBodySpheroid specific page] for more details.

Admin le 10 novembre 2022 à 10:40

2022-11-10T10:40:31Z

← Version précédente		Version du 10 novembre 2022 à 10:40
Ligne 435 :		Ligne 435 :
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~GeometricBodyShape~~ and ExtendedOneAxisEllipsoid ====		==== BodyShape and ExtendedOneAxisEllipsoid ====

	~~The GeometricBodyShape interface extends BodyShape for more complex computations.~~ ExtendedOneAxisEllipsoid implements it.		ExtendedOneAxisEllipsoid implements the BodyShape interface.
	See the [MIS_SENSORS_PatriusBodySpheroid specific page] for more details.		See the [MIS_SENSORS_PatriusBodySpheroid specific page] for more details.

Ligne 447 :		Ligne 447 :

	This class:		This class:
	* Inherits the <code>~~GeometricBodyShape~~</code> interface and hence can be used together with <code>EclipseDetector</code> and <code>SensorModel</code>.		* Inherits the <code>BodyShape</code> interface and hence can be used together with <code>EclipseDetector</code> and <code>SensorModel</code>.
	* Provides some useful and optimised methods for small body handling. Facets are connected to each other allowing some methods to be writen in a recursive or iterative way and hence being very fast. If <i>n</i> is the number of vertices of the body, fast recursive or iterative methods are in O(log(n)).		* Provides some useful and optimised methods for small body handling. Facets are connected to each other allowing some methods to be writen in a recursive or iterative way and hence being very fast. If <i>n</i> is the number of vertices of the body, fast recursive or iterative methods are in O(log(n)).

Admin : /* Classes */

2022-11-10T10:33:59Z

Classes

← Version précédente		Version du 10 novembre 2022 à 10:33
Ligne 582 :		Ligne 582 :
	\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/GeodeticPoint.html ...]		\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/GeodeticPoint.html ...]
	\|-		\|-
	\|'''~~JPLEphemeridesLoader~~'''		\|'''JPLCelestialBodyLoader'''
	\|Loader for JPL ephemerides binary files (DE 405, DE 406, ...).		\|Loader for JPL ephemerides binary files (DE 405, DE 406, ...).
	\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/~~JPLEphemeridesLoader~~.html ...]		\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/JPLCelestialBodyLoader.html ...]
	\|-		\|-
	\|'''OneAxisEllipsoid'''		\|'''OneAxisEllipsoid'''

Admin : /* Ephemeris Loader */

2022-11-10T10:33:43Z

Ephemeris Loader

← Version précédente		Version du 10 novembre 2022 à 10:33
Ligne 61 :		Ligne 61 :

	=== Ephemeris Loader ===		=== Ephemeris Loader ===
	For any celestial body of the Solar System, the actual computation of its position and velocity relies on the JPL planetary ephemerides files. These files are binary files and loaded thanks to the ~~JPLEphemeridesLoader~~ object.		For any celestial body of the Solar System, the actual computation of its position and velocity relies on the JPL planetary ephemerides files. These files are binary files and loaded thanks to the JPLCelestialBodyLoader object.

			Note that celestial bodies and associated ephemeris loaders are distinct: a class loads the ephemeris returning a <code>CelestialBodyEphemeris</code> while the other loads the whole <code>CelestialBody</code>.
			However, for sake of clarity, the main visible loaders are celestial body loaders.

	For the moment, this object is able to load JPL DE XXX files and IMCCE INPOP files which are the most commonly used data files (see below for an exact list of accepted files). For instance with the most common files, the JPL DE 405 covers the years 1600 to 2200 at maximum precision, the JPL DE 406 covers the years-3000 to +3000 at only slightly reduced precision. The DE 405 file is the basis for the Astronomical Almanac and leads to sufficiently accurate results and, for most purposes, even the accuracy of DE 406 is sufficient.		For the moment, this object is able to load JPL DE XXX files and IMCCE INPOP files which are the most commonly used data files (see below for an exact list of accepted files). For instance with the most common files, the JPL DE 405 covers the years 1600 to 2200 at maximum precision, the JPL DE 406 covers the years-3000 to +3000 at only slightly reduced precision. The DE 405 file is the basis for the Astronomical Almanac and leads to sufficiently accurate results and, for most purposes, even the accuracy of DE 406 is sufficient.

	==== ~~JPLEphemeridesLoader~~ ====		==== JPLCelestialBodyLoader ====

	In order to generate the ephemerides of one celestial body of the Solar System, one has to use the ~~JPLEphemeridesLoader~~ as follows :		In order to generate the ephemerides of one celestial body of the Solar System, one has to use the JPLCelestialBodyLoader as follows :

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	final ~~JPLEphemeridesLoader~~ loaderEMB = new ~~JPLEphemeridesLoader~~(fileName,		final JPLCelestialBodyLoader loaderEMB = new JPLCelestialBodyLoader(fileName,
	~~JPLEphemeridesLoader.~~EphemerisType.EARTH_MOON);		EphemerisType.EARTH_MOON);
	final ~~JPLEphemeridesLoader~~ loaderSSB = new ~~JPLEphemeridesLoader~~(fileName,		final JPLCelestialBodyLoader loaderSSB = new JPLCelestialBodyLoader(fileName,
	~~JPLEphemeridesLoader.~~EphemerisType.SOLAR_SYSTEM_BARYCENTER);		EphemerisType.SOLAR_SYSTEM_BARYCENTER);
	CelestialBodyFactory.addCelestialBodyLoader(CelestialBodyFactory.EARTH_MOON, loaderEMB);		CelestialBodyFactory.addCelestialBodyLoader(CelestialBodyFactory.EARTH_MOON, loaderEMB);
	CelestialBodyFactory.addCelestialBodyLoader(CelestialBodyFactory.SOLAR_SYSTEM_BARYCENTER, loaderSSB);		CelestialBodyFactory.addCelestialBodyLoader(CelestialBodyFactory.SOLAR_SYSTEM_BARYCENTER, loaderSSB);
Ligne 81 :		Ligne 84 :

	// Ephemeris of the Sun		// Ephemeris of the Sun
	~~JPLEphemeridesLoader loader~~ = new ~~JPLEphemeridesLoader~~("unxp2000.405",		JPLCelestialBodyLoaderloader = new JPLCelestialBodyLoader("unxp2000.405",
	~~JPLEphemeridesLoader.~~EphemerisType.SUN);		EphemerisType.SUN);

	// Creation of the Sun		// Creation of the Sun
Ligne 91 :		Ligne 94 :
	</syntaxhighlight>		</syntaxhighlight>

	When the user wants to create a ~~JPLEphemeridesLoader~~, first of all, he must supply the folder where the DE XXX files are stored. Then he has to give the name of the file which contains the data (DE XXX), the type of celestial body and a date (desired central date) as entries of the ~~JPLEphemeridesLoader~~.		When the user wants to create a JPLCelestialBodyLoader, first of all, he must supply the folder where the DE XXX files are stored. Then he has to give the name of the file which contains the data (DE XXX), the type of celestial body and a date (desired central date) as entries of the JPLCelestialBodyLoader.

	The first argument (name of the data file) may be <code>null</code>. In this case, Patrius takes the first compatible file found. If one wants only files from the DE 405 ephemerides, for instance, he has to give the String <code> "^unx[mp](\\d\\d\\d\\d)\\.(?:405)$"</code>. The last argument can also be <code>null</code>. If the central date is not mentionned an arbitrary 100 days range will be loaded whereas if it is mentionned all data within a +/-50 days range around this date will be loaded.		The first argument (name of the data file) may be <code>null</code>. In this case, Patrius takes the first compatible file found. If one wants only files from the DE 405 ephemerides, for instance, he has to give the String <code> "^unx[mp](\\d\\d\\d\\d)\\.(?:405)$"</code>. The last argument can also be <code>null</code>. If the central date is not mentionned an arbitrary 100 days range will be loaded whereas if it is mentionned all data within a +/-50 days range around this date will be loaded.

	Once the data is loaded, thanks to the ~~JPLEphemeridesLoader~~, the user can create the celestial body with the method loadCelestialBody() of the ~~JPLEphemeridesLoader class~~. To do so, the user has to be sure that all required data is loaded. Indeed, apart from the Moon, the Earth and the Earth-Moon barycenter, the creation of a celestial body requires some data on the Earth Moon barycenter and the Solar System barycenter in order to instanciate the frame in which the ephemerides of the celestial body will be defined. Therefore, the user has to create a ~~JPLEphemeridesLoader for~~ the Earth-Moon barycenter and the Solar System barycenter prior to creating the celestial body, otherwise Patrius will arbitrarily load a DE file to generate the corresponding ephemerides that are used afterwards for the generation of the frame. Then the user has to complete the list of the loaders of the CelestialBodyFactory with these two loaders before calling the method loadCelestialBody().		Once the data is loaded, thanks to the JPLCelestialBodyLoader, the user can create the celestial body with the method loadCelestialBody() of the JPLCelestialBodyLoaderclass. To do so, the user has to be sure that all required data is loaded. Indeed, apart from the Moon, the Earth and the Earth-Moon barycenter, the creation of a celestial body requires some data on the Earth Moon barycenter and the Solar System barycenter in order to instanciate the frame in which the ephemerides of the celestial body will be defined. Therefore, the user has to create a JPLCelestialBodyLoaderfor the Earth-Moon barycenter and the Solar System barycenter prior to creating the celestial body, otherwise Patrius will arbitrarily load a DE file to generate the corresponding ephemerides that are used afterwards for the generation of the frame. Then the user has to complete the list of the loaders of the CelestialBodyFactory with these two loaders before calling the method loadCelestialBody().

	NB : The user has to clean the CelestialBodyFactory memory if he does not want to work with the previously defined celestial bodies.		NB : The user has to clean the CelestialBodyFactory memory if he does not want to work with the previously defined celestial bodies.

Admin : /* Interfaces */

2022-11-10T10:29:13Z

Interfaces

← Version précédente		Version du 10 novembre 2022 à 10:29
Ligne 550 :		Ligne 550 :
	\|Interface for celestial body ephemeris like Sun, Moon or solar system planets.		\|Interface for celestial body ephemeris like Sun, Moon or solar system planets.
	\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/CelestialBodyEphemeris.html ...]		\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/CelestialBodyEphemeris.html ...]
			\|-
			\|'''CelestialBodyLoader'''
			\|Interface for celestial body loaders.
			\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/CelestialBodyLoader.html ...]
			\|-
			\|'''CelestialBodyEphemerisLoader'''
			\|Interface for celestial body ephemeris loaders.
			\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/CelestialBodyEphemerisLoader.html ...]
	\|-		\|-
	\|'''MeshLoader'''		\|'''MeshLoader'''

Admin : /* Interfaces */

2022-11-10T10:27:59Z

Interfaces

← Version précédente		Version du 10 novembre 2022 à 10:27
Ligne 546 :		Ligne 546 :
	\|Interface for celestial bodies like Sun, Moon or solar system planets.		\|Interface for celestial bodies like Sun, Moon or solar system planets.
	\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/CelestialBody.html ...]		\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/CelestialBody.html ...]
			\|-
			\|'''CelestialBodyEphemeris'''
			\|Interface for celestial body ephemeris like Sun, Moon or solar system planets.
			\|[{{JavaDoc4.10}}/fr/cnes/sirius/patrius/bodies/CelestialBodyEphemeris.html ...]
	\|-		\|-
	\|'''MeshLoader'''		\|'''MeshLoader'''

Admin : /* Available methods */

2022-11-10T10:22:59Z

Available methods

← Version précédente		Version du 10 novembre 2022 à 10:22
Ligne 465 :		Ligne 465 :
	* <code>getApparentRadius()</code> methods which provides the local radius from an object and an occulted body using an approximate iterative algorithm. This method is to be used only by <code>EclipseDetector</code>.		* <code>getApparentRadius()</code> methods which provides the local radius from an object and an occulted body using an approximate iterative algorithm. This method is to be used only by <code>EclipseDetector</code>.
	* <code>resize()</code> method which returns a resized body shape.		* <code>resize()</code> method which returns a resized body shape.
			* <code>closestPointTo()</code> method which returns the two closest points between the line given in input and the current facet body shape. One of the two points belongs to the line, the other to the facet body shape.
	* <code>distanceTo()</code> method which returns the distance to the body. This method is recursive and is hence in O(log(n)).		* <code>distanceTo()</code> method which returns the distance to the body. This method is recursive and is hence in O(log(n)).
	* <code>getNeighbors()</code> methods which returns the neighbors triangles to:		* <code>getNeighbors()</code> methods which returns the neighbors triangles to:

Admin : /* Available methods */

2022-11-10T09:55:15Z

Available methods

← Version précédente		Version du 10 novembre 2022 à 09:55
Ligne 458 :		Ligne 458 :
	===== Available methods =====		===== Available methods =====

	Noe that most methods return <b>exact</b> results. For example, <code>distanceTo</code> methods returns exact distance to mesh body. Only <code>transform()</code> and <code>~~getLocalRadius~~()</code> methods return a simplified result.		Noe that most methods return <b>exact</b> results. For example, <code>distanceTo</code> methods returns exact distance to mesh body. Only <code>transform()</code> and <code>getApparentRadius()</code> methods return a simplified result.

	<code>FacetBodyShape</code> provides the following methods:		<code>FacetBodyShape</code> provides the following methods:
	* <code>getIntersection(final Line line, final Vector3D close, final Frame frame, final AbsoluteDate date)</code> and similar which returns an <code>Intersection</code> object.This object contains the intersection point as well as the <code>Triangle</code> containing the intersection point. This method is recursive and is in O(log(n)).		* <code>getIntersection(final Line line, final Vector3D close, final Frame frame, final AbsoluteDate date)</code> and similar which returns an <code>Intersection</code> object.This object contains the intersection point as well as the <code>Triangle</code> containing the intersection point. This method is recursive and is in O(log(n)).
	* <code>transform()</code> methods which converts a point or a geodetic point using either <b>reference ellipsoid</b>, <b>outer ellipsoid</b> or <b>inner sphere</b>. Reference ellipsoid is the closest one axis ellipsoid to the body. Outer ellipsoid is the same ellipsoid but encompassing the entire body.		* <code>transform()</code> methods which converts a point or a geodetic point using either <b>reference ellipsoid</b>, <b>outer ellipsoid</b> or <b>inner sphere</b>. Reference ellipsoid is the closest one axis ellipsoid to the body. Outer ellipsoid is the same ellipsoid but encompassing the entire body.
	* <code>~~getLocalRadius~~()</code> methods which provides the local radius from an object and an occulted body using an approximate iterative algorithm. This method is to be used only by <code>EclipseDetector</code>.		* <code>getApparentRadius()</code> methods which provides the local radius from an object and an occulted body using an approximate iterative algorithm. This method is to be used only by <code>EclipseDetector</code>.
	* <code>resize()</code> method which returns a resized body shape.		* <code>resize()</code> method which returns a resized body shape.
	* <code>distanceTo()</code> method which returns the distance to the body. This method is recursive and is hence in O(log(n)).		* <code>distanceTo()</code> method which returns the distance to the body. This method is recursive and is hence in O(log(n)).

User Manual 4.10 Celestial bodies - Historique des versions

Admin : /* Introduction */

Admin : /* Introduction */

Admin : /* BodyShape and ExtendedOneAxisEllipsoid */

Admin le 10 novembre 2022 à 10:40

Admin : /* Classes */

Admin : /* Ephemeris Loader */

Admin : /* Interfaces */

Admin : /* Interfaces */

Admin : /* Available methods */

Admin : /* Available methods */

Admin : /* Introduction */

Admin : /* Introduction */

Admin : /* BodyShape and ExtendedOneAxisEllipsoid */

Admin : /* Classes */

Admin : /* Ephemeris Loader */

Admin : /* Interfaces */

Admin : /* Interfaces */

Admin : /* Available methods */

Admin : /* Available methods */