public class AlignmentDetector extends AbstractDetector<AlignmentDetector>
This class finds alignment events.
Alignment means the conjunction, with some threshold angle, between the satellite position and the projection in the orbital plane of some body position.
The default handler behavior is to stop
propagation when alignment is reached. This can be changed by calling
AbstractDetector.withHandler(EventHandler) after construction.
Propagator.addEventDetector(EventDetector)DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD| Modifier | Constructor and Description |
|---|---|
protected |
AlignmentDetector(AdaptableInterval maxCheck,
double threshold,
int maxIter,
EventHandler handler,
PVCoordinatesProvider body,
double alignAngle)
Protected constructor with full parameters.
|
|
AlignmentDetector(double maxCheck,
double threshold,
PVCoordinatesProvider body,
double alignAngle)
Build a new alignment detector.
|
|
AlignmentDetector(double threshold,
Orbit orbit,
PVCoordinatesProvider body,
double alignAngle)
Build a new alignment detector.
|
|
AlignmentDetector(Orbit orbit,
PVCoordinatesProvider body,
double alignAngle)
Build a new alignment detector.
|
| Modifier and Type | Method and Description |
|---|---|
protected AlignmentDetector |
create(AdaptableInterval newMaxCheck,
double newThreshold,
int newMaxIter,
EventHandler newHandler)
Build a new instance.
|
double |
g(SpacecraftState s)
Compute the value of the switching function.
|
double |
getAlignAngle()
Get the alignment angle (rad).
|
PVCoordinatesProvider |
getPVCoordinatesProvider()
Get the body to align.
|
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThresholdpublic AlignmentDetector(Orbit orbit, PVCoordinatesProvider body, double alignAngle)
The orbit is used only to set an upper bound for the max check interval to period/3 and to set the convergence threshold according to orbit size.
orbit - initial orbitbody - the body to alignalignAngle - the alignment angle (rad)public AlignmentDetector(double maxCheck,
double threshold,
PVCoordinatesProvider body,
double alignAngle)
maxCheck - maximum checking interval (s)threshold - convergence threshold (s)body - the body to alignalignAngle - the alignment angle (rad)public AlignmentDetector(double threshold,
Orbit orbit,
PVCoordinatesProvider body,
double alignAngle)
The orbit is used only to set an upper bound for the max check interval to period/3.
threshold - convergence threshold (s)orbit - initial orbitbody - the body to alignalignAngle - the alignment angle (rad)protected AlignmentDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, PVCoordinatesProvider body, double alignAngle)
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 interval (s)threshold - convergence threshold (s)maxIter - maximum number of iterations in the event time searchhandler - event handler to call at event occurrencesbody - the body to alignalignAngle - the alignment angle (rad)protected AlignmentDetector create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
create in class AbstractDetector<AlignmentDetector>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 PVCoordinatesProvider getPVCoordinatesProvider()
public double getAlignAngle()
public double g(SpacecraftState s)
g in interface EventDetectorg in class AbstractDetector<AlignmentDetector>s - the current state information: date, kinematics, attitudeCopyright © 2002-2023 CS GROUP. All rights reserved.