fr.cnes.sirius.patrius.propagation.events

Class EclipseDetector

java.lang.Object

fr.cnes.sirius.patrius.propagation.events.AbstractDetector

fr.cnes.sirius.patrius.propagation.events.EclipseDetector

All Implemented Interfaces:

EventDetector, Serializable

public class EclipseDetector
extends AbstractDetector

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 using the following constructors:

• EclipseDetector
• EclipseDetector
• EclipseDetector

Author:

Pascal Parraud

See Also:

Propagator.addEventDetector(EventDetector), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.propagation.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).
static int	EXIT Flag for eclipse exit detection (slopeSelection = 0).

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

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
EclipseDetector(IDirection occulted, PVCoordinatesProvider occulting, double occultingRadius, double maxCheck, double threshold) Build a new eclipse detector.
EclipseDetector(IDirection occulted, PVCoordinatesProvider occulting, double occultingRadius, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit) Build a new eclipse detector with defined actions when entering and exiting the eclipse.
EclipseDetector(IDirection occulted, 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.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, GeometricBodyShape occultingBodyIn, double lightingRatio, double maxCheck, double threshold) Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, GeometricBodyShape occultingBodyIn, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit) Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, GeometricBodyShape occultingBodyIn, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit) Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, double lightingRatio, double maxCheck, double threshold) Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit) Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit) Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, double lightingRatio, int slopeSelection, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor with slope selection.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle an eclipse event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.
EventDetector.Action	getActionAtEntry() Returns action at entry detection.
EventDetector.Action	getActionAtExit() Returns action at exit detection.
PVCoordinatesProvider	getOcculted() Get the occulted body.
IDirection	getOccultedDirection() Returns the occulted body direction.
double	getOccultedRadius() Get the occulted body radius (m).
PVCoordinatesProvider	getOcculting() Get the occulting body.
LocalRadiusProvider	getOccultingRadiusProvider() Returns the occulting radius provider.
boolean	isTotalEclipse() Get the total eclipse detection flag.
boolean	removeAtEntry() Returns true if detection is removed after entry detection.
boolean	removeAtExit() Returns true if detection is removed after exit detection.
boolean	shouldBeRemoved() This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState, boolean, boolean) has been triggered.

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

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, resetState

Methods inherited from class java.lang.Object

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

Field Detail

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

EclipseDetector

public EclipseDetector(IDirection occulted,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double maxCheck,
                       double threshold)

Build a new eclipse detector.

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

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse.

Parameters:

occulted - the direction to be occulted

occulting - the occulting body

occultingRadius - the occulting body radius (m)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

EclipseDetector

public EclipseDetector(IDirection occulted,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit)

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:

occulted - the direction to be occulted

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

EclipseDetector

public EclipseDetector(IDirection occulted,
                       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:

occulted - the direction to be occulted

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.

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double lightingRatio,
                       double maxCheck,
                       double threshold)

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.

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse.

Parameters:

occulted - the occulted body

occultedRadiusIn - the occulted body radius (m)

occulting - the occulting body

occultingRadius - the occulting body radius (m)

lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit)

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)

lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

entry - action performed when entering the eclipse

exit - action performed when exiting the eclipse

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double lightingRatio,
                       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)

lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.

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.

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       GeometricBodyShape occultingBodyIn,
                       double lightingRatio,
                       double maxCheck,
                       double threshold)

Build a new eclipse detector based on a lighting ratio. The occulted body is a sphere and the occulting body is a GeometricBodyShape.

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.

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse.

Parameters:

occulted - the occulted body

occultedRadiusIn - the occulted body radius (m)

occultingBodyIn - the occulting body

lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       GeometricBodyShape occultingBodyIn,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit)

Build a new eclipse detector based on a lighting ratio. The occulted body is a sphere and the occulting body is a GeometricBodyShape.

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

lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

entry - action performed when entering the eclipse

exit - action performed when exiting the eclipse

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       GeometricBodyShape occultingBodyIn,
                       double lightingRatio,
                       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 body is a sphere and the occulting body is a GeometricBodyShape.

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

lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.

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.

Since:

3.1

EclipseDetector

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

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)

lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

slopeSelection - slope selection

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

Throws:

ArithmeticException - if occultingBodyRadius is NaN.

Method Detail

getOcculting

public PVCoordinatesProvider getOcculting()

Get the occulting body.

Returns:

the occulting body

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

getOccultedDirection

public IDirection getOccultedDirection()

Returns the occulted body direction.

Returns:

the occulted direction

getOccultingRadiusProvider

public LocalRadiusProvider getOccultingRadiusProvider()

Returns the occulting radius provider.

Returns:

the occultingRadiusProvider

isTotalEclipse

public boolean isTotalEclipse()

Get the total eclipse detection flag.

Returns:

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

eventOccurred

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

Handle an eclipse event and choose what to do next.

Specified by:

eventOccurred in interface EventDetector

Specified by:

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.

Throws:

PatriusException - if some specific error occurs

shouldBeRemoved

public boolean shouldBeRemoved()

This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState, boolean, boolean) has been triggered. It returns true if the current detector should be removed after first event detection. WARNING: this method can be called only once a event has been triggered. Before, the value is not available.

Specified by:

shouldBeRemoved in interface EventDetector

Specified by:

shouldBeRemoved in class AbstractDetector

Returns:

true if the current detector should be removed after first event detection

g

public double g(SpacecraftState s)
         throws PatriusException

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 EventDetector

Specified by:

g in class AbstractDetector

Parameters:

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

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

copy

public EventDetector copy()

A copy of the detector. By default copy is deep. If not, detector javadoc will specify which attribute is not fully copied. In that case, the attribute reference is passed.

The following attributes are not deeply copied:

• occultingBody: PVCoordinatesProvider
• occultedBody: PVCoordinatesProvider
• occultingRadiusProvider: LocalRadiusProvider

Returns:

a copy of the detector.

getActionAtEntry

public EventDetector.Action getActionAtEntry()

Returns action at entry detection.

Returns:

action at entry detection

getActionAtExit

public EventDetector.Action getActionAtExit()

Returns action at exit detection.

Returns:

action at exit detection

removeAtEntry

public boolean removeAtEntry()

Returns true if detection is removed after entry detection.

Returns:

true if detection is removed after entry detection

removeAtExit

public boolean removeAtExit()

Returns true if detection is removed after exit detection.

Returns:

true if detection is removed after exit detection