fr.cnes.sirius.patrius.events.detectors

Class AbstractEclipseDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

fr.cnes.sirius.patrius.events.detectors.AbstractEclipseDetector

All Implemented Interfaces:

EventDetector, Serializable

Direct Known Subclasses:

BodyInEclipseDetector, EclipseDetector

public abstract class AbstractEclipseDetector
extends AbstractSignalPropagationDetector

Common parts shared by several events detectors related to eclipse concept.

Since:

4.16

Author:

Marc BELMONTE HISTORY VERSION:4.16:OPENFD-468:25/04/2025:[PATRIUS] Renommer toutes les mentions du GeodeticPoint VERSION:4.16:OPENFD-442:25/04/2025:[PATRIUS] Calcul des eclipses d'un corps celeste END-HISTORY

See Also:

AbstractSignalPropagationDetector, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

AbstractSignalPropagationDetector.EventDatationType, AbstractSignalPropagationDetector.PropagationDelayType

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.events.EventDetector

EventDetector.Action

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENTRY Flag for eclipse entry detection (slopeSelection = 1).
static int	ENTRY_EXIT Flag for eclipse entry/exit detection (slopeSelection = 2).
protected static double	EPSILON_LIGHTING_RATIO Threshold for the lighting ratio: if ratio >= 1 - ε --> ratio = 1, if ratio <= ε --> ratio = 0.
static int	EXIT Flag for eclipse exit detection (slopeSelection = 0).
protected static String	UNSUPPORTED_MODE_EXCEPTION Exception message if the compatibility mode is unsupported.

Fields inherited from class fr.cnes.sirius.patrius.events.AbstractDetector

actionAtEntry, actionAtExit, DEFAULT_MAXCHECK, DEFAULT_MAXITER, DEFAULT_THRESHOLD, removeAtEntry, removeAtExit, shouldBeRemovedFlag

Fields inherited from interface fr.cnes.sirius.patrius.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
AbstractEclipseDetector(BodyShape occulting, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit) Build a new eclipse detector with defined actions when entering and exiting the eclipse.
AbstractEclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, BodyShape occultingBodyIn, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit, int slopeSelection) Build a new eclipse detector based on a lighting ratio and with slope selection.
AbstractEclipseDetector(PVCoordinatesProvider occulting, double occultingRadius, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit) Build a new eclipse detector with defined actions when entering and exiting the eclipse.
AbstractEclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, int slopeSelection, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor with slope selection.
AbstractEclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, int slopeSelection, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit) Build a new eclipse detector based on a lighting ratio.

Method Summary

Modifier and Type	Method and Description
protected LightingRatio	buildLightingRatioComputer(PVCoordinatesProvider occultedBody) Builds the LightingRatio object
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle an eclipse event and choose what to do next.
PVCoordinatesProvider	getEmitter(SpacecraftState s) Getter for the signal emitter.
AbstractSignalPropagationDetector.EventDatationType	getEventDatationType() Specify if the event datation type corresponds to the emitter date or the receiver date.
PVCoordinatesProvider	getOcculted() Get the occulted body.
double	getOccultedRadius() Get the occulted body radius (m).
PVCoordinatesProvider	getOcculting() Get the occulting body.
protected BodyShape	getOccultingBodyShape() Get the occulting body shape
ApparentRadiusProvider	getOccultingRadiusProvider() Returns the occulting radius provider.
PVCoordinatesProvider	getReceiver(SpacecraftState s) Getter for the signal receiver.
boolean	isInEclipse(SpacecraftState s) Get the eclipse flag.
abstract boolean	isTotalEclipse() Get the total eclipse detection flag.
protected void	setOcculted(PVCoordinatesProvider occultedBody) Set the occulted body.
void	setPropagationDelayType(AbstractSignalPropagationDetector.PropagationDelayType propagationDelayType, Frame frame) Setter for the propagation delay computation type.

Methods inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

getEpsilonSignalPropagation, getInertialFrame, getLinkTypeHandler, getMaxIterSignalPropagation, getOtherDate, getPropagationDelayType, getSignalEmissionDate, getSignalEmissionDate, getSignalReceptionDate, getSignalReceptionDate, setEpsilonSignalPropagation, setMaxIterSignalPropagation

Methods inherited from class fr.cnes.sirius.patrius.events.AbstractDetector

filterEvent, g, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setMaxCheckInterval, setMaxIter, shouldBeRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.events.EventDetector

copy

Field Detail

UNSUPPORTED_MODE_EXCEPTION

protected static final String UNSUPPORTED_MODE_EXCEPTION

Exception message if the compatibility mode is unsupported.

See Also:

Constant Field Values

EPSILON_LIGHTING_RATIO

protected static final double EPSILON_LIGHTING_RATIO

Threshold for the lighting ratio: if ratio >= 1 - ε --> ratio = 1, if ratio <= ε --> ratio = 0.

See Also:

Constant Field Values

EXIT

public static final int EXIT

Flag for eclipse exit detection (slopeSelection = 0).

See Also:

Constant Field Values

ENTRY

public static final int ENTRY

Flag for eclipse entry detection (slopeSelection = 1).

See Also:

Constant Field Values

ENTRY_EXIT

public static final int ENTRY_EXIT

Flag for eclipse entry/exit detection (slopeSelection = 2).

See Also:

Constant Field Values

Constructor Detail

AbstractEclipseDetector

public AbstractEclipseDetector(PVCoordinatesProvider occulting,
                               double occultingRadius,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action entry,
                               EventDetector.Action exit,
                               boolean removeEntry,
                               boolean removeExit)

Build a new eclipse detector with defined actions when entering and exiting the eclipse.

The occulting body is a sphere and the occulted body is a direction; the concept of umbra/penumbra does not apply to this detector.

Parameters:

occulting - the occulting body

occultingRadius - the occulting body radius (m)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

entry - action performed when entering the eclipse

exit - action performed when exiting the eclipse

removeEntry - when the spacecraft point enters the zone.

removeExit - when the spacecraft point leaves the zone.

AbstractEclipseDetector

public AbstractEclipseDetector(BodyShape occulting,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action entry,
                               EventDetector.Action exit,
                               boolean removeEntry,
                               boolean removeExit)

Build a new eclipse detector with defined actions when entering and exiting the eclipse.

The occulting body is a sphere and the occulted body is a direction; the concept of umbra/penumbra does apply to this detector by means of the lighting ratio.

Parameters:

occulting - the occulting body

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

entry - action performed when entering the eclipse

exit - action performed when exiting the eclipse

removeEntry - when the spacecraft point enters the zone

removeExit - when the spacecraft point leaves the zone

AbstractEclipseDetector

public AbstractEclipseDetector(PVCoordinatesProvider occulted,
                               double occultedRadiusIn,
                               PVCoordinatesProvider occulting,
                               double occultingRadius,
                               int slopeSelection,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action entry,
                               EventDetector.Action exit,
                               boolean removeEntry,
                               boolean removeExit)

Build a new eclipse detector based on a lighting ratio. The occulted and occulting bodies are both spherical.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

Parameters:

occulted - the occulted body

occultedRadiusIn - the occulted body radius (m)

occulting - the occulting body

occultingRadius - the occulting body radius (m)

slopeSelection - slope selection

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

entry - action performed when entering the eclipse

exit - action performed when exiting the eclipse

removeEntry - when the spacecraft point enters the zone.

removeExit - when the spacecraft point leaves the zone.

AbstractEclipseDetector

public AbstractEclipseDetector(PVCoordinatesProvider occulted,
                               double occultedRadiusIn,
                               BodyShape occultingBodyIn,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action entry,
                               EventDetector.Action exit,
                               boolean removeEntry,
                               boolean removeExit,
                               int slopeSelection)

Build a new eclipse detector based on a lighting ratio and with slope selection. The occulted body is a sphere and the occulting body is a BodyShape.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

Parameters:

occulted - the occulted body

occultedRadiusIn - the occulted body radius (m)

occultingBodyIn - the occulting body

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

entry - action performed when entering the eclipse

exit - action performed when exiting the eclipse

removeEntry - when the spacecraft point enters the zone.

removeExit - when the spacecraft point leaves the zone.

slopeSelection - slope selection

Throws:

ArithmeticException - if occultingBodyRadius is NaN.

Since:

4.5

AbstractEclipseDetector

public AbstractEclipseDetector(PVCoordinatesProvider occulted,
                               double occultedRadiusIn,
                               PVCoordinatesProvider occulting,
                               double occultingRadius,
                               int slopeSelection,
                               double maxCheck,
                               double threshold,
                               EventDetector.Action action,
                               boolean remove)

Constructor with slope selection.

Parameters:

occulted - the occulted body

occultedRadiusIn - the occulted body radius (m)

occulting - the occulting body

occultingRadius - the occulting body radius (m)

slopeSelection - slope selection

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

action - action performed when entering/exiting the eclipse depending on slope selection

remove - when the spacecraft point enters or exit the zone depending on slope selection

Method Detail

getOcculting

public PVCoordinatesProvider getOcculting()

Get the occulting body.

Returns:

the occulting body

getOccultingBodyShape

protected BodyShape getOccultingBodyShape()

Get the occulting body shape

Returns:

the occulting body shape

getOcculted

public PVCoordinatesProvider getOcculted()

Get the occulted body.

Returns:

the occulted body

setOcculted

protected final void setOcculted(PVCoordinatesProvider occultedBody)

Set the occulted body.

Parameters:

occultedBody - the occulted body

getOccultedRadius

public double getOccultedRadius()

Get the occulted body radius (m).

Returns:

the occulted body radius

getOccultingRadiusProvider

public ApparentRadiusProvider getOccultingRadiusProvider()

Returns the occulting radius provider.

Returns:

the occultingRadiusProvider

isTotalEclipse

public abstract boolean isTotalEclipse()

Get the total eclipse detection flag.

Returns:

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

isInEclipse

public boolean isInEclipse(SpacecraftState s)
                    throws PatriusException

Get the eclipse flag.

Parameters:

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

Returns:

an eclipse flag indicating whether the object is in eclipse: true if it is in eclipse, false if it is not

Throws:

PatriusException - if some specific error occurs while retrieving the value of the switching function g(s)

eventOccurred

public EventDetector.Action eventOccurred(SpacecraftState s,
                                          boolean increasing,
                                          boolean forward)

Handle an eclipse event and choose what to do next.

Specified by:

eventOccurred in interface EventDetector

Overrides:

eventOccurred in class AbstractDetector

Parameters:

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

increasing - if true, the value of the switching function increases when times increases around event

forward - if true, the integration variable (time) increases during integration.

Returns:

the action performed when entering or exiting the eclipse.

setPropagationDelayType

public void setPropagationDelayType(AbstractSignalPropagationDetector.PropagationDelayType propagationDelayType,
                                    Frame frame)

Setter for the propagation delay computation type. Warning: check Javadoc of detector to see if detector takes into account propagation time delay. if not, signals are always considered instantaneous. The provided frame is used to compute the signal propagation when delay is taken into account.

Overrides:

setPropagationDelayType in class AbstractSignalPropagationDetector

Parameters:

propagationDelayType - Propagation delay type used in events computation

frame - Frame to use for signal propagation with delay (may be null if propagation delay type is considered instantaneous). Warning: the usage of a pseudo inertial frame is tolerated, however it will lead to some inaccuracies due to the non-invariance of the frame with respect to time. For this reason, it is suggested to use the ICRF frame or a frame which is frozen with respect to the ICRF.

getEmitter

public PVCoordinatesProvider getEmitter(SpacecraftState s)

Getter for the signal emitter.

Overrides:

getEmitter in class AbstractSignalPropagationDetector

Parameters:

s - the spacecraft state used by the detector

Returns:

the signal emitter

getReceiver

public PVCoordinatesProvider getReceiver(SpacecraftState s)

Getter for the signal receiver.

Overrides:

getReceiver in class AbstractSignalPropagationDetector

Parameters:

s - the spacecraft state used by the detector

Returns:

the signal receiver

getEventDatationType

public AbstractSignalPropagationDetector.EventDatationType getEventDatationType()

Specify if the event datation type corresponds to the emitter date or the receiver date.

Overrides:

getEventDatationType in class AbstractSignalPropagationDetector

Returns:

the corresponding event datation type

buildLightingRatioComputer

protected LightingRatio buildLightingRatioComputer(PVCoordinatesProvider occultedBody)

Builds the LightingRatio object

Parameters:

occultedBody - occulted body

Returns:

the LightingRatio object