public class LatitudeCrossingDetector extends AbstractDetector<LatitudeCrossingDetector>
This detector identifies when a spacecraft crosses a fixed latitude with respect to a central body.
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD| Modifier | Constructor and Description |
|---|---|
protected |
LatitudeCrossingDetector(AdaptableInterval maxCheck,
double threshold,
int maxIter,
EventHandler handler,
OneAxisEllipsoid body,
double latitude)
Protected constructor with full parameters.
|
|
LatitudeCrossingDetector(double maxCheck,
double threshold,
OneAxisEllipsoid body,
double latitude)
Build a detector.
|
|
LatitudeCrossingDetector(OneAxisEllipsoid body,
double latitude)
Build a new detector.
|
| Modifier and Type | Method and Description |
|---|---|
protected LatitudeCrossingDetector |
create(AdaptableInterval newMaxCheck,
double newThreshold,
int newMaxIter,
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 |
getLatitude()
Get the fixed latitude to be crossed (radians).
|
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThresholdpublic LatitudeCrossingDetector(OneAxisEllipsoid body, double latitude)
The new instance uses default values for maximal checking interval
(AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).
body - body on which the latitude is definedlatitude - latitude to be crossedpublic LatitudeCrossingDetector(double maxCheck,
double threshold,
OneAxisEllipsoid body,
double latitude)
maxCheck - maximal checking interval (s)threshold - convergence threshold (s)body - body on which the latitude is definedlatitude - latitude to be crossedprotected LatitudeCrossingDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, OneAxisEllipsoid body, double latitude)
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.
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 definedlatitude - latitude to be crossedprotected LatitudeCrossingDetector create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
create in class AbstractDetector<LatitudeCrossingDetector>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 occurrencespublic OneAxisEllipsoid getBody()
public double getLatitude()
public double g(SpacecraftState s)
The value is the spacecraft latitude minus the fixed latitude to be crossed. It is positive if the spacecraft is northward and negative if it is southward with respect to the fixed latitude.
g in interface EventDetectorg in class AbstractDetector<LatitudeCrossingDetector>s - the current state information: date, kinematics, attitudeCopyright © 2002-2023 CS GROUP. All rights reserved.