fr.cnes.sirius.patrius.events.detectors

Class AbstractSignalPropagationDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

All Implemented Interfaces:

EventDetector, Serializable

Direct Known Subclasses:

AbstractStationToSatDetector, ApparentElevationDetector, BetaAngleDetector, CentralBodyMaskCircularFOVDetector, CircularFieldOfViewDetector, DihedralFieldOfViewDetector, EclipseDetector, ExtremaElevationDetector, ExtremaSightAxisDetector, GroundMaskElevationDetector, LocalTimeAngleDetector, MaskingDetector, NadirSolarIncidenceDetector, RFVisibilityDetector, SatToSatMutualVisibilityDetector, SensorInhibitionDetector, SensorVisibilityDetector, SolarTimeAngleDetector, TargetInFieldOfViewDetector

public abstract class AbstractSignalPropagationDetector
extends AbstractDetector

Common parts shared by several events finders related to signal propagation concept.
A default implementation of most of the methods of EventDetector Interface.
Make it easier to create a new detector.

Since:

4.13

Author:

Thibaut BONIT

See Also:

AbstractDetector, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSignalPropagationDetector.DatationChoice Describe if the datation choice corresponds to the emitter date or the receiver date.
static class	AbstractSignalPropagationDetector.PropagationDelayType Propagation delay type.

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
AbstractSignalPropagationDetector(double maxCheckIn, double thresholdIn) Build a new instance.
AbstractSignalPropagationDetector(double maxCheckIn, double thresholdIn, EventDetector.Action actionAtEntryIn, EventDetector.Action actionAtExitIn, boolean removeAtEntryIn, boolean removeAtExitIn) Build a new instance.
AbstractSignalPropagationDetector(int slopeSelectionIn, double maxCheckIn, double thresholdIn) Build a new instance.
AbstractSignalPropagationDetector(int slopeSelectionIn, double maxCheckIn, double thresholdIn, EventDetector.Action actionIn, boolean removeIn) Build a new instance.
AbstractSignalPropagationDetector(int slopeSelectionIn, double maxCheckIn, double thresholdIn, EventDetector.Action actionAtEntryIn, EventDetector.Action actionAtExitIn, boolean removeAtEntryIn, boolean removeAtExitIn) Build a new instance.

Method Summary

Modifier and Type	Method and Description
abstract AbstractSignalPropagationDetector.DatationChoice	getDatationChoice() Specify if the datation choice corresponds to the emitter date or the receiver date.
abstract PVCoordinatesProvider	getEmitter(SpacecraftState s) Getter for the signal emitter.
double	getEpsilonSignalPropagation() Getter for the epsilon for signal propagation when signal propagation is taken into account.
Frame	getInertialFrame() Getter for the inertial frame used for signal propagation computation.
int	getMaxIterSignalPropagation() Getter for the maximum number of iterations for signal propagation when signal propagation is taken into account.
AbstractSignalPropagationDetector.PropagationDelayType	getPropagationDelayType() Getter for the propagation delay type.
abstract PVCoordinatesProvider	getReceiver(SpacecraftState s) Getter for the signal receiver.
AbsoluteDate	getSignalEmissionDate(PVCoordinatesProvider emitter, PVCoordinatesProvider orbit, AbsoluteDate date) Compute the signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractSignalPropagationDetector.PropagationDelayType.
AbsoluteDate	getSignalEmissionDate(SpacecraftState s) Compute the signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractSignalPropagationDetector.PropagationDelayType.
AbsoluteDate	getSignalReceptionDate(PVCoordinatesProvider receiver, PVCoordinatesProvider orbit, AbsoluteDate date) Compute the signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractSignalPropagationDetector.PropagationDelayType.
AbsoluteDate	getSignalReceptionDate(SpacecraftState s) Compute the signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractSignalPropagationDetector.PropagationDelayType.
void	setEpsilonSignalPropagation(double epsilon) Setter for the epsilon for signal propagation when signal propagation is taken into account. This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver)
void	setMaxIterSignalPropagation(int maxIterSignalPropagationIn) Setter for the maximum number of iterations for signal propagation when signal propagation is taken into account.
void	setPropagationDelayType(AbstractSignalPropagationDetector.PropagationDelayType propagationDelayTypeIn, Frame frameIn) Setter for the propagation delay computation type.

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

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

Methods inherited from interface fr.cnes.sirius.patrius.events.EventDetector

copy

Constructor Detail

AbstractSignalPropagationDetector

public AbstractSignalPropagationDetector(double maxCheckIn,
                                         double thresholdIn)

Build a new instance. The detector will detect both ascending and descending g-function related events.

Parameters:

maxCheckIn - maximum checking interval (s)

thresholdIn - convergence threshold (s)

AbstractSignalPropagationDetector

public AbstractSignalPropagationDetector(int slopeSelectionIn,
                                         double maxCheckIn,
                                         double thresholdIn)

Build a new instance.

Parameters:

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

maxCheckIn - maximum checking interval (s)

thresholdIn - convergence threshold (s)

AbstractSignalPropagationDetector

public AbstractSignalPropagationDetector(int slopeSelectionIn,
                                         double maxCheckIn,
                                         double thresholdIn,
                                         EventDetector.Action actionIn,
                                         boolean removeIn)

Build a new instance.

Parameters:

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

maxCheckIn - maximum checking interval (s)

thresholdIn - convergence threshold (s)

actionIn - action performed when entering/exiting the eclipse depending on slope selection

removeIn - when the spacecraft point enters or exit the zone depending on slope selection

AbstractSignalPropagationDetector

public AbstractSignalPropagationDetector(double maxCheckIn,
                                         double thresholdIn,
                                         EventDetector.Action actionAtEntryIn,
                                         EventDetector.Action actionAtExitIn,
                                         boolean removeAtEntryIn,
                                         boolean removeAtExitIn)

Build a new instance. The detector will detect both ascending and descending g-function related events.

Parameters:

maxCheckIn - maximum checking interval (s)

thresholdIn - convergence threshold (s)

actionAtEntryIn - action performed at increasing event detection

actionAtExitIn - action performed at decreasing event detection

removeAtEntryIn - states if the detector should be removed at increasing event detection

removeAtExitIn - states if the detector should be removed at decreasing event detection

AbstractSignalPropagationDetector

public AbstractSignalPropagationDetector(int slopeSelectionIn,
                                         double maxCheckIn,
                                         double thresholdIn,
                                         EventDetector.Action actionAtEntryIn,
                                         EventDetector.Action actionAtExitIn,
                                         boolean removeAtEntryIn,
                                         boolean removeAtExitIn)

Build a new instance.

Parameters:

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

maxCheckIn - maximum checking interval (s)

thresholdIn - convergence threshold (s)

actionAtEntryIn - action performed at increasing event detection

actionAtExitIn - action performed at decreasing event detection

removeAtEntryIn - states if the detector should be removed at increasing event detection

removeAtExitIn - states if the detector should be removed at decreasing event detection

Method Detail

getEmitter

public abstract PVCoordinatesProvider getEmitter(SpacecraftState s)

Getter for the signal emitter.

Parameters:

s - the spacecraft state used by the detector

Returns:

the signal emitter

getReceiver

public abstract PVCoordinatesProvider getReceiver(SpacecraftState s)

Getter for the signal receiver.

Parameters:

s - the spacecraft state used by the detector

Returns:

the signal receiver

getDatationChoice

public abstract AbstractSignalPropagationDetector.DatationChoice getDatationChoice()

Specify if the datation choice corresponds to the emitter date or the receiver date.

Returns:

the corresponding datation choice

setPropagationDelayType

public void setPropagationDelayType(AbstractSignalPropagationDetector.PropagationDelayType propagationDelayTypeIn,
                                    Frame frameIn)

Setter for the propagation delay computation type. Warning: check Javadoc of detector to see if detector takes into account propagation time delay. if not, signals are always considered instantaneous. The provided frame is used to compute the signal propagation when delay is taken into account.

Parameters:

propagationDelayTypeIn - Propagation delay type used in events computation

frameIn - Frame to use for signal propagation with delay (may be null if propagation delay type is considered instantaneous). Warning: the usage of a pseudo inertial frame is tolerated, however it will lead to some inaccuracies due to the non-invariance of the frame with respect to time. For this reason, it is suggested to use the ICRF frame or a frame which is frozen with respect to the ICRF.

Throws:

IllegalArgumentException - if the provided frame is not pseudo inertial.

getSignalEmissionDate

public AbsoluteDate getSignalEmissionDate(SpacecraftState s)
                                   throws PatriusException

Compute the signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractSignalPropagationDetector.PropagationDelayType.

Parameters:

s - the spacecraft state used by the detector

Returns:

the signal emission date

Throws:

PatriusException - if computation failed

getSignalEmissionDate

public AbsoluteDate getSignalEmissionDate(PVCoordinatesProvider emitter,
                                          PVCoordinatesProvider orbit,
                                          AbsoluteDate date)
                                   throws PatriusException

Compute the signal emission date which is the date at which the signal received by the spacecraft (receiver) has been emitted by the emitter depending on AbstractSignalPropagationDetector.PropagationDelayType.

Parameters:

emitter - Emitter

orbit - Orbit of the spacecraft (receiver)

date - Date at which the spacecraft orbit is defined

Returns:

the signal emission date

Throws:

PatriusException - if computation failed

getSignalReceptionDate

public AbsoluteDate getSignalReceptionDate(SpacecraftState s)
                                    throws PatriusException

Compute the signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractSignalPropagationDetector.PropagationDelayType.

Parameters:

s - the spacecraft state used by the detector

Returns:

the signal reception date

Throws:

PatriusException - thrown if computation failed

getSignalReceptionDate

public AbsoluteDate getSignalReceptionDate(PVCoordinatesProvider receiver,
                                           PVCoordinatesProvider orbit,
                                           AbsoluteDate date)
                                    throws PatriusException

Compute the signal reception date which is the date at which the signal emitted by the spacecraft (emitter) has been received by the receiver depending on AbstractSignalPropagationDetector.PropagationDelayType.

Parameters:

receiver - Receiver

orbit - Orbit of the spacecraft (emitter)

date - Date at which the spacecraft orbit is defined

Returns:

the signal reception date

Throws:

PatriusException - thrown if computation failed

getPropagationDelayType

public AbstractSignalPropagationDetector.PropagationDelayType getPropagationDelayType()

Getter for the propagation delay type.

Returns:

the propagation delay type

getInertialFrame

public Frame getInertialFrame()

Getter for the inertial frame used for signal propagation computation.

Returns:

the inertial frame

setEpsilonSignalPropagation

public void setEpsilonSignalPropagation(double epsilon)

Setter for the epsilon for signal propagation when signal propagation is taken into account.
This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver)

Parameters:

epsilon - Epsilon for the signal propagation

getEpsilonSignalPropagation

public double getEpsilonSignalPropagation()

Getter for the epsilon for signal propagation when signal propagation is taken into account.

Returns:

the epsilon for signal propagation when signal propagation is taken into account

setMaxIterSignalPropagation

public void setMaxIterSignalPropagation(int maxIterSignalPropagationIn)

Setter for the maximum number of iterations for signal propagation when signal propagation is taken into account.

Parameters:

maxIterSignalPropagationIn - Maximum number of iterations for signal propagation

getMaxIterSignalPropagation

public int getMaxIterSignalPropagation()

Getter for the maximum number of iterations for signal propagation when signal propagation is taken into account.

Returns:

the maximum number of iterations for signal propagation