Package org.orekit.attitudes

Class GroundPointing

java.lang.Object

org.orekit.attitudes.GroundPointing

All Implemented Interfaces:

Serializable, AttitudeProvider

Direct Known Subclasses:

BodyCenterPointing, LofOffsetPointing, NadirPointing, TargetPointing, YawCompensation, YawSteering

public abstract class GroundPointing
extends Object
implements AttitudeProvider

Base class for ground pointing attitude providers.

This class is a basic model for different kind of ground pointing attitude providers, such as : body center pointing, nadir pointing, target pointing, etc...

The object GroundPointing is guaranteed to be immutable.

Author:

Véronique Pommier-Maurussane

See Also:

AttitudeProvider, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GroundPointing(Frame inertialFrame, Frame bodyFrame)	Default constructor.

Method Summary

Modifier and Type	Method	Description
<T extends RealFieldElement<T>> FieldAttitude<T>	getAttitude(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)	Compute the attitude corresponding to an orbital state.
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)	Compute the attitude corresponding to an orbital state.
Frame	getBodyFrame()	Get the body frame.
abstract <T extends RealFieldElement<T>> TimeStampedFieldPVCoordinates<T>	getTargetPV(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)	Compute the target point position/velocity in specified frame.
abstract TimeStampedPVCoordinates	getTargetPV(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)	Compute the target point position/velocity in specified frame.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroundPointing

protected GroundPointing(Frame inertialFrame,
                         Frame bodyFrame)
                  throws OrekitException

Default constructor. Build a new instance with arbitrary default elements.

Parameters:

inertialFrame - frame in which orbital velocities are computed

bodyFrame - the frame that rotates with the body

Throws:

OrekitException - if the first frame specified is not a pseudo-inertial frame

Since:

7.1

Method Detail

getBodyFrame

public Frame getBodyFrame()

Get the body frame.

Returns:

body frame

getTargetPV

public abstract TimeStampedPVCoordinates getTargetPV(PVCoordinatesProvider pvProv,
                                                     AbsoluteDate date,
                                                     Frame frame)
                                              throws OrekitException

Compute the target point position/velocity in specified frame.

This method is public only to allow users to subclass this abstract class from other packages. It is not intended to be used directly.

Parameters:

pvProv - provider for PV coordinates

date - date at which target point is requested

frame - frame in which observed ground point should be provided

Returns:

observed ground point position (element 0) and velocity (at index 1) in specified frame

Throws:

OrekitException - if some specific error occurs, such as no target reached

getTargetPV

public abstract <T extends RealFieldElement<T>> TimeStampedFieldPVCoordinates<T> getTargetPV(FieldPVCoordinatesProvider<T> pvProv,
                                                                                             FieldAbsoluteDate<T> date,
                                                                                             Frame frame)
                                                                                      throws OrekitException

Compute the target point position/velocity in specified frame.

Type Parameters:

T - type of the fiels elements

Parameters:

pvProv - provider for PV coordinates

date - date at which target point is requested

frame - frame in which observed ground point should be provided

Returns:

observed ground point position (element 0) and velocity (at index 1) in specified frame

Throws:

OrekitException - if some specific error occurs, such as no target reached

Since:

9.0

getAttitude

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

Compute the attitude corresponding to an orbital state.

Specified by:

getAttitude in interface AttitudeProvider

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:

OrekitException - if attitude cannot be computed

getAttitude

public <T extends RealFieldElement<T>> FieldAttitude<T> getAttitude(FieldPVCoordinatesProvider<T> pvProv,
                                                                    FieldAbsoluteDate<T> date,
                                                                    Frame frame)
                                                             throws OrekitException

Compute the attitude corresponding to an orbital state.

Specified by:

getAttitude in interface AttitudeProvider

Type Parameters:

T - type of the field elements

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:

OrekitException - if attitude cannot be computed