fr.cnes.sirius.patrius.bodies

Class ThreeAxisEllipsoid

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractBodyShape

fr.cnes.sirius.patrius.bodies.AbstractEllipsoidBodyShape

fr.cnes.sirius.patrius.bodies.ThreeAxisEllipsoid

All Implemented Interfaces:

BodyShape, EllipsoidBodyShape, StarConvexBodyShape, PVCoordinatesProvider, Serializable

public class ThreeAxisEllipsoid
extends AbstractEllipsoidBodyShape

Three axis ellipsoid representation.

This ellipsoid is fully defined by its three axis radius (along the directions Vector3D.PLUS_I / Vector3D.PLUS_J / Vector3D.PLUS_K) and its associated body frame.

Since:

4.13

Author:

Thibaut BONIT

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_THREE_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
ThreeAxisEllipsoid(double aRadius, double bRadius, double cRadius, CelestialBodyFrame bodyFrame) Constructor for the three axis ellipsoid with default name.
ThreeAxisEllipsoid(double aRadius, double bRadius, double cRadius, CelestialBodyFrame bodyFrame, String name) Constructor for the three axis ellipsoid.

Method Summary

Modifier and Type	Method and Description
double	getConjugateRadius() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.
double	getE2() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.
double	getEquatorialRadius() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.
double	getFlattening() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.
double	getG2() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.
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	getTransverseRadius() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.
ThreeAxisEllipsoid	resize(BodyShape.MarginType marginType, double marginValue) Resize the geometric body shape by a margin.

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

buildPoint, buildPoint, buildPoint, closestPointTo, closestPointTo, closestPointTo, closestPointTo, closestPointTo, computePositionFromEllipsodeticCoordinates, distanceTo, getApparentRadius, getARadius, getBRadius, getCRadius, getEllipsoid, getEncompassingSphereRadius, 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_THREE_AXIS_ELLIPSOID_NAME

public static final String DEFAULT_THREE_AXIS_ELLIPSOID_NAME

Default ellipsoid name.

See Also:

Constant Field Values

Constructor Detail

ThreeAxisEllipsoid

public ThreeAxisEllipsoid(double aRadius,
                          double bRadius,
                          double cRadius,
                          CelestialBodyFrame bodyFrame)

Constructor for the three axis ellipsoid with default name.

Parameters:

aRadius - Transverse radius A: semi axis of the ellipsoid along the direction Vector3D.PLUS_I

bRadius - Transverse radius B: semi axis of the ellipsoid along the direction Vector3D.PLUS_J

cRadius - Conjugate radius C: semi axis of the ellipsoid along the direction Vector3D.PLUS_K

bodyFrame - Body frame related to the ellipsoid

ThreeAxisEllipsoid

public ThreeAxisEllipsoid(double aRadius,
                          double bRadius,
                          double cRadius,
                          CelestialBodyFrame bodyFrame,
                          String name)

Constructor for the three axis ellipsoid.

Parameters:

aRadius - Transverse radius A: semi axis of the ellipsoid along the direction Vector3D.PLUS_I

bRadius - Transverse radius B: semi axis of the ellipsoid along the direction Vector3D.PLUS_J

cRadius - Conjugate radius C: semi axis of the ellipsoid along the direction Vector3D.PLUS_K

bodyFrame - Body frame related to the ellipsoid

name - Name of the ellipsoid

Method Detail

getE2

@Deprecated
public double getE2()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.

Getter for the e2 (shape parameter).

Returns:

an UnsupportedOperationException

getG2

@Deprecated
public double getG2()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.

Getter for the g2 (shape parameter).

Returns:

an UnsupportedOperationException

getTransverseRadius

@Deprecated
public double getTransverseRadius()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.

Getter for the transverse radius (major semi axis).

Returns:

an UnsupportedOperationException

getConjugateRadius

@Deprecated
public double getConjugateRadius()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.

Getter for the conjugate radius (minor semi axis).

Returns:

an UnsupportedOperationException

getEquatorialRadius

@Deprecated
public double getEquatorialRadius()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.

Getter for the equatorial radius of the body.

Returns:

an UnsupportedOperationException

getFlattening

@Deprecated
public double getFlattening()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be only kept in the OneAxisEllipsoid class.

Getter for the flattening.

Returns:

an UnsupportedOperationException

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 ThreeAxisEllipsoid 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