fr.cnes.sirius.patrius.attitudes

Class TabulatedAttitude

java.lang.Object

fr.cnes.sirius.patrius.attitudes.TabulatedAttitude

All Implemented Interfaces:

AttitudeLeg, AttitudeProvider, TimeStamped, Leg, Serializable

Direct Known Subclasses:

TabulatedSlew

public class TabulatedAttitude
extends Object
implements AttitudeLeg

This class implements the tabulated attitude leg.

Since:

1.1

Version:

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

Author:

Thomas Trapier

See Also:

AttitudeLeg, Serialized Form

Concurrency :

immutable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INTERP_ORDER Default number of points used for interpolation.

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

LEG_NATURE

Constructor Summary

Constructors

Constructor and Description
TabulatedAttitude(List<? extends Attitude> attitudesIn) Constructor with default number N of points used for interpolation.
TabulatedAttitude(List<? extends Attitude> attitudesIn, int nbInterpolationPoints) Constructor with number of points used for interpolation.
TabulatedAttitude(List<? extends Attitude> attitudesIn, int nbInterpolationPoints, boolean needOrdering, String natureIn) Constructor with number of points used for interpolation.
TabulatedAttitude(List<? extends Attitude> attitudesIn, int nbInterpolationPoints, String natureIn) Constructor with number of points used for interpolation.
TabulatedAttitude(List<? extends Attitude> attitudesIn, String natureIn) Constructor with default number N of points used for interpolation.

Method Summary

Modifier and Type	Method and Description
TabulatedAttitude	copy(AbsoluteDateInterval newIntervalOfValidity) Creates a new leg from this one.
protected AngularDerivativesFilter	getAngularDerivativeFilter() Getter for the angular derivative filter.
Attitude	getAttitude(AbsoluteDate date) Compute the attitude on the specified date in the reference frame.
Attitude	getAttitude(AbsoluteDate date, Frame frame) Compute the attitude on the specified date.
Attitude	getAttitude(PVCoordinatesProvider pvProvider, AbsoluteDate date, Frame frame) Compute the attitude corresponding to an orbital state.
List<Attitude>	getAttitudes() Getter for the non-interpolated and rightly ordered attitudes.
double[]	getDurations() Getter for the durations.
protected int	getInterpolationOrder() Getter for the interpolation order.
String	getNature() Returns the nature of the leg.
Frame	getReferenceFrame() Getter for the reference frame.
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the leg.
boolean	isSpinDerivativesComputation() Returns spin derivatives computation flag.
void	setAngularDerivativesFilter(AngularDerivativesFilter angularDerivativeFilter) Setter for the filter to use in interpolation.
void	setSpinDerivativesComputation(boolean computeSpinDerivatives) Method to activate spin derivative computation.
TabulatedAttitude	setTimeInterval(AbsoluteDateInterval interval) Return a new law with the specified interval.

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

Field Detail

DEFAULT_INTERP_ORDER

public static final int DEFAULT_INTERP_ORDER

Default number of points used for interpolation.

See Also:

Constant Field Values

Constructor Detail

TabulatedAttitude

public TabulatedAttitude(List<? extends Attitude> attitudesIn)
                  throws PatriusException

Constructor with default number N of points used for interpolation.

Parameters:

attitudesIn - the list of attitudes. WARNING : these attitudes must be ordered.

Throws:

PatriusException - if there is not enough data for Hermite interpolation
if all the attitudes aren't associated to the same reference frame
if the attitudes aren't in chronological order

TabulatedAttitude

public TabulatedAttitude(List<? extends Attitude> attitudesIn,
                         int nbInterpolationPoints)
                  throws PatriusException

Constructor with number of points used for interpolation.

Parameters:

attitudesIn - the list of attitudes. WARNING : these attitudes must be ordered.

nbInterpolationPoints - number of points used for interpolation
Note: the special value -1 is accepted to use the old Attitude.slerp constructor

Throws:

PatriusException - if the number of points used for interpolation is < 1 and != -1
if there is not enough data for Hermite interpolation
if all the attitudes aren't associated to the same reference frame
if the attitudes aren't in chronological order

TabulatedAttitude

public TabulatedAttitude(List<? extends Attitude> attitudesIn,
                         String natureIn)
                  throws PatriusException

Constructor with default number N of points used for interpolation.

Parameters:

attitudesIn - the list of attitudes. WARNING : these attitudes must be ordered.

natureIn - leg nature

Throws:

PatriusException - if there is not enough data for Hermite interpolation
if all the attitudes aren't associated to the same reference frame
if the attitudes aren't in chronological order

TabulatedAttitude

public TabulatedAttitude(List<? extends Attitude> attitudesIn,
                         int nbInterpolationPoints,
                         String natureIn)
                  throws PatriusException

Constructor with number of points used for interpolation.

Parameters:

attitudesIn - the list of attitudes. WARNING : these attitudes must be ordered.

nbInterpolationPoints - number of points used for interpolation
Note: the special value -1 is accepted to use the old Attitude.slerp constructor

natureIn - leg nature

Throws:

PatriusException - if the number of points used for interpolation is < 1 and != -1
if there is not enough data for Hermite interpolation
if all the attitudes aren't associated to the same reference frame
if the attitudes aren't in chronological order

TabulatedAttitude

public TabulatedAttitude(List<? extends Attitude> attitudesIn,
                         int nbInterpolationPoints,
                         boolean needOrdering,
                         String natureIn)
                  throws PatriusException

Constructor with number of points used for interpolation.

Parameters:

attitudesIn - the list of attitudes

nbInterpolationPoints - number of points used for interpolation
Note: the special value -1 is accepted to use the old Attitude.slerp constructor

needOrdering - true if ordering is required (otherwise the attitudes must be ordered)

natureIn - leg nature

Throws:

PatriusException - if the number of points used for interpolation is < 1 and != -1
if there is not enough data for Hermite interpolation
if all the attitudes aren't associated to the same reference frame
if the attitudes shouldn't be ordered (needOrdering = false) but their aren't in chronological order

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 pvProvider,
                            AbsoluteDate date,
                            Frame frame)
                     throws PatriusException

Compute the attitude corresponding to an orbital state.

Specified by:

getAttitude in interface AttitudeProvider

Parameters:

pvProvider - 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

getAttitude

public Attitude getAttitude(AbsoluteDate date)
                     throws PatriusException

Compute the attitude on the specified date in the reference frame.

Parameters:

date - current date

Returns:

attitude on the specified date

Throws:

PatriusException - if attitude cannot be computed for provided date

getAttitude

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

Compute the attitude on the specified date.

Parameters:

date - current date

frame - reference frame from which attitude is computed

Returns:

attitude on the specified date

Throws:

PatriusException - if attitude cannot be computed for provided date

setTimeInterval

public TabulatedAttitude setTimeInterval(AbsoluteDateInterval interval)

Return a new law with the specified interval.

Parameters:

interval - new interval of validity

Returns:

new tabulated attitude law

getAttitudes

public List<Attitude> getAttitudes()

Getter for the non-interpolated and rightly ordered attitudes.

Returns:

the list of attitudes

getReferenceFrame

public Frame getReferenceFrame()

Getter for the reference frame.

Returns:

referenceFrame reference frame from which attitude is defined.

getDurations

public double[] getDurations()

Getter for the durations.

Returns:

the durations

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 TabulatedAttitude 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

isSpinDerivativesComputation

public boolean isSpinDerivativesComputation()

Returns spin derivatives computation flag.

Returns:

spin derivatives computation flag

setAngularDerivativesFilter

public void setAngularDerivativesFilter(AngularDerivativesFilter angularDerivativeFilter)

Setter for the filter to use in interpolation.

Parameters:

angularDerivativeFilter - the filter to set

getAngularDerivativeFilter

protected AngularDerivativesFilter getAngularDerivativeFilter()

Getter for the angular derivative filter.

Returns:

the angular derivative filter

getInterpolationOrder

protected int getInterpolationOrder()

Getter for the interpolation order.

Returns:

the interpolation order