org.orekit.propagation.events
public class ElevationDetector extends AbstractReconfigurableDetector<ElevationDetector>
The default implementation behavior is to continue
propagation at raising and to stop
propagation
at setting. This can be changed by calling
AbstractReconfigurableDetector.withHandler(EventHandler)
after construction.
EventDetector.Action
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD
Constructor and Description |
---|
ElevationDetector(double maxCheck,
double threshold,
TopocentricFrame topo)
Creates an instance of Elevation detector based on passed in topocentric frame
and overrides of default maximal checking interval and convergence threshold values.
|
ElevationDetector(double minElevation,
TopocentricFrame topo)
Deprecated.
as of 6.1 replace with
ElevationDetector(TopocentricFrame) followed
by a call to withConstantElevation(double) |
ElevationDetector(TopocentricFrame topo)
Creates an instance of Elevation detector based on passed in topocentric frame
and the minimum elevation angle.
|
Modifier and Type | Method and Description |
---|---|
protected ElevationDetector |
create(double newMaxCheck,
double newThreshold,
int newMaxIter,
EventHandler<ElevationDetector> newHandler)
Build a new instance.
|
double |
g(SpacecraftState s)
Compute the value of the switching function.
|
ElevationMask |
getElevationMask()
Returns the currently configured elevation mask.
|
double |
getMinElevation()
Returns the currently configured minimum valid elevation value.
|
AtmosphericRefractionModel |
getRefractionModel()
Returns the currently configured refraction model.
|
TopocentricFrame |
getTopocentricFrame()
Returns the currently configured topocentric frame definitions.
|
ElevationDetector |
withConstantElevation(double newMinElevation)
Setup the minimum elevation for detection.
|
ElevationDetector |
withElevationMask(ElevationMask newElevationMask)
Setup the elevation mask for detection using the passed in mask object.
|
ElevationDetector |
withRefraction(AtmosphericRefractionModel newRefractionModel)
Setup the elevation detector to use an atmospheric refraction model in its
calculations.
|
convert, convert, eventOccurred, getHandler, resetState, withHandler, withMaxCheck, withMaxIter, withThreshold
getMaxCheckInterval, getMaxIterationCount, getThreshold, init
public ElevationDetector(TopocentricFrame topo)
uses default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK
)
and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD
).
topo
- reference to a topocentric modelwithConstantElevation(double)
,
withElevationMask(ElevationMask)
,
withRefraction(AtmosphericRefractionModel)
@Deprecated public ElevationDetector(double minElevation, TopocentricFrame topo)
ElevationDetector(TopocentricFrame)
followed
by a call to withConstantElevation(double)
uses default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK
)
and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD
).
minElevation
- minimum elevation angletopo
- reference to a topocentric modelpublic ElevationDetector(double maxCheck, double threshold, TopocentricFrame topo)
maxCheck
- maximum checking interval (s)threshold
- maximum divergence threshold (s)topo
- reference to a topocentric modelwithConstantElevation(double)
,
withElevationMask(ElevationMask)
,
withRefraction(AtmosphericRefractionModel)
protected ElevationDetector create(double newMaxCheck, double newThreshold, int newMaxIter, EventHandler<ElevationDetector> newHandler)
create
in class AbstractReconfigurableDetector<ElevationDetector>
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 ElevationMask getElevationMask()
withConstantElevation(double)
withElevationMask(ElevationMask)
public double getMinElevation()
Double.NaN
if instance has been configured with withElevationMask(ElevationMask)
withConstantElevation(double)
public AtmosphericRefractionModel getRefractionModel()
withRefraction(AtmosphericRefractionModel)
public TopocentricFrame getTopocentricFrame()
public double g(SpacecraftState s) throws OrekitException
g
in interface EventDetector
g
in class AbstractDetector
s
- the current state information: date, kinematics, attitudeOrekitException
- if some specific error occurspublic ElevationDetector withConstantElevation(double newMinElevation)
This will override an elevation mask if it has been configured as such previously.
newMinElevation
- minimum elevation for visibility in radians (rad)getMinElevation()
public ElevationDetector withElevationMask(ElevationMask newElevationMask)
newElevationMask
- elevation mask to use for the computationgetElevationMask()
public ElevationDetector withRefraction(AtmosphericRefractionModel newRefractionModel)
To disable the refraction when copying an existing elevation detector, call this method with a null argument.
newRefractionModel
- refraction model to use for the computationgetRefractionModel()
Copyright © 2002–2015 CS Syst?mes d'Information. All rights reserved.