Package org.orekit.propagation.events

Class LatitudeCrossingDetector

java.lang.Object

org.orekit.propagation.events.AbstractDetector<LatitudeCrossingDetector>

org.orekit.propagation.events.AbstractGeographicalDetector<LatitudeCrossingDetector>

org.orekit.propagation.events.LatitudeCrossingDetector

All Implemented Interfaces:

EventDetector

public class LatitudeCrossingDetector
extends AbstractGeographicalDetector<LatitudeCrossingDetector>

Detector for geographic latitude crossing.

This detector identifies when a spacecraft crosses a fixed latitude with respect to a central body.

Since:

7.1

Author:

Luc Maisonobe

Field Summary

Fields inherited from class org.orekit.propagation.events.AbstractDetector

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	LatitudeCrossingDetector(double maxCheck, double threshold, BodyShape body, double latitude)	Build a detector.
	LatitudeCrossingDetector(BodyShape body, double latitude)	Build a new detector.
	LatitudeCrossingDetector(EventDetectionSettings detectionSettings, EventHandler handler, BodyShape body, double latitude)	Constructor with input detection settings and handler.
protected	LatitudeCrossingDetector(LatitudeValueCrossingFunction eventFunction, EventDetectionSettings detectionSettings, EventHandler handler, BodyShape body)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected LatitudeCrossingDetector	create(EventDetectionSettings detectionSettings, EventHandler newHandler)	Build a new instance.
double	g(SpacecraftState s)	Compute the value of the detection function.
double	getLatitude()	Get the fixed latitude to be crossed (radians).

Methods inherited from class org.orekit.propagation.events.AbstractGeographicalDetector

getBodyShape

Methods inherited from class org.orekit.propagation.events.AbstractDetector

checkIfForward, getDetectionSettings, getEventFunction, getHandler, 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, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Details

LatitudeCrossingDetector

public LatitudeCrossingDetector(BodyShape body,
 double latitude)

Build a new detector.

The new instance uses default values for maximal checking interval (AbstractDetector.DEFAULT_MAX_CHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

Parameters:

body - body on which the latitude is defined

latitude - latitude to be crossed

LatitudeCrossingDetector

public LatitudeCrossingDetector(double maxCheck,
 double threshold,
 BodyShape body,
 double latitude)

Build a detector.

Parameters:

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

body - body on which the latitude is defined

latitude - latitude to be crossed

LatitudeCrossingDetector

public LatitudeCrossingDetector(EventDetectionSettings detectionSettings,
 EventHandler handler,
 BodyShape body,
 double latitude)

Constructor with input detection settings and handler.

Parameters:

detectionSettings - event detection settings

handler - event handler to call at event occurrences

body - body on which the latitude is defined

latitude - latitude to be crossed

Since:

13.0

LatitudeCrossingDetector

protected LatitudeCrossingDetector(LatitudeValueCrossingFunction eventFunction,
 EventDetectionSettings detectionSettings,
 EventHandler handler,
 BodyShape body)

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:

eventFunction - event function

detectionSettings - event detection settings

handler - event handler to call at event occurrences

body - body on which the latitude is defined

Since:

14.0

Method Details

create

protected LatitudeCrossingDetector create(EventDetectionSettings detectionSettings,
 EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<LatitudeCrossingDetector>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

getLatitude

public double getLatitude()

Get the fixed latitude to be crossed (radians).

Returns:

fixed latitude to be crossed (radians)

g

public double g(SpacecraftState s)

Compute the value of the detection function.

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.

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

spacecraft latitude minus the fixed latitude to be crossed