Package org.orekit.propagation.events

Class FieldLatitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<D,T>

org.orekit.propagation.events.FieldAbstractGeographicalDetector<FieldLatitudeRangeCrossingDetector<T>,T>

org.orekit.propagation.events.FieldLatitudeRangeCrossingDetector<T>

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldLatitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractGeographicalDetector<FieldLatitudeRangeCrossingDetector<T>,T>

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.FieldAbstractDetector

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	FieldLatitudeRangeCrossingDetector(Field<T> field, BodyShape body, double fromLatitude, double toLatitude)	Build a new detector.
protected	FieldLatitudeRangeCrossingDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, BodyShape body, double fromLatitude, double toLatitude)	Private constructor with full parameters.
	FieldLatitudeRangeCrossingDetector(T maxCheck, T threshold, BodyShape body, double fromLatitude, double toLatitude)	Build a detector.

Method Summary

Modifier and Type	Method	Description
protected FieldLatitudeRangeCrossingDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the detection function.
EventFunction	getEventFunction()	Get the event function.
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.
LatitudeRangeCrossingDetector	toEventDetector(EventHandler eventHandler)	Build non-Field instance.

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

getBodyShape

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

checkIfForward, getDetectionSettings, 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.FieldEventDetector

finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Detail

FieldLatitudeRangeCrossingDetector

public FieldLatitudeRangeCrossingDetector(Field<T> field,
                                          BodyShape body,
                                          double fromLatitude,
                                          double toLatitude)

Build a new detector.

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

Parameters:

field - the type of numbers to use.

body - body on which the latitude is defined

fromLatitude - latitude to be crossed, lower range boundary

toLatitude - latitude to be crossed, upper range boundary

FieldLatitudeRangeCrossingDetector

public FieldLatitudeRangeCrossingDetector(T maxCheck,
                                          T threshold,
                                          BodyShape 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

FieldLatitudeRangeCrossingDetector

protected FieldLatitudeRangeCrossingDetector(FieldEventDetectionSettings<T> detectionSettings,
                                             FieldEventHandler<T> handler,
                                             BodyShape 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:

detectionSettings - event detection settings

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

Since:

13.0

Method Detail

create

protected FieldLatitudeRangeCrossingDetector<T> create(FieldEventDetectionSettings<T> detectionSettings,
                                                       FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldLatitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

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)

getEventFunction

public EventFunction getEventFunction()

Description copied from interface: FieldEventDetector

Get the event function. It defines g both for double and Field.

Specified by:

getEventFunction in interface FieldEventDetector<T extends CalculusFieldElement<T>>

Overrides:

getEventFunction in class FieldAbstractDetector<FieldLatitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Returns:

event function

g

public T g(FieldSpacecraftState<T> 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

toEventDetector

public LatitudeRangeCrossingDetector toEventDetector(EventHandler eventHandler)

Description copied from class: FieldAbstractDetector

Build non-Field instance.

Overrides:

toEventDetector in class FieldAbstractDetector<FieldLatitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

eventHandler - event handler

Returns:

event detector