fr.cnes.sirius.patrius.bodies

Class AbstractEllipsoidBodyShape

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractBodyShape

fr.cnes.sirius.patrius.bodies.AbstractEllipsoidBodyShape

All Implemented Interfaces:

BodyShape, EllipsoidBodyShape, StarConvexBodyShape, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

OneAxisEllipsoid, ThreeAxisEllipsoid

public abstract class AbstractEllipsoidBodyShape
extends AbstractBodyShape
implements EllipsoidBodyShape

Abstract class for an ellipsoid body shape to mutualize parameters and features.

Since:

4.13

Author:

Thibaut BONIT

See Also:

AbstractBodyShape, EllipsoidBodyShape, Serialized Form

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 double	CLOSE_APPROACH_THRESHOLD Close approach threshold.
static LLHCoordinatesSystem	DEFAULT_LLH_COORD_SYSTEM Ellipsodetic used as default LLH coordinates system for the computed EllipsoidPoint.
protected IEllipsoid	ellipsoid Ellipsoid geometric representation.
protected int	maxIterSignalPropagation Maximum number of iterations for signal propagation computation

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
AbstractEllipsoidBodyShape(IEllipsoid ellipsoid, CelestialBodyFrame bodyFrame, boolean isSpherical, String name) Constructor for the ellipsoid.
AbstractEllipsoidBodyShape(IEllipsoid ellipsoid, CelestialBodyFrame bodyFrame, boolean spherical, String name, LLHCoordinatesSystem lLHCoordinatesSystem) Constructor for the ellipsoid.
AbstractEllipsoidBodyShape(IEllipsoid ellipsoid, CelestialBodyFrame bodyFrame, String name) Constructor for the ellipsoid.

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	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.
double	getARadius() Getter for the semi axis A.
double	getBRadius() Getter for the semi axis B.
double	getCRadius() Getter for the semi axis C.
IEllipsoid	getEllipsoid() Getter for the spheroid object.
double	getEncompassingSphereRadius() Getter for the radius, in meters, of a sphere centered on the body frame origin and encompassing the shape.
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, 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.
int	getMaxIterSignalPropagation() Get the maximum number of iterations for signal propagation when signal propagation is taken into account.
boolean	isDefaultLLHCoordinatesSystem() Indicate if the current LLH coordinates system set for the body is the default one or not.
boolean	isSpherical() Indicate if the ellipsoid can be considered as a sphere.
void	setConvergenceThreshold(double newThreshold) Setter for the Newton algorithm threshold used to compute distance to the ellipsoid using method distanceTo(Line, Frame, AbsoluteDate).
void	setMaxIterSignalPropagation(int maxIterSignalPropagationIn) Set the maximum number of iterations for signal propagation when signal propagation is taken into account.

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

getConjugateRadius, getE2, getEquatorialRadius, getFlattening, getG2, getIntersectionPoint, getTransverseRadius

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

buildRadialPointOnShapeSurface, getBodyFrame, getDistanceEpsilon, getEpsilonSignalPropagation, getLLHCoordinatesSystem, getName, resize, setDistanceEpsilon, setEpsilonSignalPropagation, setLLHCoordinatesSystem

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

getNativeFrame, getPVCoordinates

Field Detail

DEFAULT_LLH_COORD_SYSTEM

public static final LLHCoordinatesSystem DEFAULT_LLH_COORD_SYSTEM

Ellipsodetic used as default LLH coordinates system for the computed EllipsoidPoint.

CLOSE_APPROACH_THRESHOLD

public static final double CLOSE_APPROACH_THRESHOLD

Close approach threshold.

See Also:

Constant Field Values

ellipsoid

protected final IEllipsoid ellipsoid

Ellipsoid geometric representation.

maxIterSignalPropagation

protected int maxIterSignalPropagation

Maximum number of iterations for signal propagation computation

Constructor Detail

AbstractEllipsoidBodyShape

public AbstractEllipsoidBodyShape(IEllipsoid ellipsoid,
                                  CelestialBodyFrame bodyFrame,
                                  String name)

Constructor for the ellipsoid.

By default, the DEFAULT_LLH_COORD_SYSTEM is used and the ellipsoid isn't considered as a sphere.

Parameters:

ellipsoid - Ellipsoid geometric representation

bodyFrame - Body frame related to the ellipsoid

name - Name of the ellipsoid

AbstractEllipsoidBodyShape

public AbstractEllipsoidBodyShape(IEllipsoid ellipsoid,
                                  CelestialBodyFrame bodyFrame,
                                  boolean isSpherical,
                                  String name)

Constructor for the ellipsoid.

By default, the DEFAULT_LLH_COORD_SYSTEM is used.

Parameters:

ellipsoid - Ellipsoid geometric representation

bodyFrame - Body frame related to the ellipsoid

isSpherical - Indicate if the ellipsoid can be considered as a sphere or not

name - Name of the ellipsoid

AbstractEllipsoidBodyShape

public AbstractEllipsoidBodyShape(IEllipsoid ellipsoid,
                                  CelestialBodyFrame bodyFrame,
                                  boolean spherical,
                                  String name,
                                  LLHCoordinatesSystem lLHCoordinatesSystem)

Constructor for the ellipsoid.

Parameters:

ellipsoid - Ellipsoid geometric representation

bodyFrame - Body frame related to the ellipsoid

spherical - Indicate if the ellipsoid can be considered as a sphere or not

name - Name of the ellipsoid

lLHCoordinatesSystem - Ellipsoid coordinates system

Method Detail

getARadius

public double getARadius()

Getter for the semi axis A.

Specified by:

getARadius in interface EllipsoidBodyShape

Returns:

the semi axis A

getBRadius

public double getBRadius()

Getter for the semi axis B.

Specified by:

getBRadius in interface EllipsoidBodyShape

Returns:

the semi axis B

getCRadius

public double getCRadius()

Getter for the semi axis C.

Specified by:

getCRadius in interface EllipsoidBodyShape

Returns:

the semi axis C

isSpherical

public boolean isSpherical()

Indicate if the ellipsoid can be considered as a sphere.

Specified by:

isSpherical in interface EllipsoidBodyShape

Returns:

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

getEncompassingSphereRadius

public double getEncompassingSphereRadius()

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

Specified by:

getEncompassingSphereRadius in interface BodyShape

Returns:

the encompassing radius

isDefaultLLHCoordinatesSystem

public boolean isDefaultLLHCoordinatesSystem()

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

Specified by:

isDefaultLLHCoordinatesSystem in interface BodyShape

Returns:

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

getIntersectionPoint

public 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

Specified by:

getIntersectionPoint in interface EllipsoidBodyShape

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

public 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

Specified by:

getIntersectionPoint in interface EllipsoidBodyShape

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

getIntersectionPoints

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

Compute the intersection points with a line.

Specified by:

getIntersectionPoints in interface BodyShape

Specified by:

getIntersectionPoints in interface EllipsoidBodyShape

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

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

Computes the distance to a line.

Specified by:

distanceTo in interface BodyShape

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

getEllipsoid

public IEllipsoid getEllipsoid()

Getter for the spheroid object.

Specified by:

getEllipsoid in interface EllipsoidBodyShape

Returns:

the spheroid

closestPointTo

public 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

Specified by:

closestPointTo in interface EllipsoidBodyShape

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

public 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

Specified by:

closestPointTo in interface EllipsoidBodyShape

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

public 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

Specified by:

closestPointTo in interface EllipsoidBodyShape

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

public EllipsoidPoint closestPointTo(Vector3D point)

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

Specified by:

closestPointTo in interface BodyShape

Specified by:

closestPointTo in interface EllipsoidBodyShape

Parameters:

point - a point expressed in body frame

Returns:

the closest point to the provided point on the body surface

closestPointTo

public 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

Specified by:

closestPointTo in interface EllipsoidBodyShape

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

public 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

Specified by:

buildPoint in interface EllipsoidBodyShape

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

public 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

Specified by:

buildPoint in interface EllipsoidBodyShape

Parameters:

position - position in body frame

name - name of the point

Returns:

BodyPoint from position in body frame

buildPoint

public 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

Specified by:

buildPoint in interface EllipsoidBodyShape

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

computePositionFromEllipsodeticCoordinates

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

Compute the position from the ellipsodetic coordinates in body frame.

Specified by:

computePositionFromEllipsodeticCoordinates in interface EllipsoidBodyShape

Parameters:

latitude - latitude coordinate

longitude - longitude coordinate

height - height coordinate (signed value)

Returns:

the position in body frame as Vector3D

getApparentRadius

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

Warning: When used with earth ellipsoid, the computation of sight axis local elevation on earth uses a rapid algorithm with limited accuracy : typically 1.3e-4 degrees (worst case, satellite altitude 250 Km, latitude 45 deg., East sight direction) if sight axis is 25 degrees above horizon, and 1.4e-6 degrees (worst case) if sight axis is 0,25 degrees above horizon.

Specified by:

getApparentRadius in interface BodyShape

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

setConvergenceThreshold

public void setConvergenceThreshold(double newThreshold)

Setter for the Newton algorithm threshold used to compute distance to the ellipsoid using method distanceTo(Line, Frame, AbsoluteDate). Method distanceTo(Line, Frame, AbsoluteDate) is used in particular in SensorModel. Default value for this threshold is 1E-11.

Parameters:

newThreshold - new threshold to set

getMaxIterSignalPropagation

public int getMaxIterSignalPropagation()

Get the maximum number of iterations for signal propagation when signal propagation is taken into account.

Returns:

returns the maximum number of iterations for signal propagation when signal propagation is taken into account.

setMaxIterSignalPropagation

public void setMaxIterSignalPropagation(int maxIterSignalPropagationIn)

Set the maximum number of iterations for signal propagation when signal propagation is taken into account.

Parameters:

maxIterSignalPropagationIn - maximum number of iterations for signal propagation