fr.cnes.sirius.patrius.attitudes

Class RelativeTabulatedAttitudeLeg

java.lang.Object

fr.cnes.sirius.patrius.attitudes.RelativeTabulatedAttitudeLeg

All Implemented Interfaces:

AttitudeLeg, AttitudeProvider, TimeStamped, Leg, Serializable

public class RelativeTabulatedAttitudeLeg
extends Object
implements AttitudeLeg

This class implements the tabulated attitude leg relative to a reference date. WARNING : Double being less accurate than an AbsoluteDate, this class is less accurate than the TabulatedAttitude class.

Since:

3.1

Version:

$Id: RelativeTabulatedAttitudeLeg.java 17582 2017-05-10 12:58:16Z bignon $

Author:

galpint

See Also:

Serialized Form

Concurrency :

immutable

Field Summary

Fields inherited from interface fr.cnes.sirius.patrius.attitudes.AttitudeLeg

LEG_NATURE

Constructor Summary

Constructors

Constructor and Description
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, Frame frame, List<Pair<Double,AngularCoordinates>> angularCoordinates) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date. The rotation rates will be used for interpolation.
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, Frame frame, List<Pair<Double,AngularCoordinates>> angularCoordinates, String natureIn) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date. The rotation rates will be used for interpolation.
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, List<Pair<Double,AngularCoordinates>> angularCoordinates, int nbInterpolationPoints, Frame frame) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date and a number of points used for interpolation. The rotation rates will be used for interpolation.
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, List<Pair<Double,AngularCoordinates>> angularCoordinates, int nbInterpolationPoints, Frame frame, String natureIn) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date and a number of points used for interpolation. The rotation rates will be used for interpolation.
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, List<Pair<Double,Rotation>> orientations, Frame frame) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date. Rotations rates (set to 0's) will not be used for interpolation.
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, List<Pair<Double,Rotation>> orientations, Frame frame, int nbInterpolationPoints) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date and a number of points used for interpolation. The List of angular coordinates is built with rotations rates set to 0's and rotations rates (set to 0's) will not be used for interpolation.
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, List<Pair<Double,Rotation>> orientations, Frame frame, int nbInterpolationPoints, String natureIn) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date and a number of points used for interpolation. The List of angular coordinates is built with rotations rates set to 0's and rotations rates (set to 0's) will not be used for interpolation.
RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate, List<Pair<Double,Rotation>> orientations, Frame frame, String natureIn) Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date. Rotation rates (set to 0's) will not be used for interpolation.

Method Summary

Modifier and Type	Method and Description
RelativeTabulatedAttitudeLeg	copy(AbsoluteDateInterval newIntervalOfValidity) Creates a new leg from this one.
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Compute the attitude corresponding to an orbital state.
String	getNature() Returns the nature of the leg.
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the leg.
void	setSpinDerivativesComputation(boolean computeSpinDerivatives) Method to activate spin derivative computation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fr.cnes.sirius.patrius.attitudes.AttitudeLeg

computeSpinByFD, computeSpinDerivativeByFD

Methods inherited from interface fr.cnes.sirius.patrius.utils.legs.Leg

contains, getDate, getEnd, toPrettyString

Methods inherited from interface fr.cnes.sirius.patrius.attitudes.AttitudeProvider

getAttitude

Constructor Detail

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    List<Pair<Double,Rotation>> orientations,
                                    Frame frame)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date.
Rotations rates (set to 0's) will not be used for interpolation.

The number of points used for interpolation is the default one (defined in TabulatedAttitude).

Parameters:

referenceDate - reference date

orientations - rotations. WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

Throws:

PatriusException - if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    List<Pair<Double,Rotation>> orientations,
                                    Frame frame,
                                    int nbInterpolationPoints)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date and a number of points used for interpolation.
The List of angular coordinates is built with rotations rates set to 0's and rotations rates (set to 0's) will not be used for interpolation.

Parameters:

referenceDate - reference date

orientations - rotations. WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

nbInterpolationPoints - number of points used for interpolation

Throws:

PatriusException - if the number of points used for interpolation is < 1
if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    Frame frame,
                                    List<Pair<Double,AngularCoordinates>> angularCoordinates)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date.
The rotation rates will be used for interpolation.

The number of points used for interpolation is the default one (defined in TabulatedAttitude).

Parameters:

referenceDate - reference date

angularCoordinates - angular coordinates. WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

Throws:

PatriusException - if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    List<Pair<Double,AngularCoordinates>> angularCoordinates,
                                    int nbInterpolationPoints,
                                    Frame frame)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date and a number of points used for interpolation.
The rotation rates will be used for interpolation.

Parameters:

referenceDate - reference date

angularCoordinates - angular coordinates WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

nbInterpolationPoints - number of points used for interpolation

Throws:

PatriusException - if the number of points used for interpolation is < 1
if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    List<Pair<Double,Rotation>> orientations,
                                    Frame frame,
                                    String natureIn)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date.
Rotation rates (set to 0's) will not be used for interpolation.

The number of points used for interpolation is the default one (defined in TabulatedAttitude).

Parameters:

referenceDate - reference date

orientations - rotations. WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

natureIn - leg nature

Throws:

PatriusException - if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    List<Pair<Double,Rotation>> orientations,
                                    Frame frame,
                                    int nbInterpolationPoints,
                                    String natureIn)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of Rotations associated with a double representing the time elapsed since the reference date and a number of points used for interpolation.
The List of angular coordinates is built with rotations rates set to 0's and rotations rates (set to 0's) will not be used for interpolation.

Parameters:

referenceDate - reference date

orientations - rotations. WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

nbInterpolationPoints - number of points used for interpolation

natureIn - leg nature

Throws:

PatriusException - if the number of points used for interpolation is < 1
if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    Frame frame,
                                    List<Pair<Double,AngularCoordinates>> angularCoordinates,
                                    String natureIn)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date.
The rotation rates will be used for interpolation.

The number of points used for interpolation is the default one (defined in TabulatedAttitude).

Parameters:

referenceDate - reference date

angularCoordinates - angular coordinates. WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

natureIn - leg nature

Throws:

PatriusException - if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

RelativeTabulatedAttitudeLeg

public RelativeTabulatedAttitudeLeg(AbsoluteDate referenceDate,
                                    List<Pair<Double,AngularCoordinates>> angularCoordinates,
                                    int nbInterpolationPoints,
                                    Frame frame,
                                    String natureIn)
                             throws PatriusException

Build a RelativeTabulatedAttitudeLeg with a reference date, a list of angular coordinates associated with a double representing the time elapsed since the reference date and a number of points used for interpolation.
The rotation rates will be used for interpolation.

Parameters:

referenceDate - reference date

angularCoordinates - angular coordinates WARNING : these must be chronologically ordered.

frame - reference frame from which attitude is computed

nbInterpolationPoints - number of points used for interpolation

natureIn - leg nature

Throws:

PatriusException - if the number of points used for interpolation is < 1
if there is not enough data for Hermite interpolation
if the angular coordinates aren't in chronological order

Since:

3.1

Method Detail

getTimeInterval

public AbsoluteDateInterval getTimeInterval()

Returns the time interval of the leg.

Specified by:

getTimeInterval in interface Leg

Returns:

the time interval of the leg.

getAttitude

public Attitude getAttitude(PVCoordinatesProvider pvProv,
                            AbsoluteDate date,
                            Frame frame)
                     throws PatriusException

Compute the attitude corresponding to an orbital state.

Specified by:

getAttitude in interface AttitudeProvider

Parameters:

pvProv - local position-velocity provider around current date

date - current date

frame - reference frame from which attitude is computed

Returns:

attitude on the specified date and position-velocity state

Throws:

PatriusException - if attitude cannot be computed for provided date

setSpinDerivativesComputation

public void setSpinDerivativesComputation(boolean computeSpinDerivatives)

Method to activate spin derivative computation.

Specified by:

setSpinDerivativesComputation in interface AttitudeProvider

Parameters:

computeSpinDerivatives - true if spin derivatives should be computed

getNature

public String getNature()

Returns the nature of the leg.

Specified by:

getNature in interface Leg

Returns:

The “nature” of the leg.

copy

public RelativeTabulatedAttitudeLeg copy(AbsoluteDateInterval newIntervalOfValidity)

Creates a new leg from this one.

Specified by:

copy in interface AttitudeLeg

Specified by:

copy in interface Leg

Parameters:

newIntervalOfValidity - The time interval of the leg to create

Returns:

A new Leg valid on provided interval