org.orekit.models.earth.troposphere

Class NiellMappingFunctionModel

java.lang.Object

org.orekit.models.earth.troposphere.NiellMappingFunctionModel

All Implemented Interfaces:

MappingFunction

public class NiellMappingFunctionModel
extends Object
implements MappingFunction

The Niell Mapping Function model for radio wavelengths. This model is an empirical mapping function. It only needs the values of the station latitude, height and the date for the computations.

With this model, the hydrostatic mapping function is time and latitude dependent whereas the wet mapping function is only latitude dependent.

Author:

Bryan Cazabonne

See Also:

"A. E. Niell(1996), Global mapping functions for the atmosphere delay of radio wavelengths, J. Geophys. Res., 101(B2), pp. 3227–3246, doi: 10.1029/95JB03048."

Constructor Summary

Constructors

Constructor and Description
NiellMappingFunctionModel(double latitude) Builds a new instance.
NiellMappingFunctionModel(double latitude, TimeScale utc) Builds a new instance.

Method Summary

Modifier and Type	Method and Description
List<ParameterDriver>	getParametersDrivers() Get the drivers for tropospheric model parameters.
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.

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

Constructor Detail

NiellMappingFunctionModel

@DefaultDataContext
public NiellMappingFunctionModel(double latitude)

Builds a new instance.

This constructor uses the default data context.

Parameters:

latitude - geodetic latitude of the station, in radians

See Also:

NiellMappingFunctionModel(double, TimeScale)

NiellMappingFunctionModel

public NiellMappingFunctionModel(double latitude,
                                 TimeScale utc)

Builds a new instance.

Parameters:

latitude - geodetic latitude of the station, in radians

utc - UTC time scale.

Since:

10.1

Method Detail

mappingFactors

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

Description copied from interface: MappingFunction

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)

Description copied from interface: MappingFunction

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.

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Description copied from interface: MappingFunction

Get the drivers for tropospheric model parameters.

Specified by:

getParametersDrivers in interface MappingFunction

Returns:

drivers for tropospheric model parameters