fr.cnes.sirius.patrius.bodies

Interface EllipsoidBodyShape

All Superinterfaces:

BodyShape, PVCoordinatesProvider, Serializable, StarConvexBodyShape

All Known Implementing Classes:

AbstractEllipsoidBodyShape, OneAxisEllipsoid, ThreeAxisEllipsoid

public interface EllipsoidBodyShape
extends StarConvexBodyShape

Extended interface for spheroid model to represent celestial bodies shape : extends the StarConvexBodyShape interface by adding getters to access the spheroid parameters.

Since:

4.3

See Also:

StarConvexBodyShape

Nested Class Summary

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

BodyShape.MarginType

Field Summary

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

DEFAULT_DISTANCE_EPSILON, DIRECTION_FACTOR

Method Summary

Modifier and Type	Method and Description
EllipsoidPoint	buildPoint(LLHCoordinatesSystem coordSystem, double latitude, double longitude, double height, String name) Build a BodyPoint from LLH coordinates.
EllipsoidPoint	buildPoint(Vector3D position, Frame frame, AbsoluteDate date, String name) Build a BodyPoint from position in provided frame at provided date.
EllipsoidPoint	buildPoint(Vector3D position, String name) Build a BodyPoint from position in body frame.
EllipsoidPoint[]	closestPointTo(Line line) This method computes the two points, on the line and on the body, that are the closest to each other.
EllipsoidPoint[]	closestPointTo(Line line, Frame frame, AbsoluteDate date) This method computes the two points, on the line and on the body, that are the closest to each other.
EllipsoidPoint	closestPointTo(Vector3D point) Computes the point on body surface that is the closest to provided point.
EllipsoidPoint	closestPointTo(Vector3D point, Frame frame, AbsoluteDate date) Computes the point on body surface that is the closest to provided point.
EllipsoidPoint	closestPointTo(Vector3D point, String name) Computes the point on body surface that is the closest to provided point.
Vector3D	computePositionFromEllipsodeticCoordinates(double latitude, double longitude, double height) Compute the position from the ellipsodetic coordinates in body frame.
double	getARadius() Getter for the semi axis A.
double	getBRadius() Getter for the semi axis B.
double	getConjugateRadius() Deprecated. since 4.13 as this method isn't relevant to this class description, use getCRadius() instead.
double	getCRadius() Getter for the semi axis C.
double	getE2() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be kept in the OneAxisEllipsoid class. Cast you ellipsoid to this type to continue to use it.
IEllipsoid	getEllipsoid() Getter for the spheroid object.
double	getEquatorialRadius() Deprecated. since 4.13 as this method isn't relevant to this class description, use getARadius() instead. Also, this method will be kept in the OneAxisEllipsoid class, so you can cast your ellipsoid to this type to continue to use it.
double	getFlattening() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be kept in the OneAxisEllipsoid class. Cast you ellipsoid to this type to continue to use it.
double	getG2() Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be kept in the OneAxisEllipsoid class. Cast you ellipsoid to this type to continue to use it.
EllipsoidPoint	getIntersectionPoint(Line line, Vector3D close, Frame frame, AbsoluteDate date) Getter for the intersection point of a line with the surface of the body.
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.
EllipsoidPoint	getIntersectionPoint(Line line, Vector3D close, Frame frame, AbsoluteDate date, String name) Getwter for the intersection point of a line with the surface of the body.
EllipsoidPoint[]	getIntersectionPoints(Line line, Frame frame, AbsoluteDate date) Compute the intersection points with a line.
double	getTransverseRadius() Deprecated. since 4.13 as this method isn't relevant to this class description, use getARadius() or getBRadius() according to the ellipsoid description instead.
boolean	isSpherical() Indicate if the ellipsoid can be considered as a sphere.

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

buildRadialPointOnShapeSurface, distanceTo, getApparentRadius, getBodyFrame, getDistanceEpsilon, getEncompassingSphereRadius, getEpsilonSignalPropagation, getLLHCoordinatesSystem, getName, isDefaultLLHCoordinatesSystem, resize, setDistanceEpsilon, setEpsilonSignalPropagation, setLLHCoordinatesSystem

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

getNativeFrame, getPVCoordinates

Method Detail

getARadius

double getARadius()

Getter for the semi axis A.

Returns:

the semi axis A

getBRadius

double getBRadius()

Getter for the semi axis B.

Returns:

the semi axis B

getCRadius

double getCRadius()

Getter for the semi axis C.

Returns:

the semi axis C

isSpherical

boolean isSpherical()

Indicate if the ellipsoid can be considered as a sphere.

Returns:

true if the ellipsoid can be considered as a sphere, false otherwise

getEquatorialRadius

@Deprecated
double getEquatorialRadius()

Deprecated. since 4.13 as this method isn't relevant to this class description, use getARadius() instead. Also, this method will be kept in the OneAxisEllipsoid class, so you can cast your ellipsoid to this type to continue to use it.

Getter for the equatorial radius of the body.

Returns:

the equatorial radius of the body (m)

getTransverseRadius

@Deprecated
double getTransverseRadius()

Deprecated. since 4.13 as this method isn't relevant to this class description, use getARadius() or getBRadius() according to the ellipsoid description instead.

Getter for the transverse radius (major semi axis).

Returns:

the transverse radius

getConjugateRadius

@Deprecated
double getConjugateRadius()

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

Getter for the conjugate radius (minor semi axis).

Returns:

the conjugate radius

getFlattening

@Deprecated
double getFlattening()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be kept in the OneAxisEllipsoid class. Cast you ellipsoid to this type to continue to use it.

Getter for the flattening.

Returns:

the flattening

getE2

@Deprecated
double getE2()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be kept in the OneAxisEllipsoid class. Cast you ellipsoid to this type to continue to use it.

Getter for the e2 (shape parameter).

Returns:

the e2

getG2

@Deprecated
double getG2()

Deprecated. since 4.13 as this method isn't relevant to this class description. This method will be kept in the OneAxisEllipsoid class. Cast you ellipsoid to this type to continue to use it.

Getter for the g2 (shape parameter).

Returns:

the g2

getEllipsoid

IEllipsoid getEllipsoid()

Getter for the spheroid object.

Returns:

the spheroid

closestPointTo

EllipsoidPoint[] closestPointTo(Line line,
                                Frame frame,
                                AbsoluteDate date)
                         throws PatriusException

This method computes the two points, on the line and on the body, that are the closest to each other. The returned points are identical if the line intersects the shape: this point is the one with the lowest abscissa. The returned point with index 0 is the point on the Line, while the returned point with index 1 is the point on this.

Note: calculations take the line's minimum abscissa into account.

Specified by:

closestPointTo in interface BodyShape

Parameters:

line - the original line for the shortest distance computation

frame - the line's frame

date - the current date

Returns:

an array of length 2 containing the point of the line (slot [0]) and the point of the shape (slot [1]) expressed as BodyPoint (depending on body shape)

Throws:

PatriusException - if line cannot be converted to body frame

closestPointTo

EllipsoidPoint[] closestPointTo(Line line)

This method computes the two points, on the line and on the body, that are the closest to each other. The returned points are identical if the line intersects the shape: this point is the one with the lowest abscissa. The returned point with index 0 is the point on the Line, while the returned point with index 1 is the point on this.

Note: calculations take the line's minimum abscissa into account.

In this method we consider that the line's frame is the body frame, and the date is the AbsoluteDate.J2000_EPOCH.

Specified by:

closestPointTo in interface BodyShape

Parameters:

line - the original line for the shortest distance computation

Returns:

an array of length 2 containing the point of the line (slot [0]) and the point of the shape (slot [1]) expressed as BodyPoint (depending on body shape)

closestPointTo

EllipsoidPoint closestPointTo(Vector3D point,
                              Frame frame,
                              AbsoluteDate date)
                       throws PatriusException

Computes the point on body surface that is the closest to provided point.

Specified by:

closestPointTo in interface BodyShape

Parameters:

point - a point expressed in provided frame

frame - frame

date - date

Returns:

the closest point to the provided point on the body surface

Throws:

PatriusException - if computation failed

closestPointTo

EllipsoidPoint closestPointTo(Vector3D point)

Computes the point on body surface that is the closest to provided point.

Specified by:

closestPointTo in interface BodyShape

Parameters:

point - a point expressed in body frame

Returns:

the closest point to the provided point on the body surface

closestPointTo

EllipsoidPoint closestPointTo(Vector3D point,
                              String name)

Computes the point on body surface that is the closest to provided point.

Specified by:

closestPointTo in interface BodyShape

Parameters:

point - a point expressed in body frame

name - name of the point

Returns:

the closest point to the provided point on the body surface

buildPoint

EllipsoidPoint buildPoint(Vector3D position,
                          String name)

Build a BodyPoint from position in body frame. Type of returned body point depends on body.

Specified by:

buildPoint in interface BodyShape

Parameters:

position - position in body frame

name - name of the point

Returns:

BodyPoint from position in body frame

buildPoint

EllipsoidPoint buildPoint(Vector3D position,
                          Frame frame,
                          AbsoluteDate date,
                          String name)
                   throws PatriusException

Build a BodyPoint from position in provided frame at provided date. Type of returned body point depends on body.

Specified by:

buildPoint in interface BodyShape

Parameters:

position - position in provided frame at provided date

frame - frame

date - date

name - name of the point

Returns:

BodyPoint from position in provided frame at provided date

Throws:

PatriusException - if failed to build point

buildPoint

EllipsoidPoint buildPoint(LLHCoordinatesSystem coordSystem,
                          double latitude,
                          double longitude,
                          double height,
                          String name)

Build a BodyPoint from LLH coordinates. Type of returned body point depends on body.

Specified by:

buildPoint in interface BodyShape

Parameters:

coordSystem - LLH coordinates system in which are expressed the entered lat/long/height

latitude - input latitude

longitude - input longitude

height - input height

name - name of the point

Returns:

a body point

getIntersectionPoint

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

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

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.

Specified by:

getIntersectionPoint in interface BodyShape

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

Returns:

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

Throws:

PatriusException - if line cannot be converted to body frame

getIntersectionPoint

EllipsoidPoint getIntersectionPoint(Line line,
                                    Vector3D close,
                                    Frame frame,
                                    AbsoluteDate date,
                                    String name)
                             throws PatriusException

Getwter for the intersection point of a line with the surface of the body.

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.

Specified by:

getIntersectionPoint in interface BodyShape

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

name - name of the point

Returns:

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

Throws:

PatriusException - if line cannot be converted to body frame

getIntersectionPoint

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.

Specified by:

getIntersectionPoint in interface BodyShape

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

getIntersectionPoints

EllipsoidPoint[] getIntersectionPoints(Line line,
                                       Frame frame,
                                       AbsoluteDate date)
                                throws PatriusException

Compute the intersection points with a line.

Specified by:

getIntersectionPoints in interface BodyShape

Parameters:

line - the line

frame - in which line is expressed

date - date of the line in given frame

Returns:

the intersection points if they exist. If no intersection is found, the dimension is zero

Throws:

PatriusException - if line cannot be converted to body frame

computePositionFromEllipsodeticCoordinates

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

Compute the position from the ellipsodetic coordinates in body frame.

Parameters:

latitude - latitude coordinate

longitude - longitude coordinate

height - height coordinate (signed value)

Returns:

the position in body frame as Vector3D