Class TimeSpanEstimatedModel
- java.lang.Object
-
- org.orekit.models.earth.troposphere.TimeSpanEstimatedModel
-
- All Implemented Interfaces:
TroposphericModel
,ParameterDriversProvider
public class TimeSpanEstimatedModel extends Object implements TroposphericModel
Time span estimated tropospheric model.This class is closely related to
EstimatedModel
class.
The difference is that it has aTimeSpanMap
ofEstimatedModel
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 TimeSpanEstimatedModel(EstimatedModel model)
Constructor with default UTC time scale.TimeSpanEstimatedModel(EstimatedModel model, TimeScale timeScale)
Constructor with default UTC time scale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addTroposphericModelValidAfter(EstimatedModel model, AbsoluteDate earliestValidityDate)
Add a EstimatedTroposphericModel entry valid after a limit date.
UsingaddTroposphericModelValidAfter(entry, t)
will makeentry
valid in [t, +∞[ (note the closed bracket).void
addTroposphericModelValidBefore(EstimatedModel model, AbsoluteDate latestValidityDate)
Add an EstimatedTroposphericModel entry valid before a limit date.
UsingaddTroposphericValidBefore(entry, t)
will makeentry
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 thepathDelay
method.<T extends CalculusFieldElement<T>>
T[]extractParameters(T[] parameters, FieldAbsoluteDate<T> date)
Extract the proper parameter drivers' values from the array in input of thepathDelay
method.TimeSpanMap.Span<EstimatedModel>
getFirstSpan()
Get the firsttime span
of the tropospheric model time span map.List<ParameterDriver>
getParametersDrivers()
Get the drivers for parameters.EstimatedModel
getTroposphericModel(AbsoluteDate date)
Get theEstimatedModel
model valid at a date.<T extends CalculusFieldElement<T>>
FieldTroposphericDelay<T>pathDelay(FieldTrackingCoordinates<T> trackingCoordinates, FieldGeodeticPoint<T> point, FieldPressureTemperatureHumidity<T> weather, T[] parameters, FieldAbsoluteDate<T> date)
Calculates the tropospheric path delay for the signal path from a ground station to a satellite.TroposphericDelay
pathDelay(TrackingCoordinates trackingCoordinates, GeodeticPoint point, PressureTemperatureHumidity weather, double[] parameters, AbsoluteDate 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
-
TimeSpanEstimatedModel
@DefaultDataContext public TimeSpanEstimatedModel(EstimatedModel model)
Constructor with default UTC time scale.- Parameters:
model
- the initial model which going to be used for all the models initialization.
-
TimeSpanEstimatedModel
public TimeSpanEstimatedModel(EstimatedModel 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 interfaceParameterDriversProvider
- Returns:
- drivers for parameters
-
addTroposphericModelValidBefore
public void addTroposphericModelValidBefore(EstimatedModel model, AbsoluteDate latestValidityDate)
Add an EstimatedTroposphericModel entry valid before a limit date.
UsingaddTroposphericValidBefore(entry, t)
will makeentry
valid in ]-∞, t[ (note the open bracket).- Parameters:
model
- EstimatedTroposphericModel entrylatestValidityDate
- date before which the entry is valid (must be different from all dates already used for transitions)
-
addTroposphericModelValidAfter
public void addTroposphericModelValidAfter(EstimatedModel model, AbsoluteDate earliestValidityDate)
Add a EstimatedTroposphericModel entry valid after a limit date.
UsingaddTroposphericModelValidAfter(entry, t)
will makeentry
valid in [t, +∞[ (note the closed bracket).- Parameters:
model
- EstimatedTroposphericModel entryearliestValidityDate
- date after which the entry is valid (must be different from all dates already used for transitions)
-
getTroposphericModel
public EstimatedModel getTroposphericModel(AbsoluteDate date)
Get theEstimatedModel
model valid at a date.- Parameters:
date
- the date of validity- Returns:
- the EstimatedTroposphericModel model valid at date
-
getFirstSpan
public TimeSpanMap.Span<EstimatedModel> getFirstSpan()
Get the firsttime 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 thepathDelay
method. Parameters are filtered given an input date.- Parameters:
parameters
- the input parameters arraydate
- 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 thepathDelay
method. Parameters are filtered given an input date.- Type Parameters:
T
- extends CalculusFieldElements- Parameters:
parameters
- the input parameters arraydate
- the date- Returns:
- the parameters given the date
-
pathDelay
public TroposphericDelay pathDelay(TrackingCoordinates trackingCoordinates, GeodeticPoint point, PressureTemperatureHumidity weather, double[] parameters, AbsoluteDate date)
Calculates the tropospheric path delay for the signal path from a ground station to a satellite.- Specified by:
pathDelay
in interfaceTroposphericModel
- Parameters:
trackingCoordinates
- tracking coordinates of the satellitepoint
- station locationweather
- weather parametersparameters
- tropospheric model parametersdate
- current date- Returns:
- the path delay due to the troposphere
-
pathDelay
public <T extends CalculusFieldElement<T>> FieldTroposphericDelay<T> pathDelay(FieldTrackingCoordinates<T> trackingCoordinates, FieldGeodeticPoint<T> point, FieldPressureTemperatureHumidity<T> weather, 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 interfaceTroposphericModel
- Type Parameters:
T
- type of the elements- Parameters:
trackingCoordinates
- tracking coordinates of the satellitepoint
- station locationweather
- weather parametersparameters
- tropospheric model parameters at current datedate
- current date- Returns:
- the path delay due to the troposphere
-
-