User Manual 4.2 Attitude leg : Différence entre versions
(→Generalities) |
(→Generalities: the Leg and the LegsSequence interfaces) |
||
(3 révisions intermédiaires par le même utilisateur non affichées) | |||
Ligne 33 : | Ligne 33 : | ||
== Features Description == | == Features Description == | ||
− | === Generalities === | + | === Generalities: the Leg and the LegsSequence interfaces === |
Attitude legs inherit the interface <code>AttitudeLeg</code>. | Attitude legs inherit the interface <code>AttitudeLeg</code>. | ||
In addition to <code>AttitudeProvider</code> services, they inherit the methods of the <code>Leg</code> interface which means they are time-bounded attitude providers. | In addition to <code>AttitudeProvider</code> services, they inherit the methods of the <code>Leg</code> interface which means they are time-bounded attitude providers. | ||
+ | |||
+ | The <code>Leg</code> interface is a generic interface for time-bounded data. It has only one method <code>getTimeInterval()</code>. This <code>Leg</code> interface allows to define an <code>AttitudeLeg</code>. | ||
+ | |||
+ | In order to define <code>AttitudeLegsSequence</code>, another generic interface is available: the <code>LegsSequence</code> interface. This interface defines a sequence of <code>Leg</code> and provides a method to get a leg given a date: <code>getLeg()</code>. | ||
+ | The <code>AbstractLegsSequence</code> class inherits the <code>LegsSequence</code> and has numerous methods to automatically handles the underlying Legs: add, remove, iterate over legs, etc. This class sorts the legs by lower end-point date and does not handle any overlapping issues. | ||
+ | |||
+ | '''Note:''' the <code>Leg</code>and <code>LegsSequence</code>interfaces are purely generic and therefore can be used for any other time-bounded data. | ||
=== Available attitude leg === | === Available attitude leg === | ||
Ligne 43 : | Ligne 50 : | ||
The attitude legs sequence is the equivalent of the [ATT_ALW_Home#HAttitudessequence Attitudes sequence], using attitude legs (<code>AttitudeLeg</code> instances) rather than attitude laws (<code>AttitudeLaw</code> instances). | The attitude legs sequence is the equivalent of the [ATT_ALW_Home#HAttitudessequence Attitudes sequence], using attitude legs (<code>AttitudeLeg</code> instances) rather than attitude laws (<code>AttitudeLaw</code> instances). | ||
The switching from one attitude leg to another is based on the time interval of validity of the two legs. | The switching from one attitude leg to another is based on the time interval of validity of the two legs. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==== TabulatedAttitude ==== | ==== TabulatedAttitude ==== | ||
Ligne 94 : | Ligne 93 : | ||
new RelativeTabulatedAttitudeLeg(refDate, frame, listAr); | new RelativeTabulatedAttitudeLeg(refDate, frame, listAr); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | |||
== Getting Started == | == Getting Started == | ||
Ligne 139 : | Ligne 137 : | ||
! scope="col"| Summary | ! scope="col"| Summary | ||
! scope="col"| Javadoc | ! scope="col"| Javadoc | ||
+ | |- | ||
+ | |'''Leg''' | ||
+ | |This interface is a generic interface for any king of time-bounded data. | ||
+ | |[{{JavaDoc4.2}}/fr/cnes/sirius/patrius/utils/legs/Leg.html ...] | ||
+ | |- | ||
+ | |'''LegsSequence''' | ||
+ | |This interface is a generic interface for any sequence of legs. | ||
+ | |[{{JavaDoc4.2}}/fr/cnes/sirius/patrius/utils/legs/LegsSequence.html ...] | ||
|- | |- | ||
|'''AttitudeLeg''' | |'''AttitudeLeg''' |
Version actuelle en date du 7 janvier 2019 à 14:39
Introduction
Scope
The purpose of this chapter is to describe the current Patrius attitude legs.
An attitude leg is a time-bounded attitude law. Generalities on attitude laws can be found [ATT_ALW_Home here].
Javadoc
Library | Javadoc |
---|---|
Patrius | Package fr.cnes.sirius.patrius.attitudes |
Patrius | Package fr.cnes.sirius.patrius.attitudes |
Links
Orekit attitudes : Orekit Attitudes architecture description
Useful Documents
None as of now.
Package Overview
The attitude leg AttitudeLeg
interface inherits the AttitudeProvider
interface.
Its place in the global Attitude design can be found [ATT_ALW_PkgOverview here].
It also inherits the general Leg
interface presented below.
Features Description
Generalities: the Leg and the LegsSequence interfaces
Attitude legs inherit the interface AttitudeLeg
.
In addition to AttitudeProvider
services, they inherit the methods of the Leg
interface which means they are time-bounded attitude providers.
The Leg
interface is a generic interface for time-bounded data. It has only one method getTimeInterval()
. This Leg
interface allows to define an AttitudeLeg
.
In order to define AttitudeLegsSequence
, another generic interface is available: the LegsSequence
interface. This interface defines a sequence of Leg
and provides a method to get a leg given a date: getLeg()
.
The AbstractLegsSequence
class inherits the LegsSequence
and has numerous methods to automatically handles the underlying Legs: add, remove, iterate over legs, etc. This class sorts the legs by lower end-point date and does not handle any overlapping issues.
Note: the Leg
and LegsSequence
interfaces are purely generic and therefore can be used for any other time-bounded data.
Available attitude leg
Attitude legs sequence
An attitude legs sequence is a container for several attitude legs, contiguous for their time intervals, in such a way that the attitude legs sequence can be processed like a single attitude leg by the propagator.
The attitude legs sequence is the equivalent of the [ATT_ALW_Home#HAttitudessequence Attitudes sequence], using attitude legs (AttitudeLeg
instances) rather than attitude laws (AttitudeLaw
instances).
The switching from one attitude leg to another is based on the time interval of validity of the two legs.
TabulatedAttitude
TabulatedAttitude
is an implementation of AttitudeLeg
. It represents a tabulated attitude leg.
In order to interpolate the attitude at a date, the user must specify a list of ordered attitudes, and can specify a number of points used by Hermite interpolation. If not specified, the number of points used by Hermite interpolation is set to a default number (currently 2).
final List<Attitude> attList = new ArrayList<Attitude>(); attList.add(attitude0); attList.add(attitude1); final int nbrInterpPoints = 2; final TabulatedAttitude attLeg = new TabulatedAttitude(attList, nbrInterpPoints);
It is possible to get the non-interpolated ordered attitudes :
final List<Attitude> attitudes = attLeg.getAttitudes();
Once the tabulated is defined, the computation can be performed on any orbital state using getAttitude()
method:
Attitude attitude = attLeg.getAttitude(orbit, date, FramesFactory.getEME2000());
RelativeTabulatedAttitudeLeg
RelativeTabulatedAttitudeLeg
is an implementation of AttitudeLeg
. An instance of RelativeTabulatedAttitudeLeg
can be created with a List<Pair<Double, Rotation>>
or with a List<Pair<Double, AngularCoordinates>>
. Each Rotation
(or AngularCoordinates
) is associated with a double
representing its time ellapsed in seconds since the reference date. Here is an example of a creation of an instance of RelativeTabulatedAttitudeLeg
:
// date and frame AbsoluteDate refDate = new AbsoluteDate(2008, 1, 1, TimeScalesFactory.getTAI()); Frame frame = FramesFactory.getGCRF(); double timeEllapsedSinceRefDate = 1.0; // List of AR List<Pair<Double, AngularCoordinates>> listAr = new ArrayList<Pair<Double, AngularCoordinates>>(); final AngularCoordinates ar = new AngularCoordinates( new Rotation(false, 0.48, 0.64, 0.36, 0.48), Vector3D.PLUS_I, Vector3D.PLUS_J); listAr.add(new Pair<Double, AngularCoordinates>(timeEllapsedSinceRefDate, ar)); // create RelativeTabulatedAttitudeLeg final RelativeTabulatedAttitudeLeg relativeTabulatedAttitudeLeg = new RelativeTabulatedAttitudeLeg(refDate, frame, listAr);
Getting Started
Building an attitude legs sequence
The attitude legs sequence was designed as a simple container, it performs only a few coherence checks on its inner attitude laws. Here's how an attitude sequence is built.
- An attitude legs sequence is created empty, associated to a single
PVCoordinatesProvider
instance.
- The sequence is mutable, attitude laws can be added to it one by one.
- Each attitude law is identified by a code.
- The sequence has a validity time interval, which is the grouping of the validity time intervals of all contained laws.
- The time interval of a newly added law must be contiguous to the grouped time interval of the already added laws. Otherwise an PatriusException is thrown.
- As soon as the sequence contains at least one law, methods of the
AttitudeLeg
interface can be called on the attitude sequence. The attitude sequence forwards the request to the appropriate attitude leg (according to the asking date), but replaces thePVCoordinatesProvider
attribute of the call with the innerPVCoordinatesProvider
instance.
AttitudeLawLeg and AttitudeLegsSequence : Code sample
final BodyCenterPointing earthCenterAttitudeLaw = new BodyCenterPointing(itrf); final AttitudeLeg law1 = new AttitudeLawLeg(earthCenterAttitudeLaw, date1, date2); final AttitudeLeg law2 = ... ; final AttitudeLeg law3 = ... ; PVCoordinatesProvider pvProvider = new CartesianOrbit(pvCoordinates, gcrf, date1, mu); final AttitudeLegsSequence sequence = new AttitudeLegsSequence(pvProvider); // After each add the sequence has to be contiguous, so the order may be important sequence.add("L1", law1); sequence.add("L2", law2); sequence.add("L3", law3); // Call to getAttitude on the sequence ignores otherPvProvider and uses pvProvider internally instead final Attitude sAttitude = sequence.getAttitude(otherPvProvider, date, itrf);
Contents
Interfaces
Interface | Summary | Javadoc |
---|---|---|
Leg | This interface is a generic interface for any king of time-bounded data. | ... |
LegsSequence | This interface is a generic interface for any sequence of legs. | ... |
AttitudeLeg | This interface extends the AttitudeProvider interface and adds the time interval of validity notion to the attitude laws. | ... |
Classes
Class | Summary | Javadoc |
---|---|---|
AttitudeLawLeg | Object representing an attitude law for spacecraft attitude field purposes. | ... |
TabulatedAttitude | Object representing a tabulated attitude leg : the attitude at a date is interpolated from a list of known ones. | ... |
AttitudeLegsSequence | Object representing a sequence of contiguous attitude legs. | ... |
RelativeTabulatedAttitudeLeg | This class implements a tabulated attitude leg with relative dates. | ... |