fr.cnes.sirius.patrius.attitudes.kinematics

Class AbstractOrientationFunction

java.lang.Object

fr.cnes.sirius.patrius.attitudes.kinematics.AbstractOrientationFunction

All Implemented Interfaces:

OrientationFunction, UnivariateVectorFunction

public abstract class AbstractOrientationFunction
extends Object
implements OrientationFunction

This abstract class is a time-dependent function representing an orientation.

Since:

1.3

Version:

$Id: AbstractOrientationFunction.java 18065 2017-10-02 16:42:02Z bignon $

Author:

Tiziana Sabatini

Concurrency :

conditionally thread-safe

Concurrency comment :

thread-safe if the attribute differentiator is thread-safe and if the implementation of this abstract class is thread-safe too.

Constructor Summary

Constructors

Constructor and Description
AbstractOrientationFunction(AbsoluteDate zeroDate) Constructor setting a default finite differences differentiator.
AbstractOrientationFunction(AbsoluteDate zeroDate, UnivariateVectorFunctionDifferentiator inDifferentiator)

Method Summary

Modifier and Type	Method and Description
OrientationFunction	derivative() Compute the OrientationFunction representing the first derivative of the current orientation function components.
Vector3D	estimateRate(AbsoluteDate date, double dt, AbsoluteDateInterval interval) Estimate the spin at a given date from the current OrientationFunction using the AngularCoordinates.estimateRate(Rotation, Rotation, double) method.
Vector3DFunction	estimateRateFunction(double dt, AbsoluteDateInterval interval) Estimate the Vector3DFunction from the current OrientationFunction using the AngularCoordinates.estimateRate(Rotation, Rotation, double) method.
UnivariateVectorFunctionDifferentiator	getDifferentiator() Get the differentiator.
abstract Rotation	getOrientation(AbsoluteDate date) Get the orientation at a given date.
int	getSize() Compute the size of the list of values of the function as created by the UnivariateVectorFunction.value(double) method
AbsoluteDate	getZeroDate() Get the date at x = 0.
double[]	value(double x) Compute the quaternion components of the orientation at the (zero + x) date.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOrientationFunction

public AbstractOrientationFunction(AbsoluteDate zeroDate)

Constructor setting a default finite differences differentiator.

Parameters:

zeroDate - the date at x = 0.

AbstractOrientationFunction

public AbstractOrientationFunction(AbsoluteDate zeroDate,
                                   UnivariateVectorFunctionDifferentiator inDifferentiator)

Parameters:

zeroDate - the date at x = 0.

inDifferentiator - the differentiation method used to compute the first derivative of the current orientation function components.

Method Detail

getOrientation

public abstract Rotation getOrientation(AbsoluteDate date)
                                 throws PatriusException

Get the orientation at a given date. This method must be implemented in the inherited classes.

Specified by:

getOrientation in interface OrientationFunction

Parameters:

date - the date

Returns:

the orientation at a given date; the orientation is an instance of the Rotation class.

Throws:

PatriusException - if rotation cannot be computed

getZeroDate

public final AbsoluteDate getZeroDate()

Get the date at x = 0.

Returns:

the date at x = 0.

getDifferentiator

public final UnivariateVectorFunctionDifferentiator getDifferentiator()

Get the differentiator.

Returns:

the differentiator.

value

public final double[] value(double x)

Compute the quaternion components of the orientation at the (zero + x) date.

Specified by:

value in interface UnivariateVectorFunction

Parameters:

x - the time from the date zero for which the function value should be computed

Returns:

the quaternion components representing the orientation at the given date.

Throws:

PatriusExceptionWrapper - if problems to compute value (frame transformation, or other)

estimateRateFunction

public final Vector3DFunction estimateRateFunction(double dt,
                                                   AbsoluteDateInterval interval)

Estimate the Vector3DFunction from the current OrientationFunction using the AngularCoordinates.estimateRate(Rotation, Rotation, double) method.

Specified by:

estimateRateFunction in interface OrientationFunction

Parameters:

dt - time elapsed between the dates of the two orientations

interval - validity interval of the function (necessary for handling derivatives at boundaries)

Returns:

the spin function.

estimateRate

public final Vector3D estimateRate(AbsoluteDate date,
                                   double dt,
                                   AbsoluteDateInterval interval)
                            throws PatriusException

Estimate the spin at a given date from the current OrientationFunction using the AngularCoordinates.estimateRate(Rotation, Rotation, double) method.

Parameters:

date - the current date

dt - time elapsed between the dates of the two orientations

interval - interval of validity of the function

Returns:

the spin at the current date.

Throws:

PatriusException - if the rate cannot be estimated

derivative

public OrientationFunction derivative()

Compute the OrientationFunction representing the first derivative of the current orientation function components.
The differentiation is performed using a numerical differentiation method. This method can be overridden if an analytical differentiation should be performed instead.

Specified by:

derivative in interface OrientationFunction

Returns:

a new OrientationFunction containing the first derivative of the orientation function components.

getSize

public int getSize()

Compute the size of the list of values of the function as created by the UnivariateVectorFunction.value(double) method

Specified by:

getSize in interface UnivariateVectorFunction

Returns:

the size of the values array