fr.cnes.sirius.patrius.attitudes.directions

Class GenericTargetDirection

java.lang.Object

fr.cnes.sirius.patrius.attitudes.directions.GenericTargetDirection

All Implemented Interfaces:

IDirection, ITargetDirection, Serializable

public final class GenericTargetDirection
extends Object
implements ITargetDirection

Direction described by a target PVCoordinatesProvider. The vector is at any date computed from the given PVCoordinate origin to the target.

Since:

1.1

Version:

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

Author:

Thomas Trapier

See Also:

Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

Not thread-safe by default. No use case for sharing an instance between threads found.

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.attitudes.directions.ITargetDirection

ITargetDirection.SignalDirection

Constructor Summary

Constructors

Constructor and Description
GenericTargetDirection(PVCoordinatesProvider inTarget) Build a direction from a target described by its PVCoordinatesProvider

Method Summary

Modifier and Type	Method and Description
Line	getLine(PVCoordinatesProvider origin, AbsoluteDate date, Frame frame) Provides the line containing the origin (given PV coordinates) and directed by the direction vector.
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, AbsoluteDate date, Frame frame) Provides the direction vector at a given date in a given frame.
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 class java.lang.Object

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

Constructor Detail

GenericTargetDirection

public GenericTargetDirection(PVCoordinatesProvider inTarget)

Build a direction from a target described by its PVCoordinatesProvider

Parameters:

inTarget - the PVCoordinatesProvider describing the target point

Method Detail

getVector

public Vector3D getVector(PVCoordinatesProvider origin,
                          AbsoluteDate date,
                          Frame frame)
                   throws PatriusException

Provides the direction vector at a given date in a given frame.

Specified by:

getVector in interface IDirection

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).

date - the date

frame - the frame to project the vector's coordinates

Returns:

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

Throws:

PatriusException - if some frame specific errors occur

getTargetPVCoordinates

public 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

Specified by:

getTargetPVCoordinates in interface ITargetDirection

Parameters:

date - the date

frame - the frame

Returns:

the PVCoordinates of the target

Throws:

PatriusException - if position cannot be computed in given frame

getLine

public Line getLine(PVCoordinatesProvider origin,
                    AbsoluteDate date,
                    Frame frame)
             throws PatriusException

Provides the line containing the origin (given PV coordinates) and directed by the direction vector.

Specified by:

getLine in interface IDirection

Parameters:

origin - the origin of the direction

date - the current date

frame - the expression frame of the line

Returns:

the half Line of space from the origin position at given date and containing the direction vector

Throws:

PatriusException - if some frame specific errors occur

getVector

public 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.

Specified by:

getVector in interface ITargetDirection

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

public 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.

Specified by:

getLine in interface ITargetDirection

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

public PVCoordinatesProvider getTargetPvProvider()

Provides the PVCoordinatesProvider associated to the target object.

Specified by:

getTargetPvProvider in interface ITargetDirection

Returns:

the PV coordinates provider of the target