fr.cnes.sirius.patrius.bodies

Interface GeometricBodyShape

All Superinterfaces:

BodyShape, PVCoordinatesProvider, Serializable

All Known Subinterfaces:

EllipsoidBodyShape

All Known Implementing Classes:

ExtendedOneAxisEllipsoid, FacetBodyShape, ProjectionEllipsoid

public interface GeometricBodyShape
extends BodyShape, 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

See Also:

BodyShape

Nested Class Summary

Nested Classes

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

Field Summary

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

EPS_ALTITUDE

Method Summary

Modifier and Type	Method and Description
double	distanceTo(Line line, Frame frame, AbsoluteDate date) Computes the distance to a line.
Vector3D[]	getIntersectionPoints(Line line, Frame frame, AbsoluteDate date) Compute the intersection points with a line.
double	getLocalRadius(Vector3D posObserver, Frame frame, AbsoluteDate date, PVCoordinatesProvider occultedBody) Compute the apparent radius (in meters) of the occulting body from the spacecraft (observer) position.
String	getName()
GeometricBodyShape	resize(GeometricBodyShape.MarginType marginType, double marginValue) Resize the geometric body shape by a margin.

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

getBodyFrame, getIntersectionPoint, getIntersectionPoint, transform, transform

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

getNativeFrame, getPVCoordinates

Method Detail

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

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

getName

String getName()

Returns:

the name of the shape

getLocalRadius

double getLocalRadius(Vector3D posObserver,
                      Frame frame,
                      AbsoluteDate date,
                      PVCoordinatesProvider occultedBody)
               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.

Please notice that this method will for the moment be used only with an instantaneous propagation delay type.

Parameters:

posObserver - the spacecraft (observer) position

frame - the reference frame in which the spacecraft (observer) position is expressed

date - the date at which the spacecraft (observer) position is expressed

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

Returns:

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

Throws:

PatriusException - if the PVCoordinatesProvider computation fails

resize

GeometricBodyShape resize(GeometricBodyShape.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