Package org.orekit.bodies

Class FieldGeodeticPoint<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.bodies.FieldGeodeticPoint<T>

Type Parameters:

T - the type of the field elements

public class FieldGeodeticPoint<T extends CalculusFieldElement<T>>
extends Object

Point location relative to a 2D body surface, using CalculusFieldElement.

Instance of this class are guaranteed to be immutable.

Since:

7.1

Author:

Luc Maisonobe

See Also:

BodyShape

Constructor Summary

Constructors

Constructor	Description
FieldGeodeticPoint(Field<T> field, GeodeticPoint geodeticPoint)	Build a new instance from a GeodeticPoint.
FieldGeodeticPoint(T latitude, T longitude, T altitude)	Build a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
T	getAltitude()	Get the altitude.
FieldVector3D<T>	getEast()	Get the direction to the east of point, expressed in parent shape frame.
T	getLatitude()	Get the latitude.
T	getLongitude()	Get the longitude.
FieldVector3D<T>	getNadir()	Get the direction below the point, expressed in parent shape frame.
FieldVector3D<T>	getNorth()	Get the direction to the north of point, expressed in parent shape frame.
FieldVector3D<T>	getSouth()	Get the direction to the south of point, expressed in parent shape frame.
FieldVector3D<T>	getWest()	Get the direction to the west of point, expressed in parent shape frame.
FieldVector3D<T>	getZenith()	Get the direction above the point, expressed in parent shape frame.
int	hashCode()
GeodeticPoint	toGeodeticPoint()	Get non-Field equivalent.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldGeodeticPoint

public FieldGeodeticPoint(T latitude,
                          T longitude,
                          T altitude)

Build a new instance.

The angular coordinates will be normalized so that the latitude is between ±π/2 and the longitude is between ±π.

Parameters:

latitude - latitude of the point (rad)

longitude - longitude of the point (rad)

altitude - altitude of the point (m)

FieldGeodeticPoint

public FieldGeodeticPoint(Field<T> field,
                          GeodeticPoint geodeticPoint)

Build a new instance from a GeodeticPoint.

Parameters:

field - field to which the elements belong

geodeticPoint - geodetic point to convert

Since:

12.1

Method Detail

getLatitude

public T getLatitude()

Get the latitude.

Returns:

latitude, an angular value in the range [-π/2, π/2]

getLongitude

public T getLongitude()

Get the longitude.

Returns:

longitude, an angular value in the range [-π, π]

getAltitude

public T getAltitude()

Get the altitude.

Returns:

altitude

getZenith

public FieldVector3D<T> getZenith()

Get the direction above the point, expressed in parent shape frame.

The zenith direction is defined as the normal to local horizontal plane.

Returns:

unit vector in the zenith direction

See Also:

getNadir()

getNadir

public FieldVector3D<T> getNadir()

Get the direction below the point, expressed in parent shape frame.

The nadir direction is the opposite of zenith direction.

Returns:

unit vector in the nadir direction

See Also:

getZenith()

getNorth

public FieldVector3D<T> getNorth()

Get the direction to the north of point, expressed in parent shape frame.

The north direction is defined in the horizontal plane (normal to zenith direction) and following the local meridian.

Returns:

unit vector in the north direction

See Also:

getSouth()

getSouth

public FieldVector3D<T> getSouth()

Get the direction to the south of point, expressed in parent shape frame.

The south direction is the opposite of north direction.

Returns:

unit vector in the south direction

See Also:

getNorth()

getEast

public FieldVector3D<T> getEast()

Get the direction to the east of point, expressed in parent shape frame.

The east direction is defined in the horizontal plane in order to complete direct triangle (east, north, zenith).

Returns:

unit vector in the east direction

See Also:

getWest()

getWest

public FieldVector3D<T> getWest()

Get the direction to the west of point, expressed in parent shape frame.

The west direction is the opposite of east direction.

Returns:

unit vector in the west direction

See Also:

getEast()

toGeodeticPoint

public GeodeticPoint toGeodeticPoint()

Get non-Field equivalent.

Returns:

geodetic point

Since:

12.2

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object