fr.cnes.sirius.patrius.events.detectors

Class DotProductDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.DotProductDetector

All Implemented Interfaces:

EventDetector, Serializable

public final class DotProductDetector
extends AbstractDetector

Detects when the dot product value between a spacecraft and a target PV coordinates reaches a threshold value.

Since:

4.11

See Also:

Serialized Form

Nested Class Summary

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
DotProductDetector(IDirection target, boolean normalizePos, boolean normalizeTarget, double dotProduct, Frame projectionFrame, int slopeSelectionIn) Constructor for an DotProductPassageDetector instance.
DotProductDetector(IDirection target, boolean normalizePos, boolean normalizeTarget, double dotProduct, Frame projectionFrame, int slopeSelectionIn, double maxCheck, double threshold) Constructor for an DotProductPassageDetector instance with complementary parameters.
DotProductDetector(IDirection target, boolean normalizePos, boolean normalizeTarget, double dotProduct, Frame projectionFrame, int slopeSelectionIn, double maxCheck, double threshold, EventDetector.Action ascending, EventDetector.Action descending) Constructor for an DotProductPassageDetector instance with complementary parameters.
DotProductDetector(IDirection referenceDirection, IDirection targetDirection, boolean normalizePos, boolean normalizeTarget, double dotProduct, Frame projectionFrame, int slopeSelectionIn, double maxCheck, double threshold, EventDetector.Action ascending, EventDetector.Action descending) Constructor for an DotProductPassageDetector instance with complementary parameters.
DotProductDetector(PVCoordinatesProvider target, boolean normalizePos, boolean normalizeTarget, double dotProduct, Frame projectionFrame, int slopeSelectionIn) Constructor for an DotProductPassageDetector instance.
DotProductDetector(PVCoordinatesProvider target, boolean normalizePos, boolean normalizeTarget, double dotProduct, Frame projectionFrame, int slopeSelectionIn, double maxCheck, double threshold) Constructor for an DotProductPassageDetector instance with complementary parameters.
DotProductDetector(PVCoordinatesProvider target, boolean normalizePos, boolean normalizeTarget, double dotProduct, Frame projectionFrame, int slopeSelectionIn, double maxCheck, double threshold, EventDetector.Action ascending, EventDetector.Action descending) Constructor for an DotProductPassageDetector instance with complementary parameters.

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 angular momentum excess event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.

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

DotProductDetector

public DotProductDetector(PVCoordinatesProvider target,
                          boolean normalizePos,
                          boolean normalizeTarget,
                          double dotProduct,
                          Frame projectionFrame,
                          int slopeSelectionIn)

Constructor for an DotProductPassageDetector instance.

Parameters:

target - second coordinates provider.

normalizePos - first coordinates normalize.

normalizeTarget - second coordinates normalize.

dotProduct - threshold value of the dot product

projectionFrame - frame with respect to which the vectors are projected

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

DotProductDetector

public DotProductDetector(PVCoordinatesProvider target,
                          boolean normalizePos,
                          boolean normalizeTarget,
                          double dotProduct,
                          Frame projectionFrame,
                          int slopeSelectionIn,
                          double maxCheck,
                          double threshold)

Constructor for an DotProductPassageDetector instance with complementary parameters.

Parameters:

target - second coordinates provider.

normalizePos - first coordinates normalize.

normalizeTarget - second coordinates normalize.

dotProduct - threshold value of the dot product

projectionFrame - frame with respect to which the vectors are projected

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

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

DotProductDetector

public DotProductDetector(PVCoordinatesProvider target,
                          boolean normalizePos,
                          boolean normalizeTarget,
                          double dotProduct,
                          Frame projectionFrame,
                          int slopeSelectionIn,
                          double maxCheck,
                          double threshold,
                          EventDetector.Action ascending,
                          EventDetector.Action descending)

Constructor for an DotProductPassageDetector instance with complementary parameters.

Parameters:

target - second coordinates provider.

normalizePos - first coordinates normalize.

normalizeTarget - second coordinates normalize.

dotProduct - threshold value of the dot product

projectionFrame - frame with respect to which the vectors are projected

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

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

ascending - action performed when ascending

descending - action performed when descending

DotProductDetector

public DotProductDetector(IDirection target,
                          boolean normalizePos,
                          boolean normalizeTarget,
                          double dotProduct,
                          Frame projectionFrame,
                          int slopeSelectionIn)

Constructor for an DotProductPassageDetector instance.

Parameters:

target - second coordinates provider.

normalizePos - first coordinates normalize.

normalizeTarget - second coordinates normalize.

dotProduct - threshold value of the dot product

projectionFrame - frame with respect to which the vectors are projected

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

DotProductDetector

public DotProductDetector(IDirection target,
                          boolean normalizePos,
                          boolean normalizeTarget,
                          double dotProduct,
                          Frame projectionFrame,
                          int slopeSelectionIn,
                          double maxCheck,
                          double threshold)

Constructor for an DotProductPassageDetector instance with complementary parameters.

Parameters:

target - second coordinates provider.

normalizePos - first coordinates normalize.

normalizeTarget - second coordinates normalize.

dotProduct - threshold value of the dot product

projectionFrame - frame with respect to which the vectors are projected

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

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

DotProductDetector

public DotProductDetector(IDirection target,
                          boolean normalizePos,
                          boolean normalizeTarget,
                          double dotProduct,
                          Frame projectionFrame,
                          int slopeSelectionIn,
                          double maxCheck,
                          double threshold,
                          EventDetector.Action ascending,
                          EventDetector.Action descending)

Constructor for an DotProductPassageDetector instance with complementary parameters.

Parameters:

target - second coordinates provider.

normalizePos - first coordinates normalize.

normalizeTarget - second coordinates normalize.

dotProduct - threshold value of the dot product

projectionFrame - frame with respect to which the vectors are projected

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

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

ascending - action performed when ascending

descending - action performed when descending

DotProductDetector

public DotProductDetector(IDirection referenceDirection,
                          IDirection targetDirection,
                          boolean normalizePos,
                          boolean normalizeTarget,
                          double dotProduct,
                          Frame projectionFrame,
                          int slopeSelectionIn,
                          double maxCheck,
                          double threshold,
                          EventDetector.Action ascending,
                          EventDetector.Action descending)

Constructor for an DotProductPassageDetector instance with complementary parameters.

Parameters:

referenceDirection - first coordinates provider.

targetDirection - second coordinates provider.

normalizePos - first coordinates normalize.

normalizeTarget - second coordinates normalize.

dotProduct - threshold value of the dot product

projectionFrame - frame with respect to which the vectors are projected

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

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

ascending - action performed when ascending

descending - action performed when descending

Method Detail

eventOccurred

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

Handle an angular momentum excess 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 angular momentum excess is reached.

Throws:

PatriusException - if some specific error occurs

g

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

Returns:

a copy of the detector.