Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.orekit.propagation.events
Class EclipseDetector

java.lang.Object
  extended by org.orekit.propagation.events.AbstractDetector
      extended by org.orekit.propagation.events.EclipseDetector
All Implemented Interfaces:
Serializable, EventDetector
public class EclipseDetector
extends AbstractDetector

Finder for satellite eclipse related events.

This class finds eclipse events, i.e. satellite within umbra (total eclipse) or penumbra (partial eclipse).

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse. This can be changed by using the following constructors:

Author:
Pascal Parraud
See Also:
Propagator.addEventDetector(EventDetector), Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.orekit.propagation.events.EventDetector
EventDetector.Action
 
Field Summary
 
Fields inherited from class org.orekit.propagation.events.AbstractDetector
DEFAULT_MAXCHECK, DEFAULT_THRESHOLD
 
Fields inherited from interface org.orekit.propagation.events.EventDetector
DECREASING, INCREASING, INCREASING_DECREASING
 
Constructor Summary
EclipseDetector(IDirection occulted, PVCoordinatesProvider occulting, double occultingRadius, double maxCheck, double threshold)
          Build a new eclipse detector.
EclipseDetector(IDirection occulted, PVCoordinatesProvider occulting, double occultingRadius, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit)
          Build a new eclipse detector with defined actions when entering and exiting the eclipse.
EclipseDetector(IDirection occulted, PVCoordinatesProvider occulting, double occultingRadius, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit)
          Build a new eclipse detector with defined actions when entering and exiting the eclipse.
EclipseDetector(PVCoordinatesProvider occultedBody, double occultedBodyRadius, GeometricBodyShape occultingBody, boolean totalEclipseFlag)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occultedBody, double occultedBodyRadius, GeometricBodyShape occultingBody, boolean totalEclipseFlag, double maxCheck, double threshold)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, GeometricBodyShape occultingBody, double lightingRatio, double maxCheck, double threshold)
          Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, GeometricBodyShape occultingBody, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit)
          Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, GeometricBodyShape occultingBody, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit)
          Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, boolean totalEclipse)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, boolean totalEclipse, double maxCheck)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, boolean totalEclipse, double maxCheck, double threshold)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, double maxCheck)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, double maxCheck, double threshold)
          Deprecated. 
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, double lightingRatio, double maxCheck, double threshold)
          Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit)
          Build a new eclipse detector based on a lighting ratio.
EclipseDetector(PVCoordinatesProvider occulted, double occultedRadius, PVCoordinatesProvider occulting, double occultingRadius, double lightingRatio, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit)
          Build a new eclipse detector based on a lighting ratio.
 
Method Summary
 EventDetector.Action eventOccurred(SpacecraftState s, boolean increasing, boolean forward)
          Handle an eclipse event and choose what to do next.
 double g(SpacecraftState s)
          Compute the value of the switching function.
 PVCoordinatesProvider getOcculted()
          Get the occulted body.
 IDirection getOccultedDirection()
           
 double getOccultedRadius()
          Get the occulted body radius (m).
 PVCoordinatesProvider getOcculting()
          Get the occulting body.
 boolean isTotalEclipse()
          Get the total eclipse detection flag.
 boolean shouldBeRemoved()
          This method is called after EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean) has been triggered.
 
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, resetState
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occultedBody,
                                  double occultedBodyRadius,
                                  GeometricBodyShape occultingBody,
                                  boolean totalEclipseFlag)
Deprecated. 

Build a new eclipse detector.

The new instance is either an umbra detector or a penumbra detector with default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

Parameters:
occultedBody - the body to be occulted
occultedBodyRadius - the radius of the body to be occulted (m)
occultingBody - the occulting body
totalEclipseFlag - umbra (true) or penumbra (false) detection flag

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occultedBody,
                                  double occultedBodyRadius,
                                  GeometricBodyShape occultingBody,
                                  boolean totalEclipseFlag,
                                  double maxCheck,
                                  double threshold)
Deprecated. 

Build a new eclipse detector.

The new instance is either an umbra detector or a penumbra detector with default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

Parameters:
occultedBody - the body to be occulted
occultedBodyRadius - the radius of the body to be occulted (m)
occultingBody - the occulting body
totalEclipseFlag - umbra (true) or penumbra (false) detection flag
maxCheck - maximum checking interval (s)
threshold - convergence threshold (s)

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occulted,
                                  double occultedRadius,
                                  PVCoordinatesProvider occulting,
                                  double occultingRadius,
                                  boolean totalEclipse)
Deprecated. 

Build a new eclipse detector.

The new instance is either an umbra detector or a penumbra detector with default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

Parameters:
occulted - the body to be occulted
occultedRadius - the radius of the body to be occulted (m)
occulting - the occulting body
occultingRadius - the occulting body radius (m)
totalEclipse - umbra (true) or penumbra (false) detection flag

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occulted,
                                  double occultedRadius,
                                  PVCoordinatesProvider occulting,
                                  double occultingRadius,
                                  boolean totalEclipse,
                                  double maxCheck)
Deprecated. 

Build a new eclipse detector.

The new instance is either an umbra detector or a penumbra detector with default value for convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

The maximal interval between eclipse checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:
occulted - the body to be occulted
occultedRadius - the radius of the body to be occulted (m)
occulting - the occulting body
occultingRadius - the occulting body radius (m)
totalEclipse - umbra (true) or penumbra (false) detection flag
maxCheck - maximal checking interval (s)

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occulted,
                                  double occultedRadius,
                                  PVCoordinatesProvider occulting,
                                  double occultingRadius,
                                  boolean totalEclipse,
                                  double maxCheck,
                                  double threshold)
Deprecated. 

Build a new eclipse detector .

The new instance is either an umbra detector or a penumbra detector.

The maximal interval between eclipse checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:
occulted - the body to be occulted
occultedRadius - the radius of the body to be occulted (m)
occulting - the occulting body
occultingRadius - the occulting body radius (m)
totalEclipse - umbra (true) or penumbra (false) detection flag
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occulted,
                                  double occultedRadius,
                                  PVCoordinatesProvider occulting,
                                  double occultingRadius)
Deprecated. 

Build a new eclipse detector.

The new instance is a total eclipse (umbra) detector with default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

Parameters:
occulted - the body to be occulted
occultedRadius - the radius of the body to be occulted (m)
occulting - the occulting body
occultingRadius - the occulting body radius (m)

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occulted,
                                  double occultedRadius,
                                  PVCoordinatesProvider occulting,
                                  double occultingRadius,
                                  double maxCheck)
Deprecated. 

Build a new eclipse detector.

The new instance is a total eclipse (umbra) detector with default value for convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

The maximal interval between eclipse checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:
occulted - the body to be occulted
occultedRadius - the radius of the body to be occulted in meters
occulting - the occulting body
occultingRadius - the occulting body radius in meters
maxCheck - maximal checking interval (s)

EclipseDetector

@Deprecated
public EclipseDetector(PVCoordinatesProvider occulted,
                                  double occultedRadius,
                                  PVCoordinatesProvider occulting,
                                  double occultingRadius,
                                  double maxCheck,
                                  double threshold)
Deprecated. 

Build a new eclipse detector.

The new instance is a total eclipse (umbra) detector.

The maximal interval between eclipse checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:
occulted - the body to be occulted
occultedRadius - the radius of the body to be occulted in meters
occulting - the occulting body
occultingRadius - the occulting body radius in meters
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)

EclipseDetector

public EclipseDetector(IDirection occulted,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double maxCheck,
                       double threshold)
Build a new eclipse detector.

The occulting body is a sphere and the occulted body is a direction; the concept of umbra/penumbra does not apply to this detector.

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse.

Parameters:
occulted - the direction to be occulted
occulting - the occulting body
occultingRadius - the occulting body radius (m)
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)

EclipseDetector

public EclipseDetector(IDirection occulted,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit)
Build a new eclipse detector with defined actions when entering and exiting the eclipse.

The occulting body is a sphere and the occulted body is a direction; the concept of umbra/penumbra does not apply to this detector.

Parameters:
occulted - the direction to be occulted
occulting - the occulting body
occultingRadius - the occulting body radius (m)
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)
entry - action performed when entering the eclipse
exit - action performed when exiting the eclipse

EclipseDetector

public EclipseDetector(IDirection occulted,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit,
                       boolean removeEntry,
                       boolean removeExit)
Build a new eclipse detector with defined actions when entering and exiting the eclipse.

The occulting body is a sphere and the occulted body is a direction; the concept of umbra/penumbra does not apply to this detector.

Parameters:
occulted - the direction to be occulted
occulting - the occulting body
occultingRadius - the occulting body radius (m)
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.

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadius,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double lightingRatio,
                       double maxCheck,
                       double threshold)
Build a new eclipse detector based on a lighting ratio. The occulted and occulting bodies are both spherical.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse.

Parameters:
occulted - the occulted body
occultedRadius - the occulted body radius (m)
occulting - the occulting body
occultingRadius - the occulting body radius (m)
lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadius,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit)
Build a new eclipse detector based on a lighting ratio. The occulted and occulting bodies are both spherical.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

Parameters:
occulted - the occulted body
occultedRadius - the occulted body radius (m)
occulting - the occulting body
occultingRadius - the occulting body radius (m)
lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)
entry - action performed when entering the eclipse
exit - action performed when exiting the eclipse

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadius,
                       PVCoordinatesProvider occulting,
                       double occultingRadius,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit,
                       boolean removeEntry,
                       boolean removeExit)
Build a new eclipse detector based on a lighting ratio. The occulted and occulting bodies are both spherical.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

Parameters:
occulted - the occulted body
occultedRadius - the occulted body radius (m)
occulting - the occulting body
occultingRadius - the occulting body radius (m)
lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.
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.

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadius,
                       GeometricBodyShape occultingBody,
                       double lightingRatio,
                       double maxCheck,
                       double threshold)
Build a new eclipse detector based on a lighting ratio. The occulted body is a sphere and the occulting body is a GeometricBodyShape.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

The default implementation behavior is to continue propagation when entering the eclipse and to stop propagation when exiting the eclipse.

Parameters:
occulted - the occulted body
occultedRadius - the occulted body radius (m)
occultingBody - the occulting body
lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadius,
                       GeometricBodyShape occultingBody,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit)
Build a new eclipse detector based on a lighting ratio. The occulted body is a sphere and the occulting body is a GeometricBodyShape.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

Parameters:
occulted - the occulted body
occultedRadius - the occulted body radius (m)
occultingBody - the occulting body
lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.
maxCheck - maximal checking interval (s)
threshold - convergence threshold (s)
entry - action performed when entering the eclipse
exit - action performed when exiting the eclipse

EclipseDetector

public EclipseDetector(PVCoordinatesProvider occulted,
                       double occultedRadius,
                       GeometricBodyShape occultingBody,
                       double lightingRatio,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action entry,
                       EventDetector.Action exit,
                       boolean removeEntry,
                       boolean removeExit)
Build a new eclipse detector based on a lighting ratio. The occulted body is a sphere and the occulting body is a GeometricBodyShape.

The lighting ratio, whose value is between 0 and 1, establishes when an eclipse event should be triggered. If 0, an event is detected only when the occulted body is completely hidden (equivalent to an umbra detector), if 1, an event is detected every time the occulted body is just partially hidden (equivalent to a penumbra detector).
As a general rule, the lighting ratio is equal to 1 - the ratio between the hidden apparent area of the occulted body and its total apparent area.

Parameters:
occulted - the occulted body
occultedRadius - the occulted body radius (m)
occultingBody - the occulting body
lightingRatio - the lighting ratio: 0 when total eclipse events should be detected, 1 for penumbra events.
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.
Since:
3.1
Method Detail

getOcculting

public PVCoordinatesProvider getOcculting()
Get the occulting body.

Returns:
the occulting body

getOcculted

public PVCoordinatesProvider getOcculted()
Get the occulted body.

Returns:
the occulted body

getOccultedRadius

public double getOccultedRadius()
Get the occulted body radius (m).

Returns:
the occulted body radius

getOccultedDirection

public IDirection getOccultedDirection()
Returns:
the occulted direction

isTotalEclipse

public boolean isTotalEclipse()
Get the total eclipse detection flag.

Returns:
the total eclipse detection flag (true for umbra events detection, false for penumbra events detection)

eventOccurred

public EventDetector.Action eventOccurred(SpacecraftState s,
                                          boolean increasing,
                                          boolean forward)
                                   throws OrekitException
Handle an eclipse event and choose what to do next.

Specified by:
eventOccurred in interface EventDetector
Specified by:
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 entering or exiting the eclipse.
Throws:
OrekitException - if some specific error occurs

shouldBeRemoved

public boolean shouldBeRemoved()
This method is called after EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean) has been triggered. It returns true if the current detector should be removed after first event detection. WARNING: this method can be called only once a event has been triggered. Before, the value is not available.

Specified by:
shouldBeRemoved in interface EventDetector
Specified by:
shouldBeRemoved in class AbstractDetector
Returns:
true if the current detector should be removed after first event detection

g

public double g(SpacecraftState s)
         throws OrekitException
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:
s - the current state information: date, kinematics, attitude
Returns:
value of the switching function
Throws:
OrekitException - if some specific error occurs
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2017 CNES. All Rights Reserved.