Class PositionAngleDetector
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<PositionAngleDetector>
-
- org.orekit.propagation.events.PositionAngleDetector
-
- All Implemented Interfaces:
EventDetector
public class PositionAngleDetector extends AbstractDetector<PositionAngleDetector>
Detector for in-orbit position angle.The detector is based on anomaly for
Keplerian
orbits, latitude argument forcircular
orbits, or longitude argument forequinoctial
orbits. It does not supportCartesian
orbits. The angles can be eithertrue
,mean
oreccentric
angles.- 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 PositionAngleDetector(double maxCheck, double threshold, OrbitType orbitType, PositionAngleType positionAngleType, double angle)
Build a detector.PositionAngleDetector(OrbitType orbitType, PositionAngleType positionAngleType, double angle)
Build a new detector.protected
PositionAngleDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, OrbitType orbitType, PositionAngleType positionAngleType, double angle)
Protected constructor with full parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected PositionAngleDetector
create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.double
g(SpacecraftState s)
Compute the value of the detection function.double
getAngle()
Get the fixed angle to be crossed (radians).OrbitType
getOrbitType()
Get the orbit type defining the angle type.PositionAngleType
getPositionAngleType()
Get the type of position angle.void
init(SpacecraftState s0, AbsoluteDate t)
Initialize event handler at the start of a propagation.-
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
-
-
-
Constructor Detail
-
PositionAngleDetector
public PositionAngleDetector(OrbitType orbitType, PositionAngleType positionAngleType, double angle) throws OrekitIllegalArgumentException
Build a new detector.The new instance uses default values for maximal checking interval (
AbstractDetector.DEFAULT_MAXCHECK
) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD
).- Parameters:
orbitType
- orbit type defining the angle typepositionAngleType
- type of position angleangle
- fixed angle to be crossed- Throws:
OrekitIllegalArgumentException
- if orbit type isOrbitType.CARTESIAN
-
PositionAngleDetector
public PositionAngleDetector(double maxCheck, double threshold, OrbitType orbitType, PositionAngleType positionAngleType, double angle) throws OrekitIllegalArgumentException
Build a detector.This instance uses by default the
StopOnEvent
handler- Parameters:
maxCheck
- maximal checking interval (s)threshold
- convergence threshold (s)orbitType
- orbit type defining the angle typepositionAngleType
- type of position angleangle
- fixed angle to be crossed- Throws:
OrekitIllegalArgumentException
- if orbit type isOrbitType.CARTESIAN
-
PositionAngleDetector
protected PositionAngleDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, OrbitType orbitType, PositionAngleType positionAngleType, double angle) throws OrekitIllegalArgumentException
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 occurrencesorbitType
- orbit type defining the angle typepositionAngleType
- type of position angleangle
- fixed angle to be crossed- Throws:
OrekitIllegalArgumentException
- if orbit type isOrbitType.CARTESIAN
-
-
Method Detail
-
create
protected PositionAngleDetector create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.- Specified by:
create
in classAbstractDetector<PositionAngleDetector>
- 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
-
getOrbitType
public OrbitType getOrbitType()
Get the orbit type defining the angle type.- Returns:
- orbit type defining the angle type
-
getPositionAngleType
public PositionAngleType getPositionAngleType()
Get the type of position angle.- Returns:
- type of position angle
-
getAngle
public double getAngle()
Get the fixed angle to be crossed (radians).- Returns:
- fixed angle to be crossed (radians)
-
init
public void init(SpacecraftState s0, AbsoluteDate t)
Initialize event handler at the start of a propagation.This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.
The default implementation does nothing
This implementation sets the direction of propagation and initializes the event handler. If a subclass overrides this method it should call
super.init(s0, t)
.- Specified by:
init
in interfaceEventDetector
- Overrides:
init
in classAbstractDetector<PositionAngleDetector>
- Parameters:
s0
- initial statet
- target time for the integration
-
g
public double g(SpacecraftState s)
Compute the value of the detection function.The value is the angle difference between the spacecraft and the fixed angle to be crossed, with some sign tweaks to ensure continuity. These tweaks imply the
increasing
flag in events detection becomes irrelevant here! As an example, the angle always increase in a Keplerian orbit, but this g function will increase and decrease so it will cross the zero value once per orbit, in increasing and decreasing directions on alternate orbits..- Specified by:
g
in interfaceEventDetector
- Specified by:
g
in classAbstractDetector<PositionAngleDetector>
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- angle difference between the spacecraft and the fixed angle, with some sign tweaks to ensure continuity
-
-