fr.cnes.sirius.patrius.attitudes

Class LofOffset

java.lang.Object

fr.cnes.sirius.patrius.attitudes.AbstractAttitudeLaw

fr.cnes.sirius.patrius.attitudes.LofOffset

All Implemented Interfaces:

AttitudeLaw, AttitudeProvider, Serializable

public class LofOffset
extends AbstractAttitudeLaw

Attitude law defined by fixed Roll, Pitch and Yaw angles (in any order) with respect to a local orbital frame.

The attitude provider is defined as a rotation offset from some local orbital frame.

Author:

Véronique Pommier-Maurussane

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LofOffset(Frame inertialFrameIn, LOFType typeIn) Create a LOF-aligned attitude.
LofOffset(Frame pInertialFrame, LOFType typeIn, RotationOrder order, double alpha1, double alpha2, double alpha3) Creates new instance.
LofOffset(LOFType typeIn) Create a LOF-aligned attitude.
LofOffset(LOFType typeIn, RotationOrder order, double alpha1, double alpha2, double alpha3) Creates new instance.

Method Summary

Modifier and Type	Method and Description
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Compute the attitude corresponding to an orbital state.
LOFType	getLofType() Getter for the type of Local Orbital Frame.
Frame	getPseudoInertialFrame() Getter for the inertial frame with respect to which orbit should be computed.
Rotation	getRotation() Getter for the rotation from reference frame to satellite frame.
String	toString()

Methods inherited from class fr.cnes.sirius.patrius.attitudes.AbstractAttitudeLaw

getSpinDerivativesComputation, setSpinDerivativesComputation

Methods inherited from class java.lang.Object

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

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

computeSpinByFD, computeSpinDerivativeByFD, getAttitude

Constructor Detail

LofOffset

public LofOffset(LOFType typeIn)

Create a LOF-aligned attitude.

Calling this constructor is equivalent to call LofOffset(FramesFactory.getGCRF(), LOFType, RotationOrder.XYZ, 0, 0, 0).

The GCRF frame is used as pivot in the transformation from an actual frame to the local orbital frame.

Parameters:

typeIn - type of Local Orbital Frame

LofOffset

public LofOffset(Frame inertialFrameIn,
                 LOFType typeIn)
          throws PatriusException

Create a LOF-aligned attitude.

Calling this constructor is equivalent to call LofOffset(inertialFrame, LOFType, RotationOrder.XYZ, 0, 0, 0)

Parameters:

inertialFrameIn - inertial frame with respect to which orbit should be computed. This frame is the pivot in the transformation from an actual frame to the local orbital frame.

typeIn - type of Local Orbital Frame

Throws:

PatriusException - if inertialFrame is not a pseudo-inertial frame

LofOffset

public LofOffset(Frame pInertialFrame,
                 LOFType typeIn,
                 RotationOrder order,
                 double alpha1,
                 double alpha2,
                 double alpha3)
          throws PatriusException

Creates new instance.

An important thing to note is that the rotation order and angles signs used here are compliant with an attitude definition, i.e. they correspond to a frame that rotate in a field of fixed vectors. The underlying definitions used in commons-math Rotation use reversed definition, i.e. they correspond to a vectors field rotating with respect to a fixed frame. So to retrieve the angles provided here from the commons-math underlying rotation, one has to revert the rotation, as in the following code snippet:

 LofOffset law = new LofOffset(inertial, lofType, order, alpha1, alpha2, alpha3);
 Rotation offsetAtt = law.getAttitude(orbit).getRotation();
 Rotation alignedAtt = new LofOffset(inertial, lofType).getAttitude(orbit).getRotation();
 Rotation offsetProper = offsetAtt.applyTo(alignedAtt.revert());
 
 // note the call to revert in the following statement
 double[] angles = offsetProper.revert().getAngles(order);
 
 System.out.println(alpha1 + " == " + angles[0]);
 System.out.println(alpha2 + " == " + angles[1]);
 System.out.println(alpha3 + " == " + angles[2]);
 

Parameters:

pInertialFrame - inertial frame with respect to which orbit should be computed. This frame is the pivot in the transformation from the actual frame to the local orbital frame.

typeIn - type of Local Orbital Frame

order - order of rotations to use for (alpha1, alpha2, alpha3) composition

alpha1 - angle of the first elementary rotation

alpha2 - angle of the second elementary rotation

alpha3 - angle of the third elementary rotation

Throws:

PatriusException - if inertialFrame is not a pseudo-inertial frame

LofOffset

public LofOffset(LOFType typeIn,
                 RotationOrder order,
                 double alpha1,
                 double alpha2,
                 double alpha3)

Creates new instance.

The GCRF frame is used as pivot in the transformation from an actual frame to the local orbital frame.

An important thing to note is that the rotation order and angles signs used here are compliant with an attitude definition, i.e. they correspond to a frame that rotate in a field of fixed vectors. The underlying definitions used in commons-math Rotation use reversed definition, i.e. they correspond to a vectors field rotating with respect to a fixed frame. So to retrieve the angles provided here from the commons-math underlying rotation, one has to revert the rotation, as in the following code snippet:

 LofOffset law = new LofOffset(inertial, lofType, order, alpha1, alpha2, alpha3);
 Rotation offsetAtt = law.getAttitude(orbit).getRotation();
 Rotation alignedAtt = new LofOffset(inertial, lofType).getAttitude(orbit).getRotation();
 Rotation offsetProper = offsetAtt.applyTo(alignedAtt.revert());
 
 // note the call to revert in the following statement
 double[] angles = offsetProper.revert().getAngles(order);
 
 System.out.println(alpha1 + " == " + angles[0]);
 System.out.println(alpha2 + " == " + angles[1]);
 System.out.println(alpha3 + " == " + angles[2]);
 

Parameters:

typeIn - type of Local Orbital Frame

order - order of rotations to use for (alpha1, alpha2, alpha3) composition

alpha1 - angle of the first elementary rotation

alpha2 - angle of the second elementary rotation

alpha3 - angle of the third elementary rotation

Method Detail

getAttitude

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

Compute the attitude corresponding to an orbital state.

Parameters:

pvProv - local position-velocity provider around current date

date - current date

frame - reference frame from which attitude is computed

Returns:

attitude attitude on the specified date and position-velocity state

Throws:

PatriusException - if attitude cannot be computed for provided date

getPseudoInertialFrame

public Frame getPseudoInertialFrame()

Getter for the inertial frame with respect to which orbit should be computed. This frame is the pivot in the transformation from the actual frame to the local orbital frame.

Returns:

the inertial frame with respect to which orbit should be computed. This frame is the pivot in the transformation from the actual frame to the local orbital frame

getLofType

public LOFType getLofType()

Getter for the type of Local Orbital Frame.

Returns:

the type of Local Orbital Frame

getRotation

public Rotation getRotation()

Getter for the rotation from reference frame to satellite frame.

Returns:

the rotation from reference frame to satellite frame

toString

public String toString()

Overrides:

toString in class Object