Package org.orekit.propagation.events.functions

Class MaskedElevationEventFunction

java.lang.Object

org.orekit.propagation.events.functions.AbstractElevationEventFunction

org.orekit.propagation.events.functions.MaskedElevationEventFunction

All Implemented Interfaces:

EventFunction

public class MaskedElevationEventFunction
extends AbstractElevationEventFunction

Class for masked elevation event function.

Since:

14.0

Author:

Romain Serra

Constructor Summary

Constructors

Constructor	Description
MaskedElevationEventFunction(AtmosphericRefractionModel refractionModel, TopocentricFrame topo, ElevationMask elevationMask)	Constructor.

Method Summary

Modifier and Type	Method	Description
ElevationMask	getElevationMask()	Getter for the elevation mask.
<T extends CalculusFieldElement<T>> T	value(FieldSpacecraftState<T> fieldState)	Evaluate Field function.
double	value(SpacecraftState state)	Evaluate function.

Methods inherited from class org.orekit.propagation.events.functions.AbstractElevationEventFunction

applyRefraction, applyRefraction, getRefractionModel, getTopocentricFrame

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.propagation.events.functions.EventFunction

dependsOnMainVariablesOnly, dependsOnTimeOnly

Constructor Detail

MaskedElevationEventFunction

public MaskedElevationEventFunction(AtmosphericRefractionModel refractionModel,
                                    TopocentricFrame topo,
                                    ElevationMask elevationMask)

Constructor.

Parameters:

refractionModel - reference to refraction model (can be null in which case no correction is applied)

topo - reference to a topocentric model

elevationMask - elevation mask defining function's root

Method Detail

getElevationMask

public ElevationMask getElevationMask()

Getter for the elevation mask.

Returns:

mask

value

public double value(SpacecraftState state)

Description copied from interface: EventFunction

Evaluate function.

Parameters:

state - spacecraft state

Returns:

value

value

public <T extends CalculusFieldElement<T>> T value(FieldSpacecraftState<T> fieldState)

Description copied from interface: EventFunction

Evaluate Field function. By default, calls the non-Field version. This is suitable for detection but not be for applications like automatic differentiation, where a proper implementation should be used instead.

Type Parameters:

T - field type

Parameters:

fieldState - spacecraft state

Returns:

value