fr.cnes.sirius.patrius.signalpropagation

Class SignalPropagation

java.lang.Object

fr.cnes.sirius.patrius.signalpropagation.SignalPropagation

public class SignalPropagation
extends Object

This class describes the propagation of a signal in space

Since:

1.2

Version:

$Id$

Author:

Thomas Trapier

Concurrency :

not thread-safe

Concurrency comment :

use of the frames tree

Constructor Summary

Constructors

Constructor and Description
SignalPropagation(Vector3D propagation, AbsoluteDate inEmissionDate, AbsoluteDate inReceptionDate, Frame refFrame, SignalPropagationModel.FixedDate fixedDate) Old constructor with computation of one of the dates
SignalPropagation(Vector3D propagation, AbsoluteDate inEmissionDate, AbsoluteDate inReceptionDate, Frame refFrame, SignalPropagationModel.FixedDate fixedDate, Vector3D velEmitter, Vector3D velReceiver) New extended constructor with computation of one of the dates (supports derivatives computation).

Method Summary

Modifier and Type	Method and Description
RealMatrix	getdPropdPem(Frame expressionFrame) Getter for the propagation position vector derivatives wrt the emitter position express in the given frame.
RealMatrix	getdPropdPrec(Frame expressionFrame) Getter for the propagation position vector derivatives wrt the receiver position express in the given frame.
Vector3D	getdPropdT() Getter for the propagation velocity vector (= propagation vector derivative wrt time) in the reference frame.
Vector3D	getdPropdT(Frame expressionFrame) Getter for the propagation velocity vector (= propagation vector derivative wrt time) in the given frame.
Vector3D	getdTpropdPem() Getter for the signal propagation partial derivatives vector wrt the emitter position in the reference frame at the emitting date.
Vector3D	getdTpropdPem(Frame expressionFrame) Getter for the signal propagation partial derivatives vector wrt the emitter position in the specified frame at the emitting date.
Vector3D	getdTpropdPrec() Getter for the signal propagation partial derivatives vector wrt the receiver position in the reference frame at the reception date.
Vector3D	getdTpropdPrec(Frame expressionFrame) Getter for the signal propagation partial derivatives vector wrt the receiver position in the specified frame at the reception date.
double	getdTpropdT() Getter for the signal propagation partial derivatives wrt time.
AbsoluteDate	getEndDate() Getter for the reception date.
SignalPropagationModel.FixedDate	getFixedDateType()
Frame	getFrame() Getter for the reference frame.
PVCoordinates	getPVPropagation() Getter for the propagation position/velocity vectors in the reference frame.
double	getSignalPropagationDuration() Getter for the signal propagation duration (delay in seconds between the emission date and the reception date).
AbsoluteDate	getStartDate() Getter for the emission date.
Vector3D	getVector() Getter for the propagation vector in the reference frame.
Vector3D	getVector(Frame expressionFrame) Getter for the propagation vector in the given frame.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalPropagation

public SignalPropagation(Vector3D propagation,
                         AbsoluteDate inEmissionDate,
                         AbsoluteDate inReceptionDate,
                         Frame refFrame,
                         SignalPropagationModel.FixedDate fixedDate)

Old constructor with computation of one of the dates

Parameters:

propagation - the propagation vector

inEmissionDate - the emission date

inReceptionDate - the reception date

refFrame - the reference frame for the vector

fixedDate - the fixed date for computations (reception or emission)

Throws:

IllegalArgumentException - if propagation.getNorm() < Precision.DOUBLE_COMPARISON_EPSILON

SignalPropagation

public SignalPropagation(Vector3D propagation,
                         AbsoluteDate inEmissionDate,
                         AbsoluteDate inReceptionDate,
                         Frame refFrame,
                         SignalPropagationModel.FixedDate fixedDate,
                         Vector3D velEmitter,
                         Vector3D velReceiver)

New extended constructor with computation of one of the dates (supports derivatives computation).

Parameters:

propagation - the propagation vector

inEmissionDate - the emission date

inReceptionDate - the reception date

refFrame - the reference frame for the vector

fixedDate - the fixed date for computations (reception or emission)

velEmitter - Emitter velocity in the reference frame

velReceiver - Receiver velocity in the reference frame

Throws:

IllegalArgumentException - if propagation.getNorm() < Precision.DOUBLE_COMPARISON_EPSILON

Method Detail

getStartDate

public final AbsoluteDate getStartDate()

Getter for the emission date.

Returns:

the emission date

getEndDate

public final AbsoluteDate getEndDate()

Getter for the reception date.

Returns:

the reception date

getFrame

public final Frame getFrame()

Getter for the reference frame.

Returns:

the reference frame

getSignalPropagationDuration

public final double getSignalPropagationDuration()

Getter for the signal propagation duration (delay in seconds between the emission date and the reception date).

Returns:

the signal propagation duration

getVector

public final Vector3D getVector(Frame expressionFrame)
                         throws PatriusException

Getter for the propagation vector in the given frame.

Parameters:

expressionFrame - frame in which vector should be expressed

Returns:

the propagation vector in the given frame

Throws:

PatriusException - if frame transformation problem occurs

getVector

public final Vector3D getVector()

Getter for the propagation vector in the reference frame.

Returns:

the propagation vector

getdPropdT

public Vector3D getdPropdT()

Getter for the propagation velocity vector (= propagation vector derivative wrt time) in the reference frame.

Returns:

the propagation velocity vector

getPVPropagation

public PVCoordinates getPVPropagation()

Getter for the propagation position/velocity vectors in the reference frame.

This method is a combination of the methods getVector() and getdPropdT().

Returns:

the propagation position/velocity vectors

getdPropdT

public Vector3D getdPropdT(Frame expressionFrame)
                    throws PatriusException

Getter for the propagation velocity vector (= propagation vector derivative wrt time) in the given frame.

Parameters:

expressionFrame - frame in which vector should be expressed

Returns:

the propagation velocity vector

Throws:

PatriusException - if frame transformation problem occurs

getdPropdPem

public RealMatrix getdPropdPem(Frame expressionFrame)
                        throws PatriusException

Getter for the propagation position vector derivatives wrt the emitter position express in the given frame.

Parameters:

expressionFrame - frame in which the derivatives should be expressed

Returns:

the propagation position vector derivatives wrt the emitter position

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

PatriusException - if some frame specific error occurs

getdPropdPrec

public RealMatrix getdPropdPrec(Frame expressionFrame)
                         throws PatriusException

Getter for the propagation position vector derivatives wrt the receiver position express in the given frame.

Parameters:

expressionFrame - frame in which the derivatives should be expressed

Returns:

the propagation position vector derivatives wrt the receiver position

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

PatriusException - if some frame specific error occurs

getFixedDateType

public SignalPropagationModel.FixedDate getFixedDateType()

Returns:

the inFixedDate

getdTpropdPrec

public Vector3D getdTpropdPrec()

Getter for the signal propagation partial derivatives vector wrt the receiver position in the reference frame at the reception date.

Returns:

the signal propagation partial derivatives vector

getdTpropdPrec

public Vector3D getdTpropdPrec(Frame expressionFrame)
                        throws PatriusException

Getter for the signal propagation partial derivatives vector wrt the receiver position in the specified frame at the reception date.

Parameters:

expressionFrame - the signal propagation partial derivatives vector frame expression

Returns:

the signal propagation partial derivatives vector

Throws:

PatriusException - if some frame specific error occurs

getdTpropdPem

public Vector3D getdTpropdPem()

Getter for the signal propagation partial derivatives vector wrt the emitter position in the reference frame at the emitting date.

Note: dTpropdPem = -dTpropdPrec

Returns:

the signal propagation partial derivatives vector

getdTpropdPem

public Vector3D getdTpropdPem(Frame expressionFrame)
                       throws PatriusException

Getter for the signal propagation partial derivatives vector wrt the emitter position in the specified frame at the emitting date.

Note: dTpropdPem = -dTpropdPrec

Parameters:

expressionFrame - the signal propagation partial derivatives vector frame expression

Returns:

the signal propagation partial derivatives vector

Throws:

PatriusException - if some frame specific error occurs

getdTpropdT

public double getdTpropdT()

Getter for the signal propagation partial derivatives wrt time.

Returns:

the signal propagation partial derivatives