Package org.orekit.propagation.events

Class FieldEclipseDetector<T extends RealFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<FieldEclipseDetector<T>,T>

org.orekit.propagation.events.FieldEclipseDetector<T>

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldEclipseDetector<T extends RealFieldElement<T>>
extends FieldAbstractDetector<FieldEclipseDetector<T>,T>

Finder for satellite eclipse related events.

This class finds eclipse events, i.e. satellite within umbra (total eclipse) or penumbra (partial eclipse).

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse. This can be changed by calling FieldAbstractDetector.withHandler(FieldEventHandler) after construction.

Author:

Pascal Parraud

See Also:

FieldPropagator.addEventDetector(FieldEventDetector)

Field Summary

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

DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FieldEclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, Field<T> field)	Build a new eclipse detector.
FieldEclipseDetector(T maxCheck, PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius)	Build a new eclipse detector.
FieldEclipseDetector(T maxCheck, T threshold, PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius)	Build a new eclipse detector.

Method Summary

Modifier and Type	Method	Description
protected FieldEclipseDetector<T>	create(T newMaxCheck, T newThreshold, int nawMaxIter, FieldEventHandler<? super FieldEclipseDetector<T>,T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
PVCoordinatesProvider	getOcculted()	Get the occulted body.
double	getOccultedRadius()	Get the occulted body radius (m).
PVCoordinatesProvider	getOcculting()	Get the occulting body.
double	getOccultingRadius()	Get the occulting body radius (m).
boolean	getTotalEclipse()	Get the total eclipse detection flag.
FieldEclipseDetector<T>	withPenumbra()	Setup the detector to penumbra detection.
FieldEclipseDetector<T>	withUmbra()	Setup the detector to full umbra detection.

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

eventOccurred, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, resetState, withHandler, withMaxCheck, withMaxIter, withThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldEclipseDetector

public FieldEclipseDetector(PVCoordinatesProvider occulted,
                            double occultedRadius,
                            PVCoordinatesProvider occulting,
                            double occultingRadius,
                            Field<T> field)

Build a new eclipse detector.

The new instance is a total eclipse (umbra) detector with default values for maximal checking interval (FieldAbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (FieldAbstractDetector.DEFAULT_THRESHOLD).

Parameters:

occulted - the body to be occulted

occultedRadius - the radius of the body to be occulted (m)

occulting - the occulting body

occultingRadius - the occulting body radius (m)

field - field used by default

FieldEclipseDetector

public FieldEclipseDetector(T maxCheck,
                            PVCoordinatesProvider occulted,
                            double occultedRadius,
                            PVCoordinatesProvider occulting,
                            double occultingRadius)

Build a new eclipse detector.

The new instance is a total eclipse (umbra) detector with default value for convergence threshold (FieldAbstractDetector.DEFAULT_THRESHOLD).

The maximal interval between eclipse checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:

maxCheck - maximal checking interval (s)

occulted - the body to be occulted

occultedRadius - the radius of the body to be occulted in meters

occulting - the occulting body

occultingRadius - the occulting body radius in meters

FieldEclipseDetector

public FieldEclipseDetector(T maxCheck,
                            T threshold,
                            PVCoordinatesProvider occulted,
                            double occultedRadius,
                            PVCoordinatesProvider occulting,
                            double occultingRadius)

Build a new eclipse detector.

The new instance is a total eclipse (umbra) detector.

The maximal interval between eclipse checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

occulted - the body to be occulted

occultedRadius - the radius of the body to be occulted in meters

occulting - the occulting body

occultingRadius - the occulting body radius in meters

Method Detail

create

protected FieldEclipseDetector<T> create(T newMaxCheck,
                                         T newThreshold,
                                         int nawMaxIter,
                                         FieldEventHandler<? super FieldEclipseDetector<T>,T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldEclipseDetector<T extends RealFieldElement<T>>,T extends RealFieldElement<T>>

Parameters:

newMaxCheck - maximum checking interval (s)

newThreshold - convergence threshold (s)

nawMaxIter - maximum number of iterations in the event time search

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

withUmbra

public FieldEclipseDetector<T> withUmbra()

Setup the detector to full umbra detection.

This will override a penumbra/umbra flag if it has been configured previously.

Returns:

a new detector with updated configuration (the instance is not changed)

Since:

6.1

See Also:

withPenumbra()

withPenumbra

public FieldEclipseDetector<T> withPenumbra()

Setup the detector to penumbra detection.

This will override a penumbra/umbra flag if it has been configured previously.

Returns:

a new detector with updated configuration (the instance is not changed)

Since:

6.1

See Also:

withUmbra()

getOcculting

public PVCoordinatesProvider getOcculting()

Get the occulting body.

Returns:

the occulting body

getOccultingRadius

public double getOccultingRadius()

Get the occulting body radius (m).

Returns:

the occulting body radius

getOcculted

public PVCoordinatesProvider getOcculted()

Get the occulted body.

Returns:

the occulted body

getOccultedRadius

public double getOccultedRadius()

Get the occulted body radius (m).

Returns:

the occulted body radius

getTotalEclipse

public boolean getTotalEclipse()

Get the total eclipse detection flag.

Returns:

the total eclipse detection flag (true for umbra events detection, false for penumbra events detection)

g

public T g(FieldSpacecraftState<T> s)
    throws OrekitException

Compute the value of the switching function. This function becomes negative when entering the region of shadow and positive when exiting.

Specified by:

g in interface FieldEventDetector<T extends RealFieldElement<T>>

Specified by:

g in class FieldAbstractDetector<FieldEclipseDetector<T extends RealFieldElement<T>>,T extends RealFieldElement<T>>

Parameters:

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

Returns:

value of the switching function

Throws:

OrekitException - if some specific error occurs