fr.cnes.sirius.patrius.signalpropagation

Class VacuumSignalPropagationModel

java.lang.Object

fr.cnes.sirius.patrius.signalpropagation.VacuumSignalPropagationModel

public class VacuumSignalPropagationModel
extends Object

Model for the computation of a signal propagation vector and toolbox for the different corrections to be applied to it.

Since:

1.2

Version:

$Id$

Author:

Thomas Trapier

Concurrency :

not thread-safe

Concurrency comment :

use of the frames tree

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VacuumSignalPropagationModel.ConvergenceAlgorithm Convergence algorithm to compute the geometric signal propagation duration.
static class	VacuumSignalPropagationModel.FixedDate the fixed date of computation

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_EPSILON Default epsilon (s) for signal propagation computation.
static int	DEFAULT_MAX_ITER Default max number of iterations for signal propagation computation.

Constructor Summary

Constructors

Constructor and Description
VacuumSignalPropagationModel(Frame frame) Constructor of the signal propagation model.
VacuumSignalPropagationModel(Frame frame, double threshold) Constructor of the signal propagation model.
VacuumSignalPropagationModel(Frame frame, double threshold, double maxIter) Constructor of the signal propagation model.
VacuumSignalPropagationModel(Frame frame, double threshold, VacuumSignalPropagationModel.ConvergenceAlgorithm convAlgo) Constructor of the signal propagation model.
VacuumSignalPropagationModel(Frame frame, double threshold, VacuumSignalPropagationModel.ConvergenceAlgorithm convAlgo, double maxIterIn) Constructor of the signal propagation model.
VacuumSignalPropagationModel(Frame frame, VacuumSignalPropagationModel.ConvergenceAlgorithm convAlgo) Constructor of the signal propagation model.

Method Summary

Modifier and Type	Method and Description
VacuumSignalPropagation	computeSignalPropagation(PVCoordinatesProvider emitter, PVCoordinatesProvider receiver, AbsoluteDate date, VacuumSignalPropagationModel.FixedDate fixedDateType) Computes the signal propagation object in the void at a particular date
static AbsoluteDate	getSignalEmissionDate(PVCoordinatesProvider emitter, PVCoordinatesProvider orbit, AbsoluteDate date, double epsilon, AbstractDetector.PropagationDelayType propagationDelayType, Frame inertialFrame) Compute signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractDetector.PropagationDelayType.
static AbsoluteDate	getSignalEmissionDate(PVCoordinatesProvider emitter, PVCoordinatesProvider orbit, AbsoluteDate date, double epsilon, AbstractDetector.PropagationDelayType propagationDelayType, Frame inertialFrame, int maxIterSignalPropagation) Compute signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractDetector.PropagationDelayType.
static AbsoluteDate	getSignalReceptionDate(PVCoordinatesProvider receiver, PVCoordinatesProvider orbit, AbsoluteDate date, double epsilon, AbstractDetector.PropagationDelayType propagationDelayType, Frame inertialFrame) Compute signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractDetector.PropagationDelayType.
static AbsoluteDate	getSignalReceptionDate(PVCoordinatesProvider receiver, PVCoordinatesProvider orbit, AbsoluteDate date, double epsilon, AbstractDetector.PropagationDelayType propagationDelayType, Frame inertialFrame, int maxIterSignalPropagation) Compute signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractDetector.PropagationDelayType.
double	getSignalTropoCorrection(TroposphericCorrection correction, VacuumSignalPropagation signal, TopocentricFrame topo) Deprecated. prefer using TroposphericCorrection with AzimuthElevationCalculator.getElevation(Vector3D) instead.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_ITER

public static final int DEFAULT_MAX_ITER

Default max number of iterations for signal propagation computation.

See Also:

Constant Field Values

DEFAULT_EPSILON

public static final double DEFAULT_EPSILON

Default epsilon (s) for signal propagation computation.

See Also:

Constant Field Values

Constructor Detail

VacuumSignalPropagationModel

public VacuumSignalPropagationModel(Frame frame)

Constructor of the signal propagation model.

By default, this model will use the NEWTON convergence algorithm.

Parameters:

frame - the work frame : must be inertial

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

VacuumSignalPropagationModel

public VacuumSignalPropagationModel(Frame frame,
                                    double threshold)

Constructor of the signal propagation model.

By default, this model will use the NEWTON convergence algorithm.

Parameters:

frame - the work frame : must be inertial

threshold - the iterative computation algorithm convergence threshold: propagation time precision required

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

VacuumSignalPropagationModel

public VacuumSignalPropagationModel(Frame frame,
                                    VacuumSignalPropagationModel.ConvergenceAlgorithm convAlgo)

Constructor of the signal propagation model.

Parameters:

frame - the work frame : must be inertial and invariant over time

convAlgo - the convergence algorithm

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

VacuumSignalPropagationModel

public VacuumSignalPropagationModel(Frame frame,
                                    double threshold,
                                    double maxIter)

Constructor of the signal propagation model.

By default, this model will use the NEWTON convergence algorithm.

Parameters:

frame - the work frame : must be inertial

threshold - the iterative computation algorithm convergence threshold: propagation time precision required

maxIter - the maximum number of iterations for signal propagation computation

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

VacuumSignalPropagationModel

public VacuumSignalPropagationModel(Frame frame,
                                    double threshold,
                                    VacuumSignalPropagationModel.ConvergenceAlgorithm convAlgo)

Constructor of the signal propagation model.

Parameters:

frame - the work frame : must be inertial and invariant over time

threshold - the iterative computation algorithm convergence threshold: propagation time precision required

convAlgo - the convergence algorithm

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

VacuumSignalPropagationModel

public VacuumSignalPropagationModel(Frame frame,
                                    double threshold,
                                    VacuumSignalPropagationModel.ConvergenceAlgorithm convAlgo,
                                    double maxIterIn)

Constructor of the signal propagation model.

Parameters:

frame - the work frame : must be inertial and invariant over time

threshold - the iterative computation algorithm convergence threshold: propagation time precision required

convAlgo - the convergence algorithm

maxIterIn - the maximum number of iterations for signal propagation computation

Throws:

IllegalArgumentException - if the provided frame is not pseudo-inertial

Method Detail

computeSignalPropagation

public final VacuumSignalPropagation computeSignalPropagation(PVCoordinatesProvider emitter,
                                                              PVCoordinatesProvider receiver,
                                                              AbsoluteDate date,
                                                              VacuumSignalPropagationModel.FixedDate fixedDateType)
                                                       throws PatriusException

Computes the signal propagation object in the void at a particular date

Parameters:

emitter - the PVCoordinatesProvider of the emitter object

receiver - the PVCoordinatesProvider of the receiver object

date - the emission or reception date

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

Returns:

the signal propagation object

Throws:

PatriusException - if a problem occurs during PVCoodinates providers manipulations

getSignalTropoCorrection

@Deprecated
public double getSignalTropoCorrection(TroposphericCorrection correction,
                                                   VacuumSignalPropagation signal,
                                                   TopocentricFrame topo)
                                            throws PatriusException

Deprecated. prefer using TroposphericCorrection with AzimuthElevationCalculator.getElevation(Vector3D) instead.

Computes the tropospheric effects corrections to be applied to a given VacuumSignalPropagation object.

Parameters:

correction - the tropospheric correction model

signal - the signal to correct

topo - the ground antenna topocentric frame

Returns:

the signal delay correction [s]

Throws:

PatriusException - if frame transformation problem occurs

getSignalEmissionDate

public static AbsoluteDate getSignalEmissionDate(PVCoordinatesProvider emitter,
                                                 PVCoordinatesProvider orbit,
                                                 AbsoluteDate date,
                                                 double epsilon,
                                                 AbstractDetector.PropagationDelayType propagationDelayType,
                                                 Frame inertialFrame)
                                          throws PatriusException

Compute signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractDetector.PropagationDelayType.

Parameters:

emitter - emitter

orbit - orbit of the spacecraft (receiver)

date - date at which the spacecraft orbit is defined

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

propagationDelayType - propagation delay type

inertialFrame - inertial frame

Returns:

signal emission date

Throws:

PatriusException - thrown if computation failed

getSignalEmissionDate

public static AbsoluteDate getSignalEmissionDate(PVCoordinatesProvider emitter,
                                                 PVCoordinatesProvider orbit,
                                                 AbsoluteDate date,
                                                 double epsilon,
                                                 AbstractDetector.PropagationDelayType propagationDelayType,
                                                 Frame inertialFrame,
                                                 int maxIterSignalPropagation)
                                          throws PatriusException

Compute signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractDetector.PropagationDelayType.

Parameters:

emitter - emitter

orbit - orbit of the spacecraft (receiver)

date - date at which the spacecraft orbit is defined

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

propagationDelayType - propagation delay type

inertialFrame - inertial frame

maxIterSignalPropagation - maximum number of iterations for signal propagation computation

Returns:

signal emission date

Throws:

PatriusException - thrown if computation failed

getSignalReceptionDate

public static AbsoluteDate getSignalReceptionDate(PVCoordinatesProvider receiver,
                                                  PVCoordinatesProvider orbit,
                                                  AbsoluteDate date,
                                                  double epsilon,
                                                  AbstractDetector.PropagationDelayType propagationDelayType,
                                                  Frame inertialFrame)
                                           throws PatriusException

Compute signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractDetector.PropagationDelayType.

Parameters:

receiver - receiver

orbit - orbit of the spacecraft (emitter)

date - date at which the spacecraft orbit is defined

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

propagationDelayType - propagation delay type

inertialFrame - inertial frame

Returns:

signal reception date

Throws:

PatriusException - thrown if computation failed

getSignalReceptionDate

public static AbsoluteDate getSignalReceptionDate(PVCoordinatesProvider receiver,
                                                  PVCoordinatesProvider orbit,
                                                  AbsoluteDate date,
                                                  double epsilon,
                                                  AbstractDetector.PropagationDelayType propagationDelayType,
                                                  Frame inertialFrame,
                                                  int maxIterSignalPropagation)
                                           throws PatriusException

Compute signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractDetector.PropagationDelayType.

Parameters:

receiver - receiver

orbit - orbit of the spacecraft (emitter)

date - date at which the spacecraft orbit is defined

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

propagationDelayType - propagation delay type

inertialFrame - inertial frame

maxIterSignalPropagation - maximum number of iterations for signal propagation computation

Returns:

signal reception date

Throws:

PatriusException - thrown if computation failed