Package org.orekit.utils

Class OccultationEngine

java.lang.Object

org.orekit.utils.OccultationEngine

public class OccultationEngine
extends Object

Computation engine for occultation events.

Since:

12.0

Author:

Luc Maisonobe

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OccultationEngine.FieldOccultationAngles<T extends CalculusFieldElement<T>>	Container for occultation angles.
static class	OccultationEngine.OccultationAngles	Container for occultation angles.

Constructor Summary

Constructors

Constructor	Description
OccultationEngine(ExtendedPositionProvider occulted, double occultedRadius, OneAxisEllipsoid occulting)	Build a new occultation engine.

Method Summary

Modifier and Type	Method	Description
<T extends CalculusFieldElement<T>> OccultationEngine.FieldOccultationAngles<T>	angles(FieldSpacecraftState<T> state)	Compute the occultation angles as seen from a spacecraft.
OccultationEngine.OccultationAngles	angles(SpacecraftState state)	Compute the occultation angles as seen from a spacecraft.
ExtendedPositionProvider	getOcculted()	Getter for the occulted body.
double	getOccultedRadius()	Getter for the occultedRadius.
OneAxisEllipsoid	getOcculting()	Getter for the occulting body.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OccultationEngine

public OccultationEngine(ExtendedPositionProvider occulted,
                         double occultedRadius,
                         OneAxisEllipsoid occulting)

Build a new occultation engine.

Parameters:

occulted - the body to be occulted

occultedRadius - the radius of the body to be occulted (m)

occulting - the occulting body

Method Detail

getOcculting

public OneAxisEllipsoid getOcculting()

Getter for the occulting body.

Returns:

the occulting body

getOcculted

public ExtendedPositionProvider getOcculted()

Getter for the occulted body.

Returns:

the occulted body

getOccultedRadius

public double getOccultedRadius()

Getter for the occultedRadius.

Returns:

the occultedRadius

angles

public OccultationEngine.OccultationAngles angles(SpacecraftState state)

Compute the occultation angles as seen from a spacecraft.

Parameters:

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

Returns:

occultation angles

angles

public <T extends CalculusFieldElement<T>> OccultationEngine.FieldOccultationAngles<T> angles(FieldSpacecraftState<T> state)

Compute the occultation angles as seen from a spacecraft.

Type Parameters:

T - the type of the field elements

Parameters:

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

Returns:

occultation angles