fr.cnes.sirius.patrius.attitudes.directions

Interface ITargetDirection

All Superinterfaces:

IDirection, Serializable

All Known Implementing Classes:

EarthCenterDirection, EarthToCelestialBodyCenterDirection, GenericTargetDirection, ToCelestialBodyCenterDirection

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.SignalDirection The signal propagation direction

Method Summary

Modifier and Type	Method and Description
Line	getLine(PVCoordinatesProvider origin, ITargetDirection.SignalDirection signalDirection, AbsoluteDate date, SignalPropagationModel.FixedDate fixedDateType, Frame frame, double epsilon) Provides the line connecting both objects and taking into account the delay of signal propagation.
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.
Vector3D	getVector(PVCoordinatesProvider origin, ITargetDirection.SignalDirection signalDirection, AbsoluteDate date, SignalPropagationModel.FixedDate fixedDateType, Frame frame, double epsilon) Provides the direction vector taking into account the delay of signal propagation.

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

getVector

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

Provides the direction vector taking into account the delay of signal propagation. Both objects can be the signal emitter or the signal receiver. The ITargetDirection.SignalDirection provides the signal propagation direction. Regardless to the propagation direction, the output vector is oriented from the origin object to the target object. Moreover, the SignalPropagationModel.FixedDate indicates whether the reference date is the signal emission or the signal reception. To perform the signal propagation, the target inertial frame (or the input frame, if it is not defined) is frozen with respect to the ICRF frame.

Warning: The returned direction vector is not corrected for the stellar aberration, only a light-time correction is applied, see aberration corrections.

Parameters:

origin - the object that set the origin of the output vector.

signalDirection - indicates the signal propagation direction.

date - the reference date.

fixedDateType - indicates whether the reference date is a signal emission or reception.

frame - the frame to compute the direction vector. To perform the signal propagation, the target inertial frame (or the input frame, if it is not defined) is frozen with respect to the ICRF frame.

epsilon - the time tolerance for convergence.

Returns:

the light-time corrected direction vector (from origin to target) at the given date in the given frame

Throws:

PatriusException - if the input frame is not inertial.

getLine

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

Provides the line connecting both objects and taking into account the delay of signal propagation. Both objects can be the signal emitter or the signal receiver. The ITargetDirection.SignalDirection provides the signal propagation direction. Moreover, the SignalPropagationModel.FixedDate indicates whether the reference date is the signal emission or the signal reception. To perform the signal propagation, the target inertial frame (or the input frame, if it is not defined) is frozen with respect to the ICRF frame.

Warning: The returned direction line is not corrected for the stellar aberration, only a light-time correction is applied, see aberration corrections.

Parameters:

origin - the object that set the origin of the output line.

signalDirection - indicates the signal propagation direction.

date - the reference date.

fixedDateType - indicates whether the reference date is a signal emission or reception.

frame - the frame to compute the direction vector.To perform the signal propagation, the target inertial frame (or the input frame, if it is not defined) is frozen with respect to the ICRF frame.

epsilon - the time tolerance for convergence.

Returns:

the half Line of space at the given date in the given frame:

• if RECEPTION date FROM_TARGET: half Line from the origin position at fixed date in the light-time corrected origin-to-target direction;
• if RECEPTION date TOWARD_TARGET: half Line from the target position at fixed date in the light-time corrected target-to-origin direction;
• if EMISSION date TOWARD_TARGET: half Line from the origin position at fixed date in the light-time corrected origin-to-target direction;
• if EMISSION date FROM_TARGET: half Line from the target position at fixed date in the light-time corrected target-to-origin direction.

Throws:

PatriusException - if the input frame is not inertial.

getTargetPvProvider

PVCoordinatesProvider getTargetPvProvider()

Provides the PVCoordinatesProvider associated to the target object.

Returns:

the PV coordinates provider of the target