Package org.orekit.propagation.events
Class LatitudeExtremumDetector
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<LatitudeExtremumDetector>
-
- org.orekit.propagation.events.LatitudeExtremumDetector
-
- All Implemented Interfaces:
EventDetector
public class LatitudeExtremumDetector extends AbstractDetector<LatitudeExtremumDetector>
Detector for geographic latitude extremum.This detector identifies when a spacecraft reaches its extremum latitudes with respect to a central body.
- Since:
- 7.1
- Author:
- Luc Maisonobe
-
-
Field Summary
-
Fields inherited from class org.orekit.propagation.events.AbstractDetector
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD
-
-
Constructor Summary
Constructors Modifier Constructor Description LatitudeExtremumDetector(double maxCheck, double threshold, OneAxisEllipsoid body)
Build a detector.LatitudeExtremumDetector(OneAxisEllipsoid body)
Build a new detector.protected
LatitudeExtremumDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, OneAxisEllipsoid body)
Protected constructor with full parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected LatitudeExtremumDetector
create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.double
g(SpacecraftState s)
Compute the value of the detection function.BodyShape
getBody()
Get the body on which the geographic zone is defined.-
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
-
-
-
Constructor Detail
-
LatitudeExtremumDetector
public LatitudeExtremumDetector(OneAxisEllipsoid body)
Build a new detector.The new instance uses default values for maximal checking interval (
AbstractDetector.DEFAULT_MAXCHECK
) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD
).- Parameters:
body
- body on which the latitude is defined
-
LatitudeExtremumDetector
public LatitudeExtremumDetector(double maxCheck, double threshold, OneAxisEllipsoid body)
Build a detector.- Parameters:
maxCheck
- maximal checking interval (s)threshold
- convergence threshold (s)body
- body on which the latitude is defined
-
LatitudeExtremumDetector
protected LatitudeExtremumDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, OneAxisEllipsoid body)
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.- Parameters:
maxCheck
- maximum checking intervalthreshold
- convergence threshold (s)maxIter
- maximum number of iterations in the event time searchhandler
- event handler to call at event occurrencesbody
- body on which the latitude is defined
-
-
Method Detail
-
create
protected LatitudeExtremumDetector create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.- Specified by:
create
in classAbstractDetector<LatitudeExtremumDetector>
- 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
-
getBody
public BodyShape getBody()
Get the body on which the geographic zone is defined.- Returns:
- body on which the geographic zone is defined
-
g
public double g(SpacecraftState s)
Compute the value of the detection function.The value is the spacecraft latitude time derivative.
- Specified by:
g
in interfaceEventDetector
- Specified by:
g
in classAbstractDetector<LatitudeExtremumDetector>
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- spacecraft latitude time derivative
-
-