fr.cnes.sirius.patrius.attitudes.orientations

Interface OrientationAngleProvider

All Superinterfaces:

Serializable

All Known Subinterfaces:

OrientationAngleLaw, OrientationAngleLeg, OrientationAngleProfile

All Known Implementing Classes:

AbstractOrientationAngleLeg, AbstractOrientationAngleProfile, ConstantOrientationAngleLaw, ConstantOrientationAngleLeg, OrientationAngleLawLeg, OrientationAngleLegsSequence, OrientationAngleProfileSequence

public interface OrientationAngleProvider
extends Serializable

This interface represents an orientation angle provider model set. An orientation angle provider provides a way to compute an angle from a date and position-velocity local provider.

Since:

4.2

Author:

morerem

Method Summary

Modifier and Type	Method and Description
static OrientationAngleProvider	build(UnivariateDateFunction function) Build an OrientationAngleProvider from this.
default double	computeSpinByFD(PVCoordinatesProvider pvProv, AbsoluteDate date, double computationStep) Compute the orientation derivative at a given date by finite differences (using 2nd order centered finite differences).
default double	computeSpinDerivativeByFD(PVCoordinatesProvider pvProv, AbsoluteDate date, double computationStep) Compute the orientation acceleration vector at a given date by finite differences (using 2nd order centered finite differences).
static double	computeSpinNumerical(double angle1, double angle2, double step) Computes the spin as a finite difference given two angles and the computation step between them.
Double	getOrientationAngle(PVCoordinatesProvider pvProv, AbsoluteDate date) Compute the orientation angle corresponding to an orbital state.

Method Detail

getOrientationAngle

Double getOrientationAngle(PVCoordinatesProvider pvProv,
                           AbsoluteDate date)
                    throws PatriusException

Compute the orientation angle corresponding to an orbital state.

Parameters:

pvProv - position-velocity provider around current date

date - date

Returns:

orientation angle at the specified date and position-velocity state, null if outside interval

Throws:

PatriusException - thrown if the angle cannot be computed

computeSpinByFD

default double computeSpinByFD(PVCoordinatesProvider pvProv,
                               AbsoluteDate date,
                               double computationStep)
                        throws PatriusException

Compute the orientation derivative at a given date by finite differences (using 2nd order centered finite differences).

Parameters:

pvProv - PV Coordinates Provider.

date - Date at which the orientation derivative is desired.

computationStep - Computation step used for the finite differences (in seconds).

Returns:

The orientation derivative of the satellite

Throws:

PatriusException - When the orientation cannot be computed

computeSpinDerivativeByFD

default double computeSpinDerivativeByFD(PVCoordinatesProvider pvProv,
                                         AbsoluteDate date,
                                         double computationStep)
                                  throws PatriusException

Compute the orientation acceleration vector at a given date by finite differences (using 2nd order centered finite differences).

Parameters:

pvProv - PV Coordinates Provider.

date - Date at which the orientation acceleration is desired.

computationStep - Computation step used for the finite differences (in seconds).

Returns:

The orientation acceleration of the satellite

Throws:

PatriusException - When the orientation cannot be computed

computeSpinNumerical

static double computeSpinNumerical(double angle1,
                                   double angle2,
                                   double step)

Computes the spin as a finite difference given two angles and the computation step between them.

WARNING : It is considered that the difference between the two angle points used for the finite difference spin computation is never larger than π in the sense of the rotation

Parameters:

angle1 - Angle at t₁

angle2 - Angle at t₂

step - Computation step, elapsed time between t₁ and t₂

Returns:

the Spin computed as finite difference

build

static OrientationAngleProvider build(UnivariateDateFunction function)

Build an OrientationAngleProvider from this.

Parameters:

function - input function

Returns:

an orientation angle provider