Package org.orekit.frames.encounter

Class DefaultEncounterLOF

java.lang.Object

org.orekit.frames.encounter.AbstractEncounterLOF

org.orekit.frames.encounter.DefaultEncounterLOF

All Implemented Interfaces:

EncounterLOF, LOF

public class DefaultEncounterLOF
extends AbstractEncounterLOF

Default encounter local orbital frame.

Note that it is up to the user to choose which object should be at the origin.

It is defined as follows :

• z axis : Normalized relative velocity vector.
• y axis : Normalized cross product between z axis and other relative to origin position.
• x axis : Completes the right handed coordinate system.

Since:

12.0

Author:

Vincent Cucchietti

Constructor Summary

Constructors

Constructor	Description
DefaultEncounterLOF(FieldPVCoordinates<T> other)	Field constructor.
DefaultEncounterLOF(PVCoordinates other)	Constructor.

Method Summary

Modifier and Type	Method	Description
Vector3D	getAxisNormalToCollisionPlane()	Get the axis normal to the collision plane (i, j or k) in this encounter local orbital frame.
<T extends CalculusFieldElement<T>> FieldVector3D<T>	getAxisNormalToCollisionPlane(Field<T> field)	Get the axis normal to the collision plane (i, j or k) in this encounter local orbital frame.
String	getName()	Get name of the local orbital frame.
<T extends CalculusFieldElement<T>> FieldRotation<T>	rotationFromInertial(Field<T> field, FieldPVCoordinates<T> origin, FieldPVCoordinates<T> other)	Get the rotation from inertial to this encounter local orbital frame.
Rotation	rotationFromInertial(PVCoordinates origin, PVCoordinates other)	Get the rotation from inertial to this encounter local orbital frame.

Methods inherited from class org.orekit.frames.encounter.AbstractEncounterLOF

getFieldOther, getOther, rotationFromInertial, rotationFromInertial

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.frames.encounter.EncounterLOF

computeProjectionMatrix, computeProjectionMatrix, isQuasiInertial, projectOntoCollisionPlane, projectOntoCollisionPlane, projectOntoCollisionPlane, projectOntoCollisionPlane, rotationFromInertial, rotationFromInertial

Methods inherited from interface org.orekit.frames.LOF

rotationFromLOF, rotationFromLOF, transformFromInertial, transformFromInertial, transformFromLOF, transformFromLOF

Constructor Detail

DefaultEncounterLOF

public DefaultEncounterLOF(PVCoordinates other)

Constructor.

Parameters:

other - other object to create the encounter frame with (not the origin of the frame !)

DefaultEncounterLOF

public DefaultEncounterLOF(FieldPVCoordinates<T> other)

Field constructor.

Type Parameters:

T - type of the field elements

Parameters:

other - other object to create the encounter frame with (not the origin of the frame !)

Method Detail

rotationFromInertial

public Rotation rotationFromInertial(PVCoordinates origin,
                                     PVCoordinates other)

Get the rotation from inertial to this encounter local orbital frame.

BEWARE: The given origin's position and velocity coordinates must be given in the frame in which this instance has been expressed in.

Parameters:

origin - position-velocity of the origin in the same inertial frame as other

other - position-velocity of the other instance in the same inertial frame as origin

Returns:

rotation from inertial to this encounter local orbital frame

getAxisNormalToCollisionPlane

public <T extends CalculusFieldElement<T>> FieldVector3D<T> getAxisNormalToCollisionPlane(Field<T> field)

Get the axis normal to the collision plane (i, j or k) in this encounter local orbital frame.

In this case, return (0,0,1);

Type Parameters:

T - type of the field elements

Parameters:

field - field of the elements

Returns:

axis normal to the collision plane (i, j or k) in this encounter local orbital frame

rotationFromInertial

public <T extends CalculusFieldElement<T>> FieldRotation<T> rotationFromInertial(Field<T> field,
                                                                                 FieldPVCoordinates<T> origin,
                                                                                 FieldPVCoordinates<T> other)

Get the rotation from inertial to this encounter local orbital frame.

BEWARE: The given origin's position and velocity coordinates must be given in the frame in which this instance has been expressed in.

Type Parameters:

T - type of the field elements

Parameters:

field - field to which the elements belong

origin - position-velocity of the origin in the same inertial frame as other

other - position-velocity of the other in the same inertial frame as origin

Returns:

rotation from inertial to this encounter local orbital frame

getAxisNormalToCollisionPlane

public Vector3D getAxisNormalToCollisionPlane()

Get the axis normal to the collision plane (i, j or k) in this encounter local orbital frame.

In this case, return (0,0,1);

Returns:

axis normal to the collision plane (i, j or k) in this encounter local orbital frame

getName

public String getName()

Get name of the local orbital frame.

Returns:

name of the local orbital frame