Package org.orekit.models.earth.ionosphere

Class AbstractIonosphericModel

java.lang.Object

org.orekit.models.earth.ionosphere.AbstractIonosphericModel

All Implemented Interfaces:

IonosphericModel, ParameterDriversProvider

Direct Known Subclasses:

EstimatedIonosphericModel, GlobalIonosphereMapModel, KlobucharIonoModel, NeQuickModel, SsrVtecIonosphericModel

public abstract class AbstractIonosphericModel
extends Object
implements IonosphericModel

Abstract ionospheric model parent class.

Defines an abstract IonosphericModel parent class to hold the earth model, which is used in calculating path delay.

Since:

14.0

Author:

Brianna Aubin

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.models.earth.ionosphere.IonosphericModel

IonosphericModel.DelayCalculator, IonosphericModel.FieldDelayCalculator<T extends CalculusFieldElement<T>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIonosphericModel(OneAxisEllipsoid earth)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
protected <T extends CalculusFieldElement<T>> Boolean	checkIfPathIsValid(FieldVector3D<T> position, FieldVector3D<T> p1, FieldVector3D<T> p2, Double baseAltitude)	Checks to see if it is valid to calculate the ionospheric path delay for a position endpoint value w.r.t. the minimum altitude point between two given objects (whether they are space or ground based).
protected Boolean	checkIfPathIsValid(Vector3D position, Vector3D p1, Vector3D p2, Double baseAltitude)	Checks to see if it is valid to calculate the ionospheric path delay for a position endpoint value w.r.t. the minimum altitude point between two given objects (whether they are space or ground based).
OneAxisEllipsoid	getEarth()	Get the earth body shape for earth-frame calculations.

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.ionosphere.IonosphericModel

pathDelay, pathDelay, pathDelay, pathDelay

Methods inherited from interface org.orekit.utils.ParameterDriversProvider

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

Constructor Detail

AbstractIonosphericModel

protected AbstractIonosphericModel(OneAxisEllipsoid earth)

Simple constructor.

Parameters:

earth - elliptic earth body

Since:

14.0

Method Detail

getEarth

public final OneAxisEllipsoid getEarth()

Get the earth body shape for earth-frame calculations.

Specified by:

getEarth in interface IonosphericModel

Returns:

earth body shape

Since:

14.0

checkIfPathIsValid

protected final Boolean checkIfPathIsValid(Vector3D position,
                                           Vector3D p1,
                                           Vector3D p2,
                                           Double baseAltitude)

Checks to see if it is valid to calculate the ionospheric path delay for a position endpoint value w.r.t. the minimum altitude point between two given objects (whether they are space or ground based).

Parameters:

position - position of object value being considered (one of the two endpoints)

p1 - position of first endpoint in the link

p2 - position of second endpoint in the link

baseAltitude - altitude of the groundpoint that represents the minimum altitude value on the path between p1 and p2

Returns:

True if the path delay needs to be calculated

checkIfPathIsValid

protected final <T extends CalculusFieldElement<T>> Boolean checkIfPathIsValid(FieldVector3D<T> position,
                                                                               FieldVector3D<T> p1,
                                                                               FieldVector3D<T> p2,
                                                                               Double baseAltitude)

Checks to see if it is valid to calculate the ionospheric path delay for a position endpoint value w.r.t. the minimum altitude point between two given objects (whether they are space or ground based).

Type Parameters:

T - type of the elements

Parameters:

position - position of object value being considered (one of the two endpoints)

p1 - position of first endpoint in the link

p2 - position of second endpoint in the link

baseAltitude - altitude of the groundpoint that represents the minimum altitude value on the path between p1 and p2

Returns:

True if the path delay needs to be calculated