fr.cnes.sirius.patrius.events.detectors

Class LineMaskingDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

fr.cnes.sirius.patrius.events.detectors.LineMaskingDetector

All Implemented Interfaces:

EventDetector, Serializable

public class LineMaskingDetector
extends AbstractSignalPropagationDetector

Detector for events relative to masking of two PVCoordinatesProvider points by a list of BodyShape masking bodies. The two points are linked by a Line representation over time.

The g function is positive if the line (not infinite) does not intersect any masking body. If one masking body is intersected, then the g function becomes negative.

Warning: Constructing the detector providing the propagator as the mainElement PVCoordinatesProvider might cause a StackOverFlow error in LIGHT_SPEED mode, because the g function will ask the propagator to evaluate a specific date and the propagator will then call the g function.

This detector can take into account both signal propagation types INSTANTANEOUS and LIGHT_SPEED.
For the latter case, the main element (spacecraft) is considered as the signal emitter or receiver depending on its defined role and the other element being the receiver or emitter as a result.

Since:

4.16

Author:

Thibaut BONIT HISTORY VERSION:4.16:OPENFD-550:25/04/2025:[PATRIUS] Detecteur de masquage par un corps celeste END-HISTORY

See Also:

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.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
LineMaskingDetector(PVCoordinatesProvider mainElement, LinkTypeHandler.SignalPropagationRole mainRole, PVCoordinatesProvider otherElement, List<BodyShape> maskingBodies) Builds a line masking detector.
LineMaskingDetector(PVCoordinatesProvider mainElement, LinkTypeHandler.SignalPropagationRole mainRole, PVCoordinatesProvider otherElement, List<BodyShape> maskingBodies, double maxCheck, double threshold) Builds a line masking detector.
LineMaskingDetector(PVCoordinatesProvider mainElement, LinkTypeHandler.SignalPropagationRole mainRole, PVCoordinatesProvider otherElement, List<BodyShape> maskingBodies, double maxCheck, double threshold, EventDetector.Action start, EventDetector.Action end, boolean removeAtStart, boolean removeAtEnd) Builds a line masking detector.
LineMaskingDetector(PVCoordinatesProvider mainElement, LinkTypeHandler.SignalPropagationRole mainRole, PVCoordinatesProvider otherElement, List<BodyShape> maskingBodies, int slopeSelection, double maxCheck, double threshold, EventDetector.Action start, EventDetector.Action end, boolean removeAtStart, boolean removeAtEnd) Builds a line masking detector.

Method Summary

Modifier and Type	Method and Description
LineMaskingDetector	copy() A copy of the detector.
double	g(SpacecraftState s) Compute the value of the switching function.
PVCoordinatesProvider	getMainElement() Getter for the main element position point (can be null).
List<BodyShape>	getMaskingBodies() Getter for the masking bodies.
boolean	isDirectionOcculted(Propagator satProp, AbsoluteDate date) Assess if direction is occulted for entered spacecraft state.

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

getEmitter, getEpsilonSignalPropagation, getEventDatationType, getInertialFrame, getLinkTypeHandler, getMaxIterSignalPropagation, getOtherDate, getPropagationDelayType, getReceiver, getSignalEmissionDate, getSignalEmissionDate, getSignalReceptionDate, getSignalReceptionDate, setEpsilonSignalPropagation, setMaxIterSignalPropagation, setPropagationDelayType

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

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

LineMaskingDetector

public LineMaskingDetector(PVCoordinatesProvider mainElement,
                           LinkTypeHandler.SignalPropagationRole mainRole,
                           PVCoordinatesProvider otherElement,
                           List<BodyShape> maskingBodies)

Builds a line masking detector.

This constructor takes default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

The default implementation slope selection is set to EventDetector.INCREASING_DECREASING, hence the detector will detect start & end masking events.

The default implementation behavior is to continue propagation at start masking and to continue propagation when masking ends while keeping the detector.

Parameters:

mainElement - PVCoordinatesProvider of the initial point from which to compute the line of sight (if null, s.getOrbit() will be used in the g(s) function)

mainRole - role of the main element (EMITTER or RECEIVER)

otherElement - PVCoordinatesProvider of the other element to compute the line of sight

maskingBodies - list of bodies to check for masking

Throws:

IllegalArgumentException - if the masking bodies list is empty

LineMaskingDetector

public LineMaskingDetector(PVCoordinatesProvider mainElement,
                           LinkTypeHandler.SignalPropagationRole mainRole,
                           PVCoordinatesProvider otherElement,
                           List<BodyShape> maskingBodies,
                           double maxCheck,
                           double threshold)

Builds a line masking detector.

The default implementation slope selection is set to EventDetector.INCREASING_DECREASING, hence the detector will detect start & end masking events.

The default implementation behavior is to continue propagation at start masking and to continue propagation when masking ends while keeping the detector.

Parameters:

mainElement - PVCoordinatesProvider of the initial point from which to compute the line of sight (if null, s.getOrbit() will be used in the g(s) function)

mainRole - role of the main element (EMITTER or RECEIVER)

otherElement - PVCoordinatesProvider of the other element to compute the line of sight

maskingBodies - list of bodies to check for masking

maxCheck - value for maximal checking interval

threshold - convergence threshold

Throws:

IllegalArgumentException - if the masking bodies list is empty

LineMaskingDetector

public LineMaskingDetector(PVCoordinatesProvider mainElement,
                           LinkTypeHandler.SignalPropagationRole mainRole,
                           PVCoordinatesProvider otherElement,
                           List<BodyShape> maskingBodies,
                           double maxCheck,
                           double threshold,
                           EventDetector.Action start,
                           EventDetector.Action end,
                           boolean removeAtStart,
                           boolean removeAtEnd)

Builds a line masking detector.

The default implementation slope selection is set to EventDetector.INCREASING_DECREASING, hence the detector will detect start & end masking events.

Parameters:

mainElement - PVCoordinatesProvider of the initial point from which to compute the line of sight (if null, s.getOrbit() will be used in the g(s) function)

mainRole - role of the main element (EMITTER or RECEIVER)

otherElement - PVCoordinatesProvider of the other element to compute the line of sight

maskingBodies - list of bodies to check for masking

maxCheck - value for maximal checking interval

threshold - convergence threshold

start - Action for propagation at start masking

end - Action for propagation at end masking

removeAtStart - States if the detector should be removed at start masking event detection

removeAtEnd - States if the detector should be removed at end masking event detection

Throws:

IllegalArgumentException - if the masking bodies list is empty

LineMaskingDetector

public LineMaskingDetector(PVCoordinatesProvider mainElement,
                           LinkTypeHandler.SignalPropagationRole mainRole,
                           PVCoordinatesProvider otherElement,
                           List<BodyShape> maskingBodies,
                           int slopeSelection,
                           double maxCheck,
                           double threshold,
                           EventDetector.Action start,
                           EventDetector.Action end,
                           boolean removeAtStart,
                           boolean removeAtEnd)

Builds a line masking detector.

Parameters:

mainElement - PVCoordinatesProvider of the initial point from which to compute the line of sight (if null, s.getOrbit() will be used in the g(s) function)

mainRole - role of the main element (EMITTER or RECEIVER)

otherElement - PVCoordinatesProvider of the other element to compute the line of sight

maskingBodies - list of bodies to check for masking

slopeSelection - g-function slope selection (0, 1, or 2)

maxCheck - value for maximal checking interval

threshold - convergence threshold

start - Action for propagation at start masking

end - Action for propagation at end masking

removeAtStart - States if the detector should be removed at start masking event detection

removeAtEnd - States if the detector should be removed at end masking event detection

Throws:

IllegalArgumentException - if the masking bodies list is empty

Method Detail

getMainElement

public PVCoordinatesProvider getMainElement()

Getter for the main element position point (can be null).

Returns:

the main element position point

getMaskingBodies

public List<BodyShape> getMaskingBodies()

Getter for the masking bodies.

Returns:

the masking bodies

isDirectionOcculted

public boolean isDirectionOcculted(Propagator satProp,
                                   AbsoluteDate date)
                            throws PatriusException

Assess if direction is occulted for entered spacecraft state.

Parameters:

satProp - spacecraft orbit propagator

date - assessment date

Returns:

true if direction is occulted, false if not occulted

Throws:

PatriusException - if some specific error occurs

g

public double g(SpacecraftState s)
         throws PatriusException

Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector

Parameters:

s - the current state information: date, kinematics, attitude for forces and events computation, mass provider, and additional states

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

copy

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

Returns:

a copy of the detector.