Package org.orekit.propagation.events
Class LatitudeRangeCrossingDetector
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<LatitudeRangeCrossingDetector>
-
- org.orekit.propagation.events.LatitudeRangeCrossingDetector
-
- All Implemented Interfaces:
EventDetector
public class LatitudeRangeCrossingDetector extends AbstractDetector<LatitudeRangeCrossingDetector>
Detector for geographic latitude crossing.This detector identifies when a spacecraft crosses a fixed latitude range with respect to a central body.
- Since:
- 12.0
- Author:
- Alberto Ferrero
-
-
Field Summary
-
Fields inherited from class org.orekit.propagation.events.AbstractDetector
DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD
-
-
Constructor Summary
Constructors Modifier Constructor Description LatitudeRangeCrossingDetector(double maxCheck, double threshold, OneAxisEllipsoid body, double fromLatitude, double toLatitude)
Build a detector.LatitudeRangeCrossingDetector(OneAxisEllipsoid body, double fromLatitude, double toLatitude)
Build a new detector.protected
LatitudeRangeCrossingDetector(EventDetectionSettings detectionSettings, EventHandler handler, OneAxisEllipsoid body, double fromLatitude, double toLatitude)
Private constructor with full parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected LatitudeRangeCrossingDetector
create(EventDetectionSettings detectionSettings, EventHandler newHandler)
Build a new instance.double
g(SpacecraftState s)
Compute the value of the detection function.OneAxisEllipsoid
getBody()
Get the body on which the geographic zone is defined.double
getFromLatitude()
Get the fixed latitude range to be crossed (radians), lower boundary.double
getToLatitude()
Get the fixed latitude range to be crossed (radians), upper boundary.-
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getDetectionSettings, getHandler, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.propagation.events.EventDetector
finish, getMaxCheckInterval, getMaxIterationCount, getThreshold
-
-
-
-
Constructor Detail
-
LatitudeRangeCrossingDetector
public LatitudeRangeCrossingDetector(OneAxisEllipsoid body, double fromLatitude, double toLatitude)
Build a new detector.The new instance uses default values for maximal checking interval (
AbstractDetector.DEFAULT_MAX_CHECK
) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD
).- Parameters:
body
- body on which the latitude is definedfromLatitude
- latitude to be crossed, lower range boundarytoLatitude
- latitude to be crossed, upper range boundary
-
LatitudeRangeCrossingDetector
public LatitudeRangeCrossingDetector(double maxCheck, double threshold, OneAxisEllipsoid body, double fromLatitude, double toLatitude)
Build a detector.- Parameters:
maxCheck
- maximal checking interval (s)threshold
- convergence threshold (s)body
- body on which the latitude is definedfromLatitude
- latitude to be crossed, lower range boundarytoLatitude
- latitude to be crossed, upper range boundary
-
LatitudeRangeCrossingDetector
protected LatitudeRangeCrossingDetector(EventDetectionSettings detectionSettings, EventHandler handler, OneAxisEllipsoid body, double fromLatitude, double toLatitude)
Private constructor with full parameters.This constructor is private 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:
detectionSettings
- event detection settingshandler
- event handler to call at event occurrencesbody
- body on which the latitude is definedfromLatitude
- latitude to be crossed, lower range boundarytoLatitude
- latitude to be crossed, upper range boundary- Since:
- 13.0
-
-
Method Detail
-
create
protected LatitudeRangeCrossingDetector create(EventDetectionSettings detectionSettings, EventHandler newHandler)
Build a new instance.- Specified by:
create
in classAbstractDetector<LatitudeRangeCrossingDetector>
- Parameters:
detectionSettings
- detection settingsnewHandler
- event handler to call at event occurrences- Returns:
- a new instance of the appropriate sub-type
-
getBody
public OneAxisEllipsoid getBody()
Get the body on which the geographic zone is defined.- Returns:
- body on which the geographic zone is defined
-
getFromLatitude
public double getFromLatitude()
Get the fixed latitude range to be crossed (radians), lower boundary.- Returns:
- fixed lower boundary latitude range to be crossed (radians)
-
getToLatitude
public double getToLatitude()
Get the fixed latitude range to be crossed (radians), upper boundary.- Returns:
- fixed lower boundary latitude range to be crossed (radians)
-
g
public double g(SpacecraftState s)
Compute the value of the detection function.The value is positive if the spacecraft latitude is inside the latitude range. It is positive if the spacecraft is northward to lower boundary range and southward to upper boundary range, with respect to the fixed latitude range.
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- positive if spacecraft inside the range
-
-