Class AbstractElevationCrossingFunction
java.lang.Object
org.orekit.propagation.events.functions.AbstractTopocentricEventFunction
org.orekit.propagation.events.functions.AbstractElevationCrossingFunction
- All Implemented Interfaces:
EventFunction
- Direct Known Subclasses:
ElevationValueCrossingFunction,MaskedElevationEventFunction
Abstract class for elevation crossing event function.
It is negative when under the necessary elevation.
- Since:
- 14.0
- Author:
- Romain Serra
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractElevationCrossingFunction(AtmosphericRefractionModel refractionModel, TopocentricFrame topo) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected doubleapplyRefraction(double elevation) Apply refraction correction if applicable.protected <T extends CalculusFieldElement<T>>
TapplyRefraction(T elevation) Apply refraction correction if applicable (Field version).protected <T extends CalculusFieldElement<T>>
TgetElevation(FieldVector3D<T> topocentricPosition, FieldAbsoluteDate<T> date) Compute elevation.protected doublegetElevation(Vector3D topocentricPosition, AbsoluteDate date) Compute elevation.Returns the currently configured refraction model.Methods inherited from class org.orekit.propagation.events.functions.AbstractTopocentricEventFunction
getTopocentricFrameMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.orekit.propagation.events.functions.EventFunction
dependsOnMainVariablesOnly, dependsOnTimeOnly, value, value
-
Constructor Details
-
AbstractElevationCrossingFunction
protected AbstractElevationCrossingFunction(AtmosphericRefractionModel refractionModel, TopocentricFrame topo) Constructor.- Parameters:
refractionModel- reference to refraction model (can be null in which case no correction is applied)topo- reference to a topocentric model
-
-
Method Details
-
getRefractionModel
Returns the currently configured refraction model.- Returns:
- refraction model
-
getElevation
Compute elevation.- Parameters:
topocentricPosition- position in topocentric framedate- date- Returns:
- elevation
-
getElevation
protected <T extends CalculusFieldElement<T>> T getElevation(FieldVector3D<T> topocentricPosition, FieldAbsoluteDate<T> date) Compute elevation.- Type Parameters:
T- field type- Parameters:
topocentricPosition- position in topocentric framedate- date- Returns:
- elevation
-
applyRefraction
protected double applyRefraction(double elevation) Apply refraction correction if applicable.- Parameters:
elevation- value before correction- Returns:
- apparent elevation due to refraction
-
applyRefraction
Apply refraction correction if applicable (Field version).- Type Parameters:
T- field type- Parameters:
elevation- value before correction- Returns:
- apparent elevation due to refraction
-