org.orekit.models.earth.troposphere

Class TimeSpanEstimatedTroposphericModel

java.lang.Object

org.orekit.models.earth.troposphere.TimeSpanEstimatedTroposphericModel

All Implemented Interfaces:

DiscreteTroposphericModel, MappingFunction

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 and 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 and 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 and 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[]	computeZenithDelay(double height, double[] parameters, AbsoluteDate date) This method allows the computation of the zenith hydrostatic and zenith wet delay.
<T extends RealFieldElement<T>> T[]	computeZenithDelay(T height, T[] parameters, FieldAbsoluteDate<T> date) This method allows the computation of the zenith hydrostatic and zenith wet delay.
double[]	extractParameters(double[] parameters, AbsoluteDate date) Extract the proper parameter drivers' values from the array in input of the pathDelay method.
<T extends RealFieldElement<T>> T[]	extractParameters(T[] parameters, FieldAbsoluteDate<T> date) Extract the proper parameter drivers' values from the array in input of the pathDelay method.
List<ParameterDriver>	getParametersDrivers() Get the drivers for tropospheric model parameters.
NavigableSet<TimeSpanMap.Transition<EstimatedTroposphericModel>>	getTransitions() Get the TimeSpanMap.Transitions of the tropospheric model time span map.
EstimatedTroposphericModel	getTroposphericModel(AbsoluteDate date) Get the EstimatedTroposphericModel model valid at a date.
double[]	mappingFactors(double elevation, double height, double[] parameters, AbsoluteDate date) This method allows the computation of the hydrostatic and wet mapping functions.
<T extends RealFieldElement<T>> T[]	mappingFactors(T elevation, T height, T[] parameters, FieldAbsoluteDate<T> date) This method allows the computation of the hydrostatic and wet mapping functions.
double	pathDelay(double elevation, double height, double[] parameters, AbsoluteDate date) Calculates the tropospheric path delay for the signal path from a ground station to a satellite.
<T extends RealFieldElement<T>> T	pathDelay(T elevation, T height, 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.models.earth.troposphere.MappingFunction

getParameters, getParameters

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 tropospheric model parameters.

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

Specified by:

getParametersDrivers in interface MappingFunction

Returns:

drivers for tropospheric model 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

getTransitions

public NavigableSet<TimeSpanMap.Transition<EstimatedTroposphericModel>> getTransitions()

Get the TimeSpanMap.Transitions of the tropospheric model time span map.

Returns:

the TimeSpanMap.Transitions for the tropospheric model time span map

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 RealFieldElement<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 RealFieldElements

Parameters:

parameters - the input parameters array

date - the date

Returns:

the parameters given the date

mappingFactors

public double[] mappingFactors(double elevation,
                               double height,
                               double[] parameters,
                               AbsoluteDate date)

This method allows the computation of the hydrostatic and wet mapping functions. The resulting element is an array having the following form:

• double[0] = m_h(e) → hydrostatic mapping function
• double[1] = m_w(e) → wet mapping function

Specified by:

mappingFactors in interface MappingFunction

Parameters:

elevation - the elevation of the satellite, in radians.

height - the height of the station in m above sea level.

parameters - tropospheric model parameters.

date - current date

Returns:

a two components array containing the hydrostatic and wet mapping functions.

mappingFactors

public <T extends RealFieldElement<T>> T[] mappingFactors(T elevation,
                                                          T height,
                                                          T[] parameters,
                                                          FieldAbsoluteDate<T> date)

This method allows the computation of the hydrostatic and wet mapping functions. The resulting element is an array having the following form:

• T[0] = m_h(e) → hydrostatic mapping function
• T[1] = m_w(e) → wet mapping function

Specified by:

mappingFactors in interface MappingFunction

Type Parameters:

T - type of the elements

Parameters:

elevation - the elevation of the satellite, in radians.

height - the height of the station in m above sea level.

parameters - tropospheric model parameters.

date - current date

Returns:

a two components array containing the hydrostatic and wet mapping functions.

pathDelay

public double pathDelay(double elevation,
                        double height,
                        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

height - the height of the station in m above sea level

parameters - tropospheric model parameters.

date - current date

Returns:

the path delay due to the troposphere in m

pathDelay

public <T extends RealFieldElement<T>> T pathDelay(T elevation,
                                                   T height,
                                                   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

height - the height of the station in m above sea level

parameters - tropospheric model parameters.

date - current date

Returns:

the path delay due to the troposphere in m

computeZenithDelay

public double[] computeZenithDelay(double height,
                                   double[] parameters,
                                   AbsoluteDate date)

This method allows the computation of the zenith hydrostatic and zenith wet delay. The resulting element is an array having the following form:

• double[0] = D_hz → zenith hydrostatic delay
• double[1] = D_wz → zenith wet delay

Specified by:

computeZenithDelay in interface DiscreteTroposphericModel

Parameters:

height - the height of the station in m above sea level.

parameters - tropospheric model parameters.

date - current date

Returns:

a two components array containing the zenith hydrostatic and wet delays.

computeZenithDelay

public <T extends RealFieldElement<T>> T[] computeZenithDelay(T height,
                                                              T[] parameters,
                                                              FieldAbsoluteDate<T> date)

This method allows the computation of the zenith hydrostatic and zenith wet delay. The resulting element is an array having the following form:

• T[0] = D_hz → zenith hydrostatic delay
• T[1] = D_wz → zenith wet delay

Specified by:

computeZenithDelay in interface DiscreteTroposphericModel

Type Parameters:

T - type of the elements

Parameters:

height - the height of the station in m above sea level.

parameters - tropospheric model parameters.

date - current date

Returns:

a two components array containing the zenith hydrostatic and wet delays.