fr.cnes.sirius.patrius.attitudes.directions

Interface ITargetDirection

All Superinterfaces:

IDirection, Serializable

All Known Implementing Classes:

BodyPointTargetDirection, EarthCenterDirection, EarthToCelestialPointDirection, GenericTargetDirection, ToCelestialPointDirection

public interface ITargetDirection
extends IDirection

This interface extends Directions for the directions described by a target point.

Since:

1.1

Version:

$Id: ITargetDirection.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Thomas Trapier

See Also:

IDirection.getVector(PVCoordinatesProvider, AbsoluteDate, Frame)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ITargetDirection.AberrationCorrection Enumerate for the aberration corrections to apply, see aberration corrections for more details about corrections CN, CN+S, XCN and XCN+S referred here under.
static class	ITargetDirection.SignalDirection The signal propagation direction.

Method Summary

Modifier and Type	Method and Description
Line	getLine(PVCoordinatesProvider origin, ITargetDirection.SignalDirection signalDirection, ITargetDirection.AberrationCorrection correction, AbsoluteDate date, VacuumSignalPropagationModel.FixedDate fixedDateType, Frame frame, double epsilon) Provides the half line containing both origin and target, taking into account the type of date (emission or reception), corrected for light-time and stellar aberration pending the entered correction parameter.
PVCoordinates	getTargetPVCoordinates(AbsoluteDate date, Frame frame) Provides the target point at a given date in a given frame, represented by the associated PVCoordinates object.
PVCoordinatesProvider	getTargetPvProvider() Provides the PVCoordinatesProvider associated to the target object.
default Vector3D	getVector(PVCoordinatesProvider origin, ITargetDirection.SignalDirection signalDirection, ITargetDirection.AberrationCorrection correction, AbsoluteDate date, VacuumSignalPropagationModel.FixedDate fixedDateType, Frame frame, double epsilon) Provides the direction vector (from origin to target) at entered date, taking into account the type of date (emission or reception), corrected for light-time and stellar aberration pending the entered correction parameter.

Methods inherited from interface fr.cnes.sirius.patrius.attitudes.directions.IDirection

getLine, getVector

Method Detail

getTargetPVCoordinates

PVCoordinates getTargetPVCoordinates(AbsoluteDate date,
                                     Frame frame)
                              throws PatriusException

Provides the target point at a given date in a given frame, represented by the associated PVCoordinates object.

Parameters:

date - the date

frame - the frame

Returns:

the PVCoordinates of the target

Throws:

PatriusException - if position cannot be computed in given frame

getLine

Line getLine(PVCoordinatesProvider origin,
             ITargetDirection.SignalDirection signalDirection,
             ITargetDirection.AberrationCorrection correction,
             AbsoluteDate date,
             VacuumSignalPropagationModel.FixedDate fixedDateType,
             Frame frame,
             double epsilon)
      throws PatriusException

Provides the half line containing both origin and target, taking into account the type of date (emission or reception), corrected for light-time and stellar aberration pending the entered correction parameter.

Nota: if entered correction is NONE, invoking this method is not fully equivalent to invoking the method IDirection.getLine(PVCoordinatesProvider, AbsoluteDate, Frame) due to orientation of the half line (from the origin position at entered date in the target direction, or from the target position at entered date in the origin direction).

Parameters:

origin - the current coordinates of the origin point of the direction (may be null, in that specific case, the origin of the direction is the frame origin).

signalDirection - the signal direction

correction - the type of correction for light-time and stellar aberration (NONE, LT, S, or LT_S, see aberration corrections). In case of S or of LT_S correction, the stellar aberration is corrected at reception if RECEPTION date type or at transmission if EMISSION date type.

date - the date for origin

fixedDateType - the type of the previous given date : emission or reception

frame - the frame to project the line

epsilon - the absolute duration threshold used for convergence of signal propagation computation. The epsilon is a time absolute error (ex: 1E-14s, in this case, the signal distance accuracy is 1E-14s x 3E8m/s = 3E-6m).

Returns:

the half line of space, at the given date in the given frame, corrected for the given aberration:

• if RECEPTION date FROM_TARGET: half line from the origin position at fixed date, in the target apparent direction;
• if RECEPTION date TOWARD_TARGET: half line from the target position at fixed date, in the origin apparent direction;
• if EMISSION date TOWARD_TARGET: half line from the origin position at fixed date, in the target corrected direction;
• if EMISSION date FROM_TARGET: half line from the target position at fixed date, in the origin corrected direction.

Throws:

PatriusException - if some frame specific errors occur

getTargetPvProvider

PVCoordinatesProvider getTargetPvProvider()

Provides the PVCoordinatesProvider associated to the target object.

Returns:

the PV coordinates provider of the target

getVector

default Vector3D getVector(PVCoordinatesProvider origin,
                           ITargetDirection.SignalDirection signalDirection,
                           ITargetDirection.AberrationCorrection correction,
                           AbsoluteDate date,
                           VacuumSignalPropagationModel.FixedDate fixedDateType,
                           Frame frame,
                           double epsilon)
                    throws PatriusException

Provides the direction vector (from origin to target) at entered date, taking into account the type of date (emission or reception), corrected for light-time and stellar aberration pending the entered correction parameter.

Nota: if entered correction is NONE, invoking this method is equivalent to invoking the method IDirection.getVector(PVCoordinatesProvider, AbsoluteDate, Frame).

Parameters:

origin - the current coordinates of the origin point of the direction (may be null, in that specific case, the origin of the direction is the frame origin).

signalDirection - the signal direction

correction - the type of correction for light-time and stellar aberration (NONE, LT, S, or LT_S, see aberration corrections). In case of S or of LT_S correction, the stellar aberration is corrected at reception if RECEPTION date type or at transmission if EMISSION date type.

date - the date

fixedDateType - the type of the previous given date : emission or reception

frame - the frame to project the vector coordinates

epsilon - the absolute duration threshold used for convergence of signal propagation computation. The epsilon is a time absolute error (ex: 1E-14s, in this case, the signal distance accuracy is 1E-14s x 3E8m/s = 3E-6m).

Returns:

the direction vector (from origin to target) at the given date in the given frame

Throws:

PatriusException - if some frame specific errors occur