Package org.orekit.propagation.events.functions

Class ExtremumAngularSeparationFunction

java.lang.Object

org.orekit.propagation.events.functions.ExtremumAngularSeparationFunction

All Implemented Interfaces:

EventFunction

public class ExtremumAngularSeparationFunction
extends Object
implements EventFunction

Event function for local extrema of angular separation. It is positive when the angle increases.

Since:

14.0

Author:

Romain Serra

Constructor Summary

Constructors

Constructor	Description
ExtremumAngularSeparationFunction(ExtendedPositionProvider beacon, ExtendedPositionProvider observer)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
<T extends CalculusFieldElement<T>> T	value(FieldSpacecraftState<T> s)	Evaluate Field function.
double	value(SpacecraftState s)	Evaluate function.

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

ExtremumAngularSeparationFunction

public ExtremumAngularSeparationFunction(ExtendedPositionProvider beacon,
                                         ExtendedPositionProvider observer)

Protected constructor with full parameters.

Parameters:

beacon - beacon at the center of the proximity zone

observer - observer for the spacecraft, that may also see the beacon at the same time if they are too close to each other

Method Detail

value

public double value(SpacecraftState s)

Description copied from interface: EventFunction

Evaluate function.

Specified by:

value in interface EventFunction

Parameters:

s - spacecraft state

Returns:

value

value

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

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.

Specified by:

value in interface EventFunction

Type Parameters:

T - field type

Parameters:

s - spacecraft state

Returns:

value