fr.cnes.sirius.patrius.events.detectors

Class EclipseDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

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

fr.cnes.sirius.patrius.events.detectors.EclipseDetector

All Implemented Interfaces:

EventDetector, Serializable

public class EclipseDetector
extends AbstractEclipseDetector

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 EventDetector.Action#CONTINUE continue propagation when entering the eclipse and to EventDetector.Action#STOP stop propagation when exiting the eclipse. This can be changed by using some constructors.

This detector can takes into account signal propagation duration through AbstractSignalPropagationDetector.setPropagationDelayType(PropagationDelayType, Frame) (default is signal being instantaneous).
It can be taken only if the occulted body is defined through a PVCoordinatesProvider and not an IDirection.

WARNING : Do not use this detector to detect ground target visibilities or occulted bodies with null radius. Actually, the lighting ratio used to compute g function is based on geometric angle comparison and considers that if the vehicle is closer to the occulted body than to the occulting body then the occulted body is not occulted. This is not true if the occulted body is a target on the ground of the occulting body and In this case, it will detect a period out of eclipse longer than it should be.

Author:

Pascal Parraud

See Also:

Propagator.addEventDetector(EventDetector), 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 inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractEclipseDetector

ENTRY, ENTRY_EXIT, EPSILON_LIGHTING_RATIO, EXIT, UNSUPPORTED_MODE_EXCEPTION

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
EclipseDetector(IDirection occulted, BodyShape occulting, double lightingRatio, 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(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, BodyShape occultingBodyIn, double lightingRatio, double maxCheck, double threshold) Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, BodyShape occultingBodyIn, double lightingRatio, double maxCheck, double threshold, EventDetector.Action action, boolean remove, int slopeSelection) Build a new eclipse detector based on a lighting ratio and with slope selection.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, BodyShape 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, BodyShape 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, BodyShape occultingBodyIn, double lightingRatio, 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.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadiusIn, BodyShape occultingBodyIn, double lightingRatio, double maxCheck, double threshold, int slopeSelection) Build a new eclipse detector based on a lighting ratio and with slope selection.
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.
double	g(SpacecraftState state) Compute the value of the switching function.
IDirection	getOccultedDirection() Returns the occulted body direction.
boolean	isTotalEclipse() Get the total eclipse detection flag.

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

buildLightingRatioComputer, eventOccurred, getEmitter, getEventDatationType, getOcculted, getOccultedRadius, getOcculting, getOccultingBodyShape, getOccultingRadiusProvider, getReceiver, isInEclipse, setOcculted, setPropagationDelayType

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, 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

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 EventDetector.Action#CONTINUE continue propagation when entering the eclipse and to EventDetector.Action#STOP 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(IDirection occulted,
                       BodyShape occulting,
                       double lightingRatio,
                       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:

occulted - the direction to be occulted

occulting - 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

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 EventDetector.Action#CONTINUE continue propagation when entering the eclipse and to EventDetector.Action#STOP 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,
                       BodyShape 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 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.

The default implementation behavior is to EventDetector.Action#CONTINUE continue propagation when entering the eclipse and to EventDetector.Action#STOP 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,
                       BodyShape 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 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

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,
                       BodyShape 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 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

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,
                       BodyShape occultingBodyIn,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       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

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

Throws:

ArithmeticException - if occultingBodyRadius is NaN.

Since:

4.5

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       BodyShape occultingBodyIn,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action action,
                       boolean remove,
                       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

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)

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

slopeSelection - slope selection

Throws:

ArithmeticException - if occultingBodyRadius is NaN.

Since:

4.5

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadiusIn,
                       BodyShape occultingBodyIn,
                       double lightingRatio,
                       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

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.

slopeSelection - slope selection

Throws:

ArithmeticException - if occultingBodyRadius is NaN.

Since:

4.5

EclipseDetector

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

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

Method Detail

getOccultedDirection

public IDirection getOccultedDirection()

Returns the occulted body direction.

Returns:

the occulted direction

isTotalEclipse

public boolean isTotalEclipse()

Get the total eclipse detection flag.

Specified by:

isTotalEclipse in class AbstractEclipseDetector

Returns:

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

g

public double g(SpacecraftState state)
         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:

state - state

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: ApparentRadiusProvider

Returns:

a copy of the detector.