fr.cnes.sirius.patrius.bodies

Class OneAxisEllipsoid

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractBodyShape

fr.cnes.sirius.patrius.bodies.AbstractEllipsoidBodyShape

fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid

All Implemented Interfaces:

BodyShape, EllipsoidBodyShape, StarConvexBodyShape, PVCoordinatesProvider, Serializable

public class OneAxisEllipsoid
extends AbstractEllipsoidBodyShape

One axis ellipsoid representation.

This ellipsoid is fully defined by its equatorial radius, its flattening and its associated body frame.

Since:

1.2

Version:

$Id: ExtendedOneAxisEllipsoid.java 17944 2017-09-12 15:24:41Z bignon $

Author:

Thomas Trapier

See Also:

AbstractEllipsoidBodyShape, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

the use of frames makes this class not thread-safe

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.bodies.BodyShape

BodyShape.MarginType

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ONE_AXIS_ELLIPSOID_NAME Default ellipsoid name.

Fields inherited from class fr.cnes.sirius.patrius.bodies.AbstractEllipsoidBodyShape

CLOSE_APPROACH_THRESHOLD, DEFAULT_LLH_COORD_SYSTEM, ellipsoid, maxIterSignalPropagation

Fields inherited from class fr.cnes.sirius.patrius.bodies.AbstractBodyShape

DEFAULT_EPSILON_SIGNAL_PROPAGATION, distanceEpsilon, lLHCoordinatesSystem

Fields inherited from interface fr.cnes.sirius.patrius.bodies.BodyShape

DEFAULT_DISTANCE_EPSILON, DIRECTION_FACTOR

Constructor Summary

Constructors

Constructor and Description
OneAxisEllipsoid(double ae, double f, CelestialBodyFrame bodyFrame) Constructor for the one axis ellipsoid with default name.
OneAxisEllipsoid(double ae, double f, CelestialBodyFrame bodyFrame, String name) Constructor for the one axis ellipsoid.

Method Summary

Modifier and Type	Method and Description
Vector3D	computePositionFromEllipsodeticCoordinates(double latitude, double longitude, double height) Compute the position from the ellipsodetic coordinates in body frame.
double	getConjugateRadius() Deprecated. since 4.13 as this method isn't relevant to this class description, use getPolarRadius() instead.
double	getE2() Getter for the e2 (eccentricity e squared with e = f * (2.0 - f)).
double	getEncompassingSphereRadius() Getter for the radius, in meters, of a sphere centered on the body frame origin and encompassing the shape.
double	getEquatorialRadius() Getter for the equatorial radius of the body.
double	getFlattening() Getter for the flattening.
double	getG2() Getter for the g2 (g squared with g = 1.0 - f).
EllipsoidPoint	getIntersectionPoint(Line line, Vector3D close, Frame frame, AbsoluteDate date, double altitude) Getter for the intersection point of a line with the surface of the body for a given altitude.
double	getPolarRadius() Getter for the polar radius of the body.
double	getTransverseRadius() Deprecated. since 4.13 as this method isn't relevant to this class description, use getEquatorialRadius() instead.
OneAxisEllipsoid	resize(BodyShape.MarginType marginType, double marginValue) Resize the geometric body shape by a margin.
Vector3D	transformAndComputeJacobian(EllipsoidPoint point, double[][] jacobian) Deprecated. since 4.13, use LLHCoordinatesSystem.jacobianToCartesian(BodyPoint) with ELLIPSODETIC coordinates instead.
EllipsoidPoint	transformAndComputeJacobian(Vector3D point, Frame frame, AbsoluteDate date, double[][] jacobian) Deprecated. since 4.13, use LLHCoordinatesSystem.jacobianFromCartesian(BodyPoint) with ELLIPSODETIC coordinates instead.

Methods inherited from class fr.cnes.sirius.patrius.bodies.AbstractEllipsoidBodyShape

buildPoint, buildPoint, buildPoint, closestPointTo, closestPointTo, closestPointTo, closestPointTo, closestPointTo, distanceTo, getApparentRadius, getARadius, getBRadius, getCRadius, getEllipsoid, getIntersectionPoint, getIntersectionPoint, getIntersectionPoints, getMaxIterSignalPropagation, isDefaultLLHCoordinatesSystem, isSpherical, setConvergenceThreshold, setMaxIterSignalPropagation

Methods inherited from class fr.cnes.sirius.patrius.bodies.AbstractBodyShape

getBodyFrame, getDistanceEpsilon, getEpsilonSignalPropagation, getLLHCoordinatesSystem, getName, getNativeFrame, getPVCoordinates, setDistanceEpsilon, setEpsilonSignalPropagation, setLLHCoordinatesSystem

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.bodies.BodyShape

buildRadialPointOnShapeSurface, getBodyFrame, getDistanceEpsilon, getEpsilonSignalPropagation, getLLHCoordinatesSystem, getName, setDistanceEpsilon, setEpsilonSignalPropagation, setLLHCoordinatesSystem

Methods inherited from interface fr.cnes.sirius.patrius.orbits.pvcoordinates.PVCoordinatesProvider

getNativeFrame, getPVCoordinates

Field Detail

DEFAULT_ONE_AXIS_ELLIPSOID_NAME

public static final String DEFAULT_ONE_AXIS_ELLIPSOID_NAME

Default ellipsoid name.

See Also:

Constant Field Values

Constructor Detail

OneAxisEllipsoid

public OneAxisEllipsoid(double ae,
                        double f,
                        CelestialBodyFrame bodyFrame)

Constructor for the one axis ellipsoid with default name.

Parameters:

ae - Equatorial radius

f - Flattening (f = (a-b)/a)

bodyFrame - Body frame related to the ellipsoid

OneAxisEllipsoid

public OneAxisEllipsoid(double ae,
                        double f,
                        CelestialBodyFrame bodyFrame,
                        String name)

Constructor for the one axis ellipsoid.

Parameters:

ae - Equatorial radius

f - Flattening (f = (a-b)/a)

bodyFrame - Body frame related to the ellipsoid

name - Name of the ellipsoid

Method Detail

getTransverseRadius

@Deprecated
public double getTransverseRadius()

Deprecated. since 4.13 as this method isn't relevant to this class description, use getEquatorialRadius() instead.

Getter for the transverse radius (major semi axis).

Returns:

the transverse radius

getConjugateRadius

@Deprecated
public double getConjugateRadius()

Deprecated. since 4.13 as this method isn't relevant to this class description, use getPolarRadius() instead.

Getter for the conjugate radius (minor semi axis).

Returns:

the conjugate radius

getEquatorialRadius

public double getEquatorialRadius()

Getter for the equatorial radius of the body.

Returns:

the equatorial radius of the body (m)

getPolarRadius

public double getPolarRadius()

Getter for the polar radius of the body.

Returns:

the polar radius of the body (m)

getFlattening

public double getFlattening()

Getter for the flattening.

Returns:

the flattening

getE2

public double getE2()

Getter for the e2 (eccentricity e squared with e = f * (2.0 - f)).

Returns:

the e2

getG2

public double getG2()

Getter for the g2 (g squared with g = 1.0 - f).

Returns:

the g2

getEncompassingSphereRadius

public double getEncompassingSphereRadius()

Getter for the radius, in meters, of a sphere centered on the body frame origin and encompassing the shape.

Specified by:

getEncompassingSphereRadius in interface BodyShape

Overrides:

getEncompassingSphereRadius in class AbstractEllipsoidBodyShape

Returns:

the encompassing radius

getIntersectionPoint

public EllipsoidPoint getIntersectionPoint(Line line,
                                           Vector3D close,
                                           Frame frame,
                                           AbsoluteDate date,
                                           double altitude)
                                    throws PatriusException

Getter for the intersection point of a line with the surface of the body for a given altitude.

A line may have several intersection points with a closed surface (we consider the one point case as a degenerated two points case). The close parameter is used to select which of these points should be returned. The selected point is the one that is closest to the close point.

Parameters:

line - test line (may intersect the body or not)

close - point used for intersections selection expressed in the body frame

frame - frame in which line is expressed

date - date of the line in given frame

altitude - altitude of the intersection

Returns:

intersection point at provided altitude or null if the line does not intersect the surface

Throws:

PatriusException - if line cannot be converted to body frame

resize

public OneAxisEllipsoid resize(BodyShape.MarginType marginType,
                               double marginValue)

Resize the geometric body shape by a margin.

Parameters:

marginType - margin type to be used

marginValue - margin value to be used (in meters if the margin type is DISTANCE)

Returns:

resized geometric body shape with the margin

computePositionFromEllipsodeticCoordinates

public Vector3D computePositionFromEllipsodeticCoordinates(double latitude,
                                                           double longitude,
                                                           double height)

Compute the position from the ellipsodetic coordinates in body frame.

Specified by:

computePositionFromEllipsodeticCoordinates in interface EllipsoidBodyShape

Overrides:

computePositionFromEllipsodeticCoordinates in class AbstractEllipsoidBodyShape

Parameters:

latitude - latitude coordinate

longitude - longitude coordinate

height - height coordinate (signed value)

Returns:

the position in body frame as Vector3D

transformAndComputeJacobian

@Deprecated
public Vector3D transformAndComputeJacobian(EllipsoidPoint point,
                                                        double[][] jacobian)

Deprecated. since 4.13, use LLHCoordinatesSystem.jacobianToCartesian(BodyPoint) with ELLIPSODETIC coordinates instead.

Transform a surface-relative point to a cartesian point and compute the jacobian of the transformation.

Parameters:

point - geodetic point

jacobian - the jacobian matrix which will be computed (input and output of the method)

Returns:

point at the same location but as a cartesian point

transformAndComputeJacobian

@Deprecated
public EllipsoidPoint transformAndComputeJacobian(Vector3D point,
                                                              Frame frame,
                                                              AbsoluteDate date,
                                                              double[][] jacobian)
                                                       throws PatriusException

Deprecated. since 4.13, use LLHCoordinatesSystem.jacobianFromCartesian(BodyPoint) with ELLIPSODETIC coordinates instead.

Transform a cartesian point to a surface-relative point and compute the jacobian of the transformation.

Parameters:

point - cartesian point

frame - frame in which cartesian point is expressed

date - date of the point in given frame

jacobian - the jacobian matrix which will be computed (input and output of the method)

Returns:

point at the same location but as a surface-relative point, expressed in body frame

Throws:

PatriusException - if point cannot be converted to body frame
if the point is close to one of the poles or if the altitude of the point is "too negative"