Package org.orekit.models.earth.troposphere

Class TimeSpanEstimatedTroposphericModel

java.lang.Object

org.orekit.models.earth.troposphere.TimeSpanEstimatedTroposphericModel

All Implemented Interfaces:

DiscreteTroposphericModel, ParameterDriversProvider

public class TimeSpanEstimatedTroposphericModel
extends Object
implements DiscreteTroposphericModel

Time span estimated tropospheric model.

This class is closely related to EstimatedTroposphericModel class.
The difference is that it has a TimeSpanMap of EstimatedTroposphericModel objects as attribute.
The idea behind this model is to allow the user to design a tropospheric model that can see its physical parameters (total zenith delay) change with time, at dates chosen by the user.

Since:

10.2

Author:

Bryan Cazabonne

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATE_AFTER	Prefix for dates after in the tropospheric parameter drivers' name.
static String	DATE_BEFORE	Prefix for dates before in the tropospheric parameter drivers' name.

Constructor Summary

Constructors

Constructor	Description
TimeSpanEstimatedTroposphericModel(EstimatedTroposphericModel model)	Constructor with default UTC time scale.
TimeSpanEstimatedTroposphericModel(EstimatedTroposphericModel model, TimeScale timeScale)	Constructor with default UTC time scale.

Method Summary

Modifier and Type	Method	Description
void	addTroposphericModelValidAfter(EstimatedTroposphericModel model, AbsoluteDate earliestValidityDate)	Add a EstimatedTroposphericModel entry valid after a limit date. Using addTroposphericModelValidAfter(entry, t) will make entry valid in [t, +∞[ (note the closed bracket).
void	addTroposphericModelValidBefore(EstimatedTroposphericModel model, AbsoluteDate latestValidityDate)	Add an EstimatedTroposphericModel entry valid before a limit date. Using addTroposphericValidBefore(entry, t) will make entry valid in ]-∞, t[ (note the open bracket).
double[]	extractParameters(double[] parameters, AbsoluteDate date)	Extract the proper parameter drivers' values from the array in input of the pathDelay method.
<T extends CalculusFieldElement<T>> T[]	extractParameters(T[] parameters, FieldAbsoluteDate<T> date)	Extract the proper parameter drivers' values from the array in input of the pathDelay method.
TimeSpanMap.Span<EstimatedTroposphericModel>	getFirstSpan()	Get the first time span of the tropospheric model time span map.
List<ParameterDriver>	getParametersDrivers()	Get the drivers for parameters.
EstimatedTroposphericModel	getTroposphericModel(AbsoluteDate date)	Get the EstimatedTroposphericModel model valid at a date.
double	pathDelay(double elevation, GeodeticPoint point, double[] parameters, AbsoluteDate date)	Calculates the tropospheric path delay for the signal path from a ground station to a satellite.
<T extends CalculusFieldElement<T>> T	pathDelay(T elevation, FieldGeodeticPoint<T> point, T[] parameters, FieldAbsoluteDate<T> date)	Calculates the tropospheric path delay for the signal path from a ground station to a satellite.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.utils.ParameterDriversProvider

getNbParametersDriversValue, getParameterDriver, getParameters, getParameters, getParameters, getParameters, getParametersAllValues, getParametersAllValues, isSupported

Field Detail

DATE_BEFORE

public static final String DATE_BEFORE

Prefix for dates before in the tropospheric parameter drivers' name.

See Also:

Constant Field Values

DATE_AFTER

public static final String DATE_AFTER

Prefix for dates after in the tropospheric parameter drivers' name.

See Also:

Constant Field Values

Constructor Detail

TimeSpanEstimatedTroposphericModel

@DefaultDataContext
public TimeSpanEstimatedTroposphericModel(EstimatedTroposphericModel model)

Constructor with default UTC time scale.

Parameters:

model - the initial model which going to be used for all the models initialization.

TimeSpanEstimatedTroposphericModel

public TimeSpanEstimatedTroposphericModel(EstimatedTroposphericModel model,
                                          TimeScale timeScale)

Constructor with default UTC time scale.

Parameters:

model - the initial model which going to be used for all the models initialization.

timeScale - timeScale Time scale used for the default names of the tropospheric parameter drivers

Method Detail

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Get the drivers for parameters.

All the parameter drivers of all Estimated models are returned in an array. Models are ordered chronologically.

Specified by:

getParametersDrivers in interface ParameterDriversProvider

Returns:

drivers for parameters

addTroposphericModelValidBefore

public void addTroposphericModelValidBefore(EstimatedTroposphericModel model,
                                            AbsoluteDate latestValidityDate)

Add an EstimatedTroposphericModel entry valid before a limit date.
Using addTroposphericValidBefore(entry, t) will make entry valid in ]-∞, t[ (note the open bracket).

Parameters:

model - EstimatedTroposphericModel entry

latestValidityDate - date before which the entry is valid (must be different from all dates already used for transitions)

addTroposphericModelValidAfter

public void addTroposphericModelValidAfter(EstimatedTroposphericModel model,
                                           AbsoluteDate earliestValidityDate)

Add a EstimatedTroposphericModel entry valid after a limit date.
Using addTroposphericModelValidAfter(entry, t) will make entry valid in [t, +∞[ (note the closed bracket).

Parameters:

model - EstimatedTroposphericModel entry

earliestValidityDate - date after which the entry is valid (must be different from all dates already used for transitions)

getTroposphericModel

public EstimatedTroposphericModel getTroposphericModel(AbsoluteDate date)

Get the EstimatedTroposphericModel model valid at a date.

Parameters:

date - the date of validity

Returns:

the EstimatedTroposphericModel model valid at date

getFirstSpan

public TimeSpanMap.Span<EstimatedTroposphericModel> getFirstSpan()

Get the first time span of the tropospheric model time span map.

Returns:

the first time span of the tropospheric model time span map

Since:

11.1

extractParameters

public double[] extractParameters(double[] parameters,
                                  AbsoluteDate date)

Extract the proper parameter drivers' values from the array in input of the pathDelay method. Parameters are filtered given an input date.

Parameters:

parameters - the input parameters array

date - the date

Returns:

the parameters given the date

extractParameters

public <T extends CalculusFieldElement<T>> T[] extractParameters(T[] parameters,
                                                                 FieldAbsoluteDate<T> date)

Extract the proper parameter drivers' values from the array in input of the pathDelay method. Parameters are filtered given an input date.

Type Parameters:

T - extends CalculusFieldElements

Parameters:

parameters - the input parameters array

date - the date

Returns:

the parameters given the date

pathDelay

public double pathDelay(double elevation,
                        GeodeticPoint point,
                        double[] parameters,
                        AbsoluteDate date)

Calculates the tropospheric path delay for the signal path from a ground station to a satellite.

Specified by:

pathDelay in interface DiscreteTroposphericModel

Parameters:

elevation - the elevation of the satellite, in radians

point - station location

parameters - tropospheric model parameters

date - current date

Returns:

the path delay due to the troposphere in m

pathDelay

public <T extends CalculusFieldElement<T>> T pathDelay(T elevation,
                                                       FieldGeodeticPoint<T> point,
                                                       T[] parameters,
                                                       FieldAbsoluteDate<T> date)

Calculates the tropospheric path delay for the signal path from a ground station to a satellite.

Specified by:

pathDelay in interface DiscreteTroposphericModel

Type Parameters:

T - type of the elements

Parameters:

elevation - the elevation of the satellite, in radians

point - station location

parameters - tropospheric model parameters at current date

date - current date

Returns:

the path delay due to the troposphere in m