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

public abstract class AbstractElevationCrossingFunction extends AbstractTopocentricEventFunction
Abstract class for elevation crossing event function. It is negative when under the necessary elevation.
Since:
14.0
Author:
Romain Serra
  • 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

      public AtmosphericRefractionModel getRefractionModel()
      Returns the currently configured refraction model.
      Returns:
      refraction model
    • getElevation

      protected double getElevation(Vector3D topocentricPosition, AbsoluteDate date)
      Compute elevation.
      Parameters:
      topocentricPosition - position in topocentric frame
      date - 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 frame
      date - 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

      protected <T extends CalculusFieldElement<T>> T applyRefraction(T elevation)
      Apply refraction correction if applicable (Field version).
      Type Parameters:
      T - field type
      Parameters:
      elevation - value before correction
      Returns:
      apparent elevation due to refraction