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_ITER, DEFAULT_MAXCHECK, 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(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, OneAxisEllipsoid body, double fromLatitude, double toLatitude)	Private constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected LatitudeRangeCrossingDetector	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	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

create, getDetectionSettings, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, 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

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_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

Parameters:

body - body on which the latitude is defined

fromLatitude - latitude to be crossed, lower range boundary

toLatitude - 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 defined

fromLatitude - latitude to be crossed, lower range boundary

toLatitude - latitude to be crossed, upper range boundary

LatitudeRangeCrossingDetector

protected LatitudeRangeCrossingDetector(AdaptableInterval maxCheck,
                                        double threshold,
                                        int maxIter,
                                        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:

maxCheck - maximum checking interval (s)

threshold - convergence threshold (s)

maxIter - maximum number of iterations in the event time search

handler - event handler to call at event occurrences

body - body on which the latitude is defined

fromLatitude - latitude to be crossed, lower range boundary

toLatitude - latitude to be crossed, upper range boundary

Method Detail

create

protected LatitudeRangeCrossingDetector create(AdaptableInterval newMaxCheck,
                                               double newThreshold,
                                               int newMaxIter,
                                               EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<LatitudeRangeCrossingDetector>

Parameters:

newMaxCheck - maximum checking interval (s)

newThreshold - convergence threshold (s)

newMaxIter - maximum number of iterations in the event time search

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type WARNING: this method will be removed in 13.0. It doesn't have the deprecated annotation because the method is abstract and shall be implemented

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