fr.cnes.sirius.patrius.bodies

Interface BodyShape

All Superinterfaces:

PVCoordinatesProvider, Serializable

All Known Subinterfaces:

EllipsoidBodyShape, StarConvexBodyShape

All Known Implementing Classes:

FacetBodyShape, OneAxisEllipsoid, ProjectionEllipsoid, StarConvexFacetBodyShape

public interface BodyShape
extends PVCoordinatesProvider

Extended interface for celestial bodies shapes : extends the OREKIT's BodyShape interface by adding geometric methods.

Since:

1.2

Version:

$Id: GeometricBodyShape.java 18080 2017-10-02 16:53:17Z bignon $

Author:

Thomas Trapier

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BodyShape.MarginType Margin type.

Field Summary

Fields

Modifier and Type	Field and Description
static double	EPS_ALTITUDE Epsilon altitude below which getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double).

Method Summary

Modifier and Type	Method and Description
default Vector3D[]	closestPointTo(Line line) This method computes the two points, on the line and on the body, that are the closest to each other.
Vector3D[]	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.
double	distanceTo(Line line, Frame frame, AbsoluteDate date) Computes the distance to a line.
double	getApparentRadius(PVCoordinatesProvider pvObserver, AbsoluteDate date, PVCoordinatesProvider occultedBody, AbstractDetector.PropagationDelayType propagationDelayType) Compute the apparent radius (in meters) of the occulting body from the spacecraft (observer) position.
Frame	getBodyFrame() Get body frame related to body shape.
GeodeticPoint	getIntersectionPoint(Line line, Vector3D close, Frame frame, AbsoluteDate date) Get the intersection point of a line with the surface of the body.
GeodeticPoint	getIntersectionPoint(Line line, Vector3D close, Frame frame, AbsoluteDate date, double altitude) Get the intersection point of a line with the surface of the body for a given altitude.
Vector3D[]	getIntersectionPoints(Line line, Frame frame, AbsoluteDate date) Compute the intersection points with a line.
String	getName()
BodyShape	resize(BodyShape.MarginType marginType, double marginValue) Resize the geometric body shape by a margin.
Vector3D	transform(GeodeticPoint point) Transform a surface-relative point to a cartesian point.
GeodeticPoint	transform(Vector3D point, Frame frame, AbsoluteDate date) Transform a cartesian point to a surface-relative point.
GeodeticPoint	transformFromZenith(Vector3D point, Vector3D zenith, Frame frame, AbsoluteDate date) Computes a geodetic point from a normal vector by using spherical coordinates.

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

getNativeFrame, getPVCoordinates

Field Detail

EPS_ALTITUDE

static final double EPS_ALTITUDE

Epsilon altitude below which getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double).

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns:

the name of the shape

getBodyFrame

Frame getBodyFrame()

Get body frame related to body shape.

Returns:

body frame related to body shape

getIntersectionPoints

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

Compute the intersection points with a line.

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

getIntersectionPoint

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

Get 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

getIntersectionPoint

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

Get 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.

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

distanceTo

double distanceTo(Line line,
                  Frame frame,
                  AbsoluteDate date)
           throws PatriusException

Computes the distance to a line.

Parameters:

line - the line

frame - in which line is expressed

date - date of the line in given frame

Returns:

the shortest distance between the the line and the shape

Throws:

PatriusException - if line cannot be converted to body frame

getApparentRadius

double getApparentRadius(PVCoordinatesProvider pvObserver,
                         AbsoluteDate date,
                         PVCoordinatesProvider occultedBody,
                         AbstractDetector.PropagationDelayType propagationDelayType)
                  throws PatriusException

Compute the apparent radius (in meters) of the occulting body from the spacecraft (observer) position. Given a plane containing the spacecraft (observer) position, the center of the occulting body and the center of the occulted body, and given a line contained within this plane, passing by the spacecraft (observer) position and tangent to the mesh of the occulting body, the apparent radius corresponds to the length of the line starting from the center of the occulting body, perpendicular to the first given line and ending at the intersection of the two lines.

Parameters:

pvObserver - the spacecraft (observer) position-velocity

date - the date at which the signal is received by the observer (reception date)

occultedBody - the body which is occulted to the spacecraft (observer) by the occulting body

propagationDelayType - propagation delay type

Returns:

the apparent radius (in meters) of the occulting body from the spacecraft (observer) position

Throws:

PatriusException - if the PVCoordinatesProvider computation fails

resize

BodyShape resize(BodyShape.MarginType marginType,
                 double marginValue)
          throws PatriusException

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

Throws:

PatriusException - if the margin value is invalid

transform

GeodeticPoint transform(Vector3D point,
                        Frame frame,
                        AbsoluteDate date)
                 throws PatriusException

Transform a cartesian point to a surface-relative point.

Parameters:

point - cartesian point

frame - frame in which cartesian point is expressed

date - date of the computation (used for frames conversions)

Returns:

point at the same location but as a surface-relative point

Throws:

PatriusException - if point cannot be converted to body frame

transform

Vector3D transform(GeodeticPoint point)

Transform a surface-relative point to a cartesian point.

Parameters:

point - surface-relative point

Returns:

point at the same location but as a cartesian point

transformFromZenith

GeodeticPoint transformFromZenith(Vector3D point,
                                  Vector3D zenith,
                                  Frame frame,
                                  AbsoluteDate date)
                           throws PatriusException

Computes a geodetic point from a normal vector by using spherical coordinates.

If no normal is provided (null) then it transforms the cartesian point to a surface-relative point, using the true shape of the body: in case of a facet shape the normal used is the normal of the closest triangle.

Spherical coordinates are then applied to provided normal or shape's normal so as to compute corresponding longitude and latitude (spherical azimuth and elevation).

The difference of this method with the classic transform method is that either the user defines the normal or the normal is based on model's true shape. The result is that resulting point's longitude and latitude are the same than those of a point with the same normal on a sphere. Therefore, users shall be aware that for instance a vertical facet at North pole leads to horizontal normal, meaning that returned point's latitude will be zero as if the point belonged to the equator.

Parameters:

point - cartesian point

zenith - local surface normal used as topocentric zenith. May be null, if so true local zenith is recomputed

frame - frame in which point and zenith are expressed

date - date of the computation (used for frames conversions)

Returns:

point at the same location but as a surface-relative point, computed thanks to the local normal of model's true shape and a spherical transformation

Throws:

PatriusException - if point cannot be converted to body frame

closestPointTo

Vector3D[] 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.

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 Vector3D

Throws:

PatriusException - if line cannot be converted to body frame

closestPointTo

default Vector3D[] closestPointTo(Line line)
                           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.

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

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 Vector3D

Throws:

PatriusException - if line cannot be converted to body frame