fr.cnes.sirius.patrius.events.detectors

Class BodyInEclipseDetector

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

All Implemented Interfaces:

EventDetector, Serializable

public class BodyInEclipseDetector
extends AbstractEclipseDetector

Finder for events related to a celestial body in eclipse.

This class finds eclipse events, i.e. celestial body 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 takes into account signal propagation duration through AbstractSignalPropagationDetector.setPropagationDelayType(PropagationDelayType, Frame) (default is signal being instantaneous).

See Also:

Propagator.addEventDetector(EventDetector), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BodyInEclipseDetector.BodyInEclipseModelEnum Enumerate for the types of available models for the BodyInEclipse calculations

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
BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn, double targetRadiusIn, PVCoordinatesProvider occulted, double occultedRadiusIn, BodyShape occultingBodyIn, boolean totalEclipseIn, boolean bodyFullyInEclipseIn, BodyInEclipseDetector.BodyInEclipseModelEnum modelIn, int slopeSelection, double maxCheck, double threshold) Build a new eclipse detector based on full shape for the occulting body.
BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn, double targetRadiusIn, PVCoordinatesProvider occulted, double occultedRadiusIn, BodyShape occultingBodyIn, boolean totalEclipseIn, boolean bodyFullyInEclipseIn, BodyInEclipseDetector.BodyInEclipseModelEnum modelIn, int slopeSelection, double maxCheck, double threshold, boolean removeEntry, boolean removeExit) Build a new eclipse detector based on full shape for the occulting body.
BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn, double targetRadiusIn, PVCoordinatesProvider occulted, double occultedRadiusIn, BodyShape occultingBodyIn, boolean totalEclipseIn, boolean bodyFullyInEclipseIn, BodyInEclipseDetector.BodyInEclipseModelEnum modelIn, int slopeSelection, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit) Build a new eclipse detector based on full shape for the occulting body.
BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn, double targetRadiusIn, PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, boolean totalEclipseIn, boolean bodyFullyInEclipseIn, BodyInEclipseDetector.BodyInEclipseModelEnum modelIn, int slopeSelection, double maxCheck, double threshold) Build a new eclipse detector.
BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn, double targetRadiusIn, PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, boolean totalEclipseIn, boolean bodyFullyInEclipseIn, BodyInEclipseDetector.BodyInEclipseModelEnum modelIn, int slopeSelection, double maxCheck, double threshold, boolean removeEntry, boolean removeExit) Build a new eclipse detector.
BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn, double targetRadiusIn, PVCoordinatesProvider occulted, double occultedRadiusIn, PVCoordinatesProvider occulting, double occultingRadius, boolean totalEclipseIn, boolean bodyFullyInEclipseIn, BodyInEclipseDetector.BodyInEclipseModelEnum modelIn, int slopeSelection, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit) Build a new eclipse detector.

Method Summary

Modifier and Type	Method and Description
BodyInEclipseDetector	copy() A copy of the detector.
double	g(AbsoluteDate date) Compute the value of the switching function at a given date.
double	g(SpacecraftState state) Compute the value of the switching function.
boolean	isInEclipse(AbsoluteDate date) Get the eclipse flag.
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

BodyInEclipseDetector

public BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn,
                             double targetRadiusIn,
                             PVCoordinatesProvider occulted,
                             double occultedRadiusIn,
                             BodyShape occultingBodyIn,
                             boolean totalEclipseIn,
                             boolean bodyFullyInEclipseIn,
                             BodyInEclipseDetector.BodyInEclipseModelEnum modelIn,
                             int slopeSelection,
                             double maxCheck,
                             double threshold)

Build a new eclipse detector based on full shape for the occulting body. The occulted body and the target body are spherical. Action at entry CONTINUE by default and action at exit STOP by default. RemoveEntry and removeExit are false by default.

Parameters:

targetBodyIn - the target body ephemeris

targetRadiusIn - the target body radius (m)

occulted - the occulted body ephemeris

occultedRadiusIn - the occulted body radius (m)

occultingBodyIn - the occulting body

totalEclipseIn - true for total eclipse (umbra), false for partial eclipse (penumbra)

bodyFullyInEclipseIn - true for body fully in eclipse, false for body partially in eclipse

modelIn - the model to use (exact or approx)

slopeSelection - slope selection

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

BodyInEclipseDetector

public BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn,
                             double targetRadiusIn,
                             PVCoordinatesProvider occulted,
                             double occultedRadiusIn,
                             BodyShape occultingBodyIn,
                             boolean totalEclipseIn,
                             boolean bodyFullyInEclipseIn,
                             BodyInEclipseDetector.BodyInEclipseModelEnum modelIn,
                             int slopeSelection,
                             double maxCheck,
                             double threshold,
                             boolean removeEntry,
                             boolean removeExit)

Build a new eclipse detector based on full shape for the occulting body. The occulted body and the target body are spherical. Action at entry CONTINUE by default and action at exit STOP by default.

Parameters:

targetBodyIn - the target body ephemeris

targetRadiusIn - the target body radius (m)

occulted - the occulted body ephemeris

occultedRadiusIn - the occulted body radius (m)

occultingBodyIn - the occulting body

totalEclipseIn - true for total eclipse (umbra), false for partial eclipse (penumbra)

bodyFullyInEclipseIn - true for body fully in eclipse, false for body partially in eclipse

modelIn - the model to use (exact or approx)

slopeSelection - slope selection

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

removeEntry - when the spacecraft point enters the zone.

removeExit - when the spacecraft point leaves the zone.

BodyInEclipseDetector

public BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn,
                             double targetRadiusIn,
                             PVCoordinatesProvider occulted,
                             double occultedRadiusIn,
                             PVCoordinatesProvider occulting,
                             double occultingRadius,
                             boolean totalEclipseIn,
                             boolean bodyFullyInEclipseIn,
                             BodyInEclipseDetector.BodyInEclipseModelEnum modelIn,
                             int slopeSelection,
                             double maxCheck,
                             double threshold)

Build a new eclipse detector. All 3 bodies are spherical. Action at entry CONTINUE by default and action at exit STOP by default. RemoveEntry and removeExit are false by default.

Parameters:

targetBodyIn - the target body ephemeris

targetRadiusIn - the target body radius (m)

occulted - the occulted body ephemeris

occultedRadiusIn - the occulted body radius (m)

occulting - the occulting body ephemeris

occultingRadius - the occulting body radius (m)

totalEclipseIn - true for total eclipse (umbra), false for partial eclipse (penumbra)

bodyFullyInEclipseIn - true for body fully in eclipse, false for body partially in eclipse

modelIn - the model to use (exact or approx)

slopeSelection - slope selection

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

BodyInEclipseDetector

public BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn,
                             double targetRadiusIn,
                             PVCoordinatesProvider occulted,
                             double occultedRadiusIn,
                             PVCoordinatesProvider occulting,
                             double occultingRadius,
                             boolean totalEclipseIn,
                             boolean bodyFullyInEclipseIn,
                             BodyInEclipseDetector.BodyInEclipseModelEnum modelIn,
                             int slopeSelection,
                             double maxCheck,
                             double threshold,
                             boolean removeEntry,
                             boolean removeExit)

Build a new eclipse detector. All 3 bodies are spherical. Action at entry CONTINUE by default and action at exit STOP by default.

Parameters:

targetBodyIn - the target body ephemeris

targetRadiusIn - the target body radius (m)

occulted - the occulted body ephemeris

occultedRadiusIn - the occulted body radius (m)

occulting - the occulting body ephemeris

occultingRadius - the occulting body radius (m)

totalEclipseIn - true for total eclipse (umbra), false for partial eclipse (penumbra)

bodyFullyInEclipseIn - true for body fully in eclipse, false for body partially in eclipse

modelIn - the model to use (exact or approx)

slopeSelection - slope selection

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

removeEntry - when the spacecraft point enters the zone.

removeExit - when the spacecraft point leaves the zone.

BodyInEclipseDetector

public BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn,
                             double targetRadiusIn,
                             PVCoordinatesProvider occulted,
                             double occultedRadiusIn,
                             BodyShape occultingBodyIn,
                             boolean totalEclipseIn,
                             boolean bodyFullyInEclipseIn,
                             BodyInEclipseDetector.BodyInEclipseModelEnum modelIn,
                             int slopeSelection,
                             double maxCheck,
                             double threshold,
                             EventDetector.Action entry,
                             EventDetector.Action exit,
                             boolean removeEntry,
                             boolean removeExit)

Build a new eclipse detector based on full shape for the occulting body. The occulted body and the target body are spherical.

Parameters:

targetBodyIn - the target body ephemeris

targetRadiusIn - the target body radius (m)

occulted - the occulted body ephemeris

occultedRadiusIn - the occulted body radius (m)

occultingBodyIn - the occulting body

totalEclipseIn - true for total eclipse (umbra), false for partial eclipse (penumbra)

bodyFullyInEclipseIn - true for body fully in eclipse, false for body partially in eclipse

modelIn - the model to use (exact or approx)

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.

BodyInEclipseDetector

public BodyInEclipseDetector(PVCoordinatesProvider targetBodyIn,
                             double targetRadiusIn,
                             PVCoordinatesProvider occulted,
                             double occultedRadiusIn,
                             PVCoordinatesProvider occulting,
                             double occultingRadius,
                             boolean totalEclipseIn,
                             boolean bodyFullyInEclipseIn,
                             BodyInEclipseDetector.BodyInEclipseModelEnum modelIn,
                             int slopeSelection,
                             double maxCheck,
                             double threshold,
                             EventDetector.Action entry,
                             EventDetector.Action exit,
                             boolean removeEntry,
                             boolean removeExit)

Build a new eclipse detector. All 3 bodies are spherical.

Parameters:

targetBodyIn - the target body ephemeris

targetRadiusIn - the target body radius (m)

occulted - the occulted body ephemeris

occultedRadiusIn - the occulted body radius (m)

occulting - the occulting body ephemeris

occultingRadius - the occulting body radius (m)

totalEclipseIn - true for total eclipse (umbra), false for partial eclipse (penumbra)

bodyFullyInEclipseIn - true for body fully in eclipse, false for body partially in eclipse

modelIn - the model to use (exact or approx)

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.

Method Detail

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

g

public double g(AbsoluteDate date)
         throws PatriusException

Compute the value of the switching function at a given date.

Parameters:

date - date of computation

Returns:

value of the switching function

Throws:

PatriusException

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)

isInEclipse

public boolean isInEclipse(AbsoluteDate date)
                    throws PatriusException

Get the eclipse flag.

Parameters:

date - the current date

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)

copy

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