Package org.orekit.propagation.events

Class ExtremumAngularSeparationDetector

java.lang.Object

org.orekit.propagation.events.AbstractDetector<ExtremumAngularSeparationDetector>

org.orekit.propagation.events.ExtremumAngularSeparationDetector

All Implemented Interfaces:

EventDetector

public class ExtremumAngularSeparationDetector
extends AbstractDetector<ExtremumAngularSeparationDetector>

Detector of local extrema with angular separation.

Since:

13.1

Author:

Romain Serra

See Also:

AngularSeparationDetector

Field Summary

Fields inherited from class org.orekit.propagation.events.AbstractDetector

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
ExtremumAngularSeparationDetector(EventDetectionSettings detectionSettings, EventHandler handler, ExtendedPositionProvider beacon, ExtendedPositionProvider observer)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected ExtremumAngularSeparationDetector	create(EventDetectionSettings detectionSettings, EventHandler newHandler)	Build a new instance.
double	g(SpacecraftState s)	Compute the value of the switching function.
ExtendedPositionProvider	getBeacon()	Get the beacon at the center of the proximity zone.
ExtendedPositionProvider	getObserver()	Get the observer for the spacecraft.

Methods inherited from class org.orekit.propagation.events.AbstractDetector

checkIfForward, getDetectionSettings, getHandler, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold

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.EventDetector

dependsOnTimeOnly, finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Detail

ExtremumAngularSeparationDetector

public ExtremumAngularSeparationDetector(EventDetectionSettings detectionSettings,
                                         EventHandler handler,
                                         ExtendedPositionProvider beacon,
                                         ExtendedPositionProvider observer)

Protected constructor with full parameters.

Parameters:

detectionSettings - detection settings

handler - event handler to call at event occurrences

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

getBeacon

public ExtendedPositionProvider getBeacon()

Get the beacon at the center of the proximity zone.

Returns:

beacon at the center of the proximity zone

getObserver

public ExtendedPositionProvider getObserver()

Get the observer for the spacecraft.

Returns:

observer for the spacecraft

create

protected ExtremumAngularSeparationDetector create(EventDetectionSettings detectionSettings,
                                                   EventHandler newHandler)

Description copied from class: AbstractDetector

Build a new instance.

Specified by:

create in class AbstractDetector<ExtremumAngularSeparationDetector>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

g

public double g(SpacecraftState s)

Description copied from interface: EventDetector

Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

value of the switching function