fr.cnes.sirius.patrius.bodies

Interface BodyShape

All Superinterfaces:

PVCoordinatesProvider, Serializable

All Known Subinterfaces:

EllipsoidBodyShape, StarConvexBodyShape

All Known Implementing Classes:

AbstractBodyShape, AbstractEllipsoidBodyShape, FacetBodyShape, OneAxisEllipsoid, StarConvexFacetBodyShape, ThreeAxisEllipsoid

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	DEFAULT_DISTANCE_EPSILON Default value of distance epsilon below which the height coordinate is neglected: below this value,the method getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double).
static double	DIRECTION_FACTOR Factor to be multiplied to the direction in order to improve the accuracy of the line creation by increasing the distance between the origin and the second point.

Method Summary

Modifier and Type	Method and Description
BodyPoint	buildPoint(LLHCoordinatesSystem coordSystem, double latitude, double longitude, double height, String name) Build a BodyPoint from LLH coordinates.
BodyPoint	buildPoint(Vector3D position, Frame frame, AbsoluteDate date, String name) Build a BodyPoint from position in provided frame at provided date.
BodyPoint	buildPoint(Vector3D position, String name) Build a BodyPoint from position in body frame.
default BodyPoint	buildRadialPointOnShapeSurface(double bodycentricLatitude, double bodycentricLongitude) Build a body point on the radial direction corresponding to entered bodycentric latitude and longitude: if more than one intersection, the method considers the one farthest to the body frame origin (having the largest norm).
BodyPoint[]	closestPointTo(Line line) This method computes the two points, on the line and on the body, that are the closest to each other.
BodyPoint[]	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.
BodyPoint	closestPointTo(Vector3D point) Computes the point on body surface that is the closest to provided point.
BodyPoint	closestPointTo(Vector3D point, Frame frame, AbsoluteDate date) Computes the point on body surface that is the closest to provided point.
BodyPoint	closestPointTo(Vector3D point, String name) Computes the point on body surface that is the closest to provided point.
double	distanceTo(Line line, Frame frame, AbsoluteDate date) Computes the distance to a line.
double	getApparentRadius(PVCoordinatesProvider pvObserver, AbsoluteDate date, PVCoordinatesProvider occultedBody, AbstractSignalPropagationDetector.PropagationDelayType propagationDelayType) Compute the apparent radius (in meters) of the occulting body from the spacecraft (observer) position.
CelestialBodyFrame	getBodyFrame() Getter for the body frame related to body shape.
double	getDistanceEpsilon() Return the distance epsilon below which the height coordinate is neglected.
double	getEncompassingSphereRadius() Getter for the radius, in meters, of a sphere centered on the body frame origin and encompassing the shape.
double	getEpsilonSignalPropagation() Getter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method.
BodyPoint	getIntersectionPoint(Line line, Vector3D close, Frame frame, AbsoluteDate date) Getter for the intersection point of a line with the surface of the body.
BodyPoint	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.
BodyPoint	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.
BodyPoint[]	getIntersectionPoints(Line line, Frame frame, AbsoluteDate date) Compute the intersection points with a line.
LLHCoordinatesSystem	getLLHCoordinatesSystem() Getter for the LLH coordinates system used by the computed BodyPoint.
String	getName() Getter for the name of the shape.
boolean	isDefaultLLHCoordinatesSystem() Indicate if the current LLH coordinates system set for the body is the default one or not.
BodyShape	resize(BodyShape.MarginType marginType, double marginValue) Resize the geometric body shape by a margin.
void	setDistanceEpsilon(double epsilon) Setter for the distance epsilon below which the height coordinate is neglected.
void	setEpsilonSignalPropagation(double epsilon) Setter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method.
void	setLLHCoordinatesSystem(LLHCoordinatesSystem coordSystem) Setter for the LLH coordinates system to be used by the computed BodyPoint.

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

getNativeFrame, getPVCoordinates

Field Detail

DEFAULT_DISTANCE_EPSILON

static final double DEFAULT_DISTANCE_EPSILON

Default value of distance epsilon below which the height coordinate is neglected: below this value,the method getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double). This distance epsilon is also used to assess if a body point is on the shape surface or not (method BodyPoint.isOnShapeSurface().

See Also:

Constant Field Values

DIRECTION_FACTOR

static final double DIRECTION_FACTOR

Factor to be multiplied to the direction in order to improve the accuracy of the line creation by increasing the distance between the origin and the second point.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Getter for the name of the shape.

Returns:

the name of the shape

getBodyFrame

CelestialBodyFrame getBodyFrame()

Getter for the body frame related to body shape.

Returns:

the body frame related to body shape

getIntersectionPoint

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

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

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

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

BodyPoint 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

getIntersectionPoints

BodyPoint[] 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

getApparentRadius

double getApparentRadius(PVCoordinatesProvider pvObserver,
                         AbsoluteDate date,
                         PVCoordinatesProvider occultedBody,
                         AbstractSignalPropagationDetector.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

closestPointTo

BodyPoint[] 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 BodyPoint (depending on body shape)

Throws:

PatriusException - if line cannot be converted to body frame

closestPointTo

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

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

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

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

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

BodyPoint closestPointTo(Vector3D point)

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

Parameters:

point - a point expressed in body frame

Returns:

the closest point to the provided point on the body surface

closestPointTo

BodyPoint closestPointTo(Vector3D point,
                         String name)

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

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

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

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

buildPoint

BodyPoint buildPoint(Vector3D position,
                     String name)

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

Parameters:

position - position in body frame

name - name of the point

Returns:

BodyPoint from position in body frame

buildPoint

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

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

buildRadialPointOnShapeSurface

default BodyPoint buildRadialPointOnShapeSurface(double bodycentricLatitude,
                                                 double bodycentricLongitude)

Build a body point on the radial direction corresponding to entered bodycentric latitude and longitude: if more than one intersection, the method considers the one farthest to the body frame origin (having the largest norm).

Parameters:

bodycentricLatitude - bodycentric latitude

bodycentricLongitude - bodycentric longitude

Returns:

the radial point at the surface of the body shape

getDistanceEpsilon

double getDistanceEpsilon()

Return the distance epsilon below which the height coordinate is neglected. This epsilon value can be modified using dedicated setter.

• Below this distance epsilon, the method getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double),
• The method BodyPoint.isOnShapeSurface() will return true if the absolute value of its normal height is lower than this distance epsilon.

Returns:

the altitude epsilon

setDistanceEpsilon

void setDistanceEpsilon(double epsilon)

Setter for the distance epsilon below which the height coordinate is neglected.

Parameters:

epsilon - distance epsilon to be set

getLLHCoordinatesSystem

LLHCoordinatesSystem getLLHCoordinatesSystem()

Getter for the LLH coordinates system used by the computed BodyPoint.

Returns:

the coordinates system

setLLHCoordinatesSystem

void setLLHCoordinatesSystem(LLHCoordinatesSystem coordSystem)

Setter for the LLH coordinates system to be used by the computed BodyPoint.

Parameters:

coordSystem - LLH coordinates system to be set

isDefaultLLHCoordinatesSystem

boolean isDefaultLLHCoordinatesSystem()

Indicate if the current LLH coordinates system set for the body is the default one or not.

Returns:

true if the current LLH coordinates system is the default one, false otherwise

getEncompassingSphereRadius

double getEncompassingSphereRadius()

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

Returns:

the encompassing radius

getEpsilonSignalPropagation

double getEpsilonSignalPropagation()

Getter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method. This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver).

Returns:

the epsilon for signal propagation

setEpsilonSignalPropagation

void setEpsilonSignalPropagation(double epsilon)

Setter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method. This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver).

Parameters:

epsilon - epsilon for signal propagation