Package org.orekit.models.earth.ionosphere

Interface IonosphericModel

All Superinterfaces:

ParameterDriversProvider

All Known Implementing Classes:

AbstractIonosphericModel, EstimatedIonosphericModel, GlobalIonosphereMapModel, KlobucharIonoModel, NeQuickGalileo, NeQuickItu, NeQuickModel, SsrVtecIonosphericModel

public interface IonosphericModel
extends ParameterDriversProvider

Defines a ionospheric model, used to calculate the path delay imposed to electro-magnetic signals between an orbital satellite and a ground station.

Since 10.0, this interface can be used for models that aspire to estimate ionospheric parameters.

Since:

13.0.3

Author:

Joris Olympio, Bryan Cazabonne, Luc Maisonobe, Brianna Aubin

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IonosphericModel.DelayCalculator	Lambda header for calculating the path delay.
static interface	IonosphericModel.FieldDelayCalculator<T extends CalculusFieldElement<T>>	Lambda header for calculating the path delay.

Method Summary

Modifier and Type	Method	Description
OneAxisEllipsoid	getEarth()	Get the earth body shape for earth-frame calculations.
<T extends CalculusFieldElement<T>> T	pathDelay(FieldVector3D<T> localP1, FieldVector3D<T> localP2, TopocentricFrame baseFrame, FieldAbsoluteDate<T> receptionDate, double frequency, T[] parameters)	Calculates the ionospheric path delay for the signal path from a ground station to an observing object (ground station or satellite).
double	pathDelay(Vector3D localP1, Vector3D localP2, TopocentricFrame baseFrame, AbsoluteDate receptionDate, double frequency, double[] parameters)	Calculates the ionospheric path delay for the signal path from a ground station to an observing object (ground station or satellite).
default <T extends CalculusFieldElement<T>> T	pathDelay(FieldSpacecraftState<T> state, PVCoordinatesProvider coordsProvider, double frequency, T[] parameters)	Calculates the ionospheric path delay for the signal path from an observation object to the satellite being measured.
default double	pathDelay(SpacecraftState state, PVCoordinatesProvider coordsProvider, double frequency, double[] parameters)	Calculates the ionospheric path delay for the signal path from an observation object to the satellite being measured.

Methods inherited from interface org.orekit.utils.ParameterDriversProvider

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

Method Detail

getEarth

OneAxisEllipsoid getEarth()

Get the earth body shape for earth-frame calculations.

Returns:

earth body shape

Since:

14.0

pathDelay

default double pathDelay(SpacecraftState state,
                         PVCoordinatesProvider coordsProvider,
                         double frequency,
                         double[] parameters)

Calculates the ionospheric path delay for the signal path from an observation object to the satellite being measured.

This method is intended to be used for orbit determination issues. In that respect, if the elevation is below 0° the path delay will be equal to zero.

For individual use of the ionospheric model (i.e. not for orbit determination), another method signature can be implemented to compute the path delay for any elevation angle.

Parameters:

state - spacecraft state

coordsProvider - coordinates provider for the observing object

frequency - frequency of the signal in Hz

parameters - ionospheric model parameters at state date

Returns:

the path delay due to the ionosphere in m

pathDelay

double pathDelay(Vector3D localP1,
                 Vector3D localP2,
                 TopocentricFrame baseFrame,
                 AbsoluteDate receptionDate,
                 double frequency,
                 double[] parameters)

Calculates the ionospheric path delay for the signal path from a ground station to an observing object (ground station or satellite).

This method is intended to be used for orbit determination issues. In that respect, if the elevation is below 0° the path delay will be equal to zero.

For individual use of the ionospheric model (i.e. not for orbit determination), another method signature can be implemented to compute the path delay for any elevation angle.

Parameters:

localP1 - position of path start point in baseFrame

localP2 - position of path end point in baseFrame

baseFrame - topocentric frame of point with lowest altitude between p1 and p2

receptionDate - date at signal reception

frequency - frequency of the signal in Hz

parameters - ionospheric model parameters at state date

Returns:

the path delay due to the ionosphere in m

pathDelay

default <T extends CalculusFieldElement<T>> T pathDelay(FieldSpacecraftState<T> state,
                                                        PVCoordinatesProvider coordsProvider,
                                                        double frequency,
                                                        T[] parameters)

Calculates the ionospheric path delay for the signal path from an observation object to the satellite being measured.

This method is intended to be used for orbit determination issues. In that respect, if the elevation is below 0° the path delay will be equal to zero.

For individual use of the ionospheric model (i.e. not for orbit determination), another method signature can be implemented to compute the path delay for any elevation angle.

Type Parameters:

T - type of the elements

Parameters:

state - spacecraft state

coordsProvider - coordinates provider for the observing object

frequency - frequency of the signal in Hz

parameters - ionospheric model parameters at state date

Returns:

the path delay due to the ionosphere in m

pathDelay

<T extends CalculusFieldElement<T>> T pathDelay(FieldVector3D<T> localP1,
                                                FieldVector3D<T> localP2,
                                                TopocentricFrame baseFrame,
                                                FieldAbsoluteDate<T> receptionDate,
                                                double frequency,
                                                T[] parameters)

Calculates the ionospheric path delay for the signal path from a ground station to an observing object (ground station or satellite).

This method is intended to be used for orbit determination issues. In that respect, if the elevation is below 0° the path delay will be equal to zero.

For individual use of the ionospheric model (i.e. not for orbit determination), another method signature can be implemented to compute the path delay for any elevation angle.

Type Parameters:

T - type of the elements

Parameters:

localP1 - position of path start point in baseFrame

localP2 - position of path end point in baseFrame

baseFrame - topocentric frame of point with lowest altitude between p1 and p2

receptionDate - date at signal reception

frequency - frequency of the signal in Hz

parameters - ionospheric model parameters at state date

Returns:

the path delay due to the ionosphere in m