Class NodeDetector
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<NodeDetector>
-
- org.orekit.propagation.events.NodeDetector
-
- All Implemented Interfaces:
EventDetector
public class NodeDetector extends AbstractDetector<NodeDetector>
Finder for node crossing events.This class finds equator crossing events (i.e. ascending or descending node crossing).
The default implementation behavior is to
continue
propagation at descending node crossing and tostop
propagation at ascending node crossing. This can be changed by callingAbstractDetector.withHandler(EventHandler)
after construction.Beware that node detection will fail for almost equatorial orbits. If for example a node detector is used to trigger an
ImpulseManeuver
and the maneuver turn the orbit plane to equator, then the detector may completely fail just after the maneuver has been performed! This is a real case that has been encountered during validation ...- Author:
- Luc Maisonobe
- See Also:
Propagator.addEventDetector(EventDetector)
-
-
Field Summary
-
Fields inherited from class org.orekit.propagation.events.AbstractDetector
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK
-
-
Constructor Summary
Constructors Modifier Constructor Description NodeDetector(double threshold, Orbit orbit, Frame frame)
Build a new instance.NodeDetector(Frame frame)
Build a new instance.NodeDetector(Orbit orbit, Frame frame)
Build a new instance.protected
NodeDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, Frame frame)
Protected constructor with full parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected NodeDetector
create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.double
g(SpacecraftState s)
Compute the value of the switching function.Frame
getFrame()
Get the frame in which the equator is defined.-
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
-
-
-
Constructor Detail
-
NodeDetector
public NodeDetector(Frame frame)
Build a new instance.The default
max check interval
is set to 1800s, it can be changed usingAbstractDetector.withMaxCheck(double)
in the fluent API. The defaultconvergence threshold
is set to 1.0e-3s, it can be changed usingAbstractDetector.withThreshold(double)
in the fluent API.
-
NodeDetector
public NodeDetector(Orbit orbit, Frame frame)
Build a new instance.The orbit is used only to set an upper bound for the max check interval to a value related to nodes separation (as computed by a Keplerian model) and to set the convergence threshold according to orbit size.
-
NodeDetector
public NodeDetector(double threshold, Orbit orbit, Frame frame)
Build a new instance.The orbit is used only to set an upper bound for the max check interval to a value related to nodes separation (as computed by a Keplerian model).
-
NodeDetector
protected NodeDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, Frame frame)
Protected constructor with full parameters.This constructor is not public as users are expected to use the builder API with the various
withXxx()
methods to set up the instance in a readable manner without using a huge amount of parameters.
-
-
Method Detail
-
create
protected NodeDetector create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.- Specified by:
create
in classAbstractDetector<NodeDetector>
- Parameters:
newMaxCheck
- maximum checking interval (s)newThreshold
- convergence threshold (s)newMaxIter
- maximum number of iterations in the event time searchnewHandler
- event handler to call at event occurrences- Returns:
- a new instance of the appropriate sub-type
-
getFrame
public Frame getFrame()
Get the frame in which the equator is defined.- Returns:
- the frame in which the equator is defined
-
g
public double g(SpacecraftState s)
Compute the value of the switching function. This function computes the Z position in the defined frame.- Specified by:
g
in interfaceEventDetector
- Specified by:
g
in classAbstractDetector<NodeDetector>
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
-