fr.cnes.sirius.patrius.events.detectors

Class SolarTimeAngleDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

fr.cnes.sirius.patrius.events.detectors.SolarTimeAngleDetector

All Implemented Interfaces:

EventDetector, Serializable

public class SolarTimeAngleDetector
extends AbstractSignalPropagationDetector

Detects when the solar time angle of a spacecraft is equal to a predetermined value.
The solar time is represented by the angle between the projections of the Sun in the osculator orbital plane and the satellite position; therefore this angle is equal to zero when the solar time is 12.00h and Π when the solar time is 0.00h (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

The default implementation is to stop propagation when the solar time is reached. This can be changed by using provided constructors.

This detector can takes into account signal propagation duration through AbstractSignalPropagationDetector.setPropagationDelayType(PropagationDelayType, Frame) (default is signal being instantaneous).

Since:

1.2

Version:

$Id: SolarTimeAngleDetector.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Tiziana Sabatini

See Also:

EventDetector, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

attributes are mutable and related to propagation.

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
SolarTimeAngleDetector(double solarTimeAngle) Constructor for a SolarTimeDetector instance.
SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold) Constructor for a SolarTimeDetector instance with complimentary parameters.
SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold, CelestialBodyFrame frame) Constructor for a SolarTimeDetector instance with complimentary parameters.
SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold, CelestialBodyFrame frame, EventDetector.Action action) Constructor for a SolarTimeDetector instance with complimentary parameters.
SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold, CelestialBodyFrame frame, EventDetector.Action action, boolean remove) Constructor for a SolarTimeDetector instance with complimentary parameters.
SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold, EventDetector.Action action) Constructor for a SolarTimeDetector instance with complimentary parameters.
SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for a SolarTimeDetector instance with complimentary parameters.
SolarTimeAngleDetector(double solarTimeAngle, PVCoordinatesProvider sunModel, double maxCheck, double threshold, CelestialBodyFrame frame, EventDetector.Action action, boolean remove) Constructor for a SolarTimeDetector instance with complimentary parameters.
SolarTimeAngleDetector(double solarTimeAngle, PVCoordinatesProvider sunModel, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for a SolarTimeDetector instance with complimentary 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 a solar time angle event and choose what to do next.
double	g(SpacecraftState state) Compute the value of the switching function.
CelestialBodyFrame	getFrame() Returns the frame used for solar time computation.
double	getTime() Get solar time angle to detect.
void	init(SpacecraftState s0, AbsoluteDate t) Initialize event handler at the start of a propagation.
void	setPropagationDelayType(AbstractSignalPropagationDetector.PropagationDelayType propagationDelayType, Frame frameIn) Setter for the propagation delay computation type.

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

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

filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, 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

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle)
                       throws PatriusException

Constructor for a SolarTimeDetector instance.

Solar time will be computed in satellite orbit frame.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              double maxCheck,
                              double threshold)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Solar time will be computed in satellite orbit frame.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              double maxCheck,
                              double threshold,
                              CelestialBodyFrame frame)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

frame - in relation to which the calculations are made

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              double maxCheck,
                              double threshold,
                              EventDetector.Action action)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Solar time will be computed in satellite orbit frame.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

action - action performed at solar time detection

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              double maxCheck,
                              double threshold,
                              CelestialBodyFrame frame,
                              EventDetector.Action action)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

action - action performed at solar time detection

frame - in relation to which the calculations are made

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              double maxCheck,
                              double threshold,
                              EventDetector.Action action,
                              boolean remove)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Solar time will be computed in satellite orbit frame.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

action - action performed at solar time detection

remove - true if detector should be removed

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

Since:

3.1

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              double maxCheck,
                              double threshold,
                              CelestialBodyFrame frame,
                              EventDetector.Action action,
                              boolean remove)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

action - action performed at solar time detection

remove - true if detector should be removed

frame - in relation to which the calculations are made

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

Since:

3.1

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              PVCoordinatesProvider sunModel,
                              double maxCheck,
                              double threshold,
                              EventDetector.Action action,
                              boolean remove)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Solar time will be computed in satellite orbit frame.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

sunModel - Sun model

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

action - action performed at solar time detection

remove - true if detector should be removed

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

Since:

4.3

SolarTimeAngleDetector

public SolarTimeAngleDetector(double solarTimeAngle,
                              PVCoordinatesProvider sunModel,
                              double maxCheck,
                              double threshold,
                              CelestialBodyFrame frame,
                              EventDetector.Action action,
                              boolean remove)
                       throws PatriusException

Constructor for a SolarTimeDetector instance with complimentary parameters.

Parameters:

solarTimeAngle - satellite solar time angle triggering the event (in the range [-Π, Π[). Angle between the projection of the Sun in the osculator orbital plane and the satellite position (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).

sunModel - Sun model

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

action - action performed at solar time detection

remove - true if detector should be removed

frame - in relation to which the calculations are made

Throws:

PatriusException - error when loading the ephemeris files or solar time angle not in the range [-Π, Π[

Since:

4.11

Method Detail

eventOccurred

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

Handle a solar time angle event and choose what to do next.

The default implementation behavior is to stop propagation when the solar time is reached.

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 time increases around event.

forward - if true, the integration variable (time) increases during integration.

Returns:

the action performed when the expected solar time is reached

Throws:

PatriusException - if some specific error occurs

g

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

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

init

public void init(SpacecraftState s0,
                 AbsoluteDate t)

Initialize event handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.

Specified by:

init in interface EventDetector

Overrides:

init in class AbstractDetector

Parameters:

s0 - initial state

t - target time for the integration

getTime

public double getTime()

Get solar time angle to detect.

Returns:

the solar time angle triggering the event.

getFrame

public CelestialBodyFrame getFrame()

Returns the frame used for solar time computation.

Returns:

the frame used for solar time computation

setPropagationDelayType

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

Description copied from class: AbstractSignalPropagationDetector

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.

Overrides:

setPropagationDelayType in class AbstractSignalPropagationDetector

Parameters:

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

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.