fr.cnes.sirius.patrius.signalpropagation

Class VacuumSignalPropagation

java.lang.Object

fr.cnes.sirius.patrius.signalpropagation.VacuumSignalPropagation

All Implemented Interfaces:

Serializable

public class VacuumSignalPropagation
extends Object
implements Serializable

This class describes the propagation of a signal in space

Since:

1.2

Version:

$Id$

Author:

Thomas Trapier

See Also:

Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

use of the frames tree

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VacuumSignalPropagation.SignalPropagationRole This enumerate represents the role of a protagonist in the signal propagation.

Constructor Summary

Constructors

Constructor and Description
VacuumSignalPropagation(PVCoordinates emitterPV, PVCoordinates receiverPV, AbsoluteDate inEmissionDate, AbsoluteDate inReceptionDate, Frame refFrame, VacuumSignalPropagationModel.FixedDate fixedDate) Signal propagation constructor.

Method Summary

Modifier and Type	Method and Description
RealMatrix	getdPropdPem() Getter for the propagation position vector derivatives wrt the emitter position express in the reference frame.
RealMatrix	getdPropdPem(Frame expressionFrame) Deprecated. as of 4.13
RealMatrix	getdPropdPrec() Getter for the propagation position vector derivatives wrt the receiver position express in the reference frame.
RealMatrix	getdPropdPrec(Frame expressionFrame) Deprecated. as of 4.13
Vector3D	getdPropdT() Getter for the propagation velocity vector (= propagation vector derivative wrt time) in the reference frame.
Vector3D	getdPropdT(Frame expressionFrame) Deprecated. as of 4.13, use getdPropdT() instead
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) Deprecated. as of 4.13, use getdTpropdPem() instead
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) Deprecated. as of 4.13, use getdTpropdPrec() instead
double	getdTpropdT() Getter for the signal propagation partial derivatives wrt time.
AbsoluteDate	getEmissionDate() Getter for the emission date.
PVCoordinates	getEmitterPV() Getter for PV coordinates of the emitter, in the working frame.
VacuumSignalPropagationModel.FixedDate	getFixedDateType() Getter for the fixed date : emission or reception.
Frame	getFrame() Getter for the reference frame.
PVCoordinates	getPVPropagation() Getter for the propagation position/velocity vectors in the reference frame.
PVCoordinates	getReceiverPV() Getter for PV coordinates of the receiver, in the working frame.
AbsoluteDate	getReceptionDate() Getter for the reception date.
double	getShapiroTimeCorrection(CelestialPoint celestialPoint) Computes the Shapiro time dilation due to the gravitational attraction of the provided body.
double	getShapiroTimeCorrection(double mu) Computes the Shapiro time dilation due to the gravitational attraction of the body present at the center of the getFrame().
double	getSignalPropagationDuration() Getter for the signal propagation duration (delay in seconds between the emission date and the reception date).
Vector3D	getVector() Getter for the propagation vector in the reference frame.
Vector3D	getVector(Frame expressionFrame) Deprecated. as of 4.13, use getVector() instead

Methods inherited from class java.lang.Object

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

Constructor Detail

VacuumSignalPropagation

public VacuumSignalPropagation(PVCoordinates emitterPV,
                               PVCoordinates receiverPV,
                               AbsoluteDate inEmissionDate,
                               AbsoluteDate inReceptionDate,
                               Frame refFrame,
                               VacuumSignalPropagationModel.FixedDate fixedDate)

Signal propagation constructor.

Parameters:

emitterPV - the emitter PV in the reference frame

receiverPV - the receiver PV in the reference frame

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 if the emitter and receiver PV are described at the same position

Method Detail

getEmissionDate

public final AbsoluteDate getEmissionDate()

Getter for the emission date.

Returns:

the emission date

getReceptionDate

public final AbsoluteDate getReceptionDate()

Getter for the reception date.

Returns:

the reception date

getEmitterPV

public PVCoordinates getEmitterPV()

Getter for PV coordinates of the emitter, in the working frame.

Returns:

the PV coordinates of the emitter

getReceiverPV

public PVCoordinates getReceiverPV()

Getter for PV coordinates of the receiver, in the working frame.

Returns:

the PV coordinates of the receiver

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

@Deprecated
public final Vector3D getVector(Frame expressionFrame)
                                     throws PatriusException

Deprecated. as of 4.13, use getVector() instead

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.

The returned vector can be projected in any frame thanks to Transform.transformVector(Vector3D).
But beware that it is only a projection and that the propagation process remains with respect to the working frame. Indeed, the result of a propagation process depends, in a more complex manner than just a vector projection, to the working frame.

Returns:

the propagation vector

getdPropdT

@Deprecated
public Vector3D getdPropdT(Frame expressionFrame)
                                throws PatriusException

Deprecated. as of 4.13, use getdPropdT() instead

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

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

getdPropdPem

@Deprecated
public RealMatrix getdPropdPem(Frame expressionFrame)
                                    throws PatriusException

Deprecated. as of 4.13

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

getdPropdPem

public RealMatrix getdPropdPem()

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

Returns:

the propagation position vector derivatives wrt the emitter position

getdPropdPrec

@Deprecated
public RealMatrix getdPropdPrec(Frame expressionFrame)
                                     throws PatriusException

Deprecated. as of 4.13

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

getdPropdPrec

public RealMatrix getdPropdPrec()

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

Returns:

the propagation position vector derivatives wrt the receiver position

getFixedDateType

public VacuumSignalPropagationModel.FixedDate getFixedDateType()

Getter for the fixed date : emission or reception.

Returns:

the fixed date

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

@Deprecated
public Vector3D getdTpropdPrec(Frame expressionFrame)
                                    throws PatriusException

Deprecated. as of 4.13, use getdTpropdPrec() instead

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

@Deprecated
public Vector3D getdTpropdPem(Frame expressionFrame)
                                   throws PatriusException

Deprecated. as of 4.13, use getdTpropdPem() instead

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

getShapiroTimeCorrection

public double getShapiroTimeCorrection(CelestialPoint celestialPoint)
                                throws PatriusException

Computes the Shapiro time dilation due to the gravitational attraction of the provided body.

Parameters:

celestialPoint - The celestial point responsible for the time dilation

Returns:

the Shapiro time dilation

Throws:

PatriusException - if position cannot be computed in given frame

getShapiroTimeCorrection

public double getShapiroTimeCorrection(double mu)

Computes the Shapiro time dilation due to the gravitational attraction of the body present at the center of the getFrame().

Optimized version of the getShapiroTimeCorrection(CelestialPoint) method for the frame attractive body.

Parameters:

mu - The gravitational constant of the body.

Returns:

the Shapiro time dilation