fr.cnes.sirius.patrius.orbits.orbitalparameters

Class KeplerianParameters

java.lang.Object

fr.cnes.sirius.patrius.orbits.orbitalparameters.AbstractOrbitalParameters

fr.cnes.sirius.patrius.orbits.orbitalparameters.KeplerianParameters

All Implemented Interfaces:

IOrbitalParameters, Serializable

public class KeplerianParameters
extends AbstractOrbitalParameters

This class handles traditional keplerian orbital parameters.

The parameters used internally are the classical keplerian elements:

     a
     e
     i
     ω
     Ω
     v
 

where ω stands for the Perigee Argument, Ω stands for the Right Ascension of the Ascending Node and v stands for the true anomaly.

The eccentricity must be greater than or equal to zero.

This class supports hyperbolic orbits, using the convention that semi major axis is negative for such orbits (and of course eccentricity is greater than 1).

When orbit is either equatorial or circular, some keplerian elements (more precisely ω and Ω) become ambiguous so this class should not be used for such orbits. For this reason, equinoctial parameters is the recommended way to represent orbits.

Since:

3.0

Version:

$Id: KeplerianParameters.java 18071 2017-10-02 16:46:39Z bignon $

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
KeplerianParameters(double aIn, double eIn, double iIn, double paIn, double raanIn, double anomaly, PositionAngle type, double mu) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Test for the equality of two orbits.
double	getA() Get the semi-major axis.
AlternateEquinoctialParameters	getAlternateEquinoctialParameters() Convert current orbital parameters into alternate equinoctial parameters.
double	getAnomaly(PositionAngle type) Get the anomaly.
ApsisAltitudeParameters	getApsisAltitudeParameters(double ae) Convert current orbital parameters into apsis (using altitude) parameters.
ApsisRadiusParameters	getApsisRadiusParameters() Convert current orbital parameters into apsis (using radius) parameters.
CartesianParameters	getCartesianParameters() Convert current orbital parameters into cartesian parameters.
CircularParameters	getCircularParameters() Convert current orbital parameters into circular parameters.
double	getE() Get the eccentricity.
double	getEccentricAnomaly() Get the eccentric anomaly.
EquatorialParameters	getEquatorialParameters() Convert current orbital parameters into equatorial parameters.
EquinoctialParameters	getEquinoctialParameters() Convert current orbital parameters into equinoctial parameters.
double	getI() Get the inclination.
KeplerianParameters	getKeplerianParameters() Convert current orbital parameters into Keplerian parameters.
double	getMeanAnomaly() Get the mean anomaly.
double	getPerigeeArgument() Get the perigee argument.
ReentryParameters	getReentryParameters(double ae, double f) Convert current orbital parameters into reentry parameters.
double	getRightAscensionOfAscendingNode() Get the right ascension of the ascending node.
StelaEquinoctialParameters	getStelaEquinoctialParameters() Convert current orbital parameters into Stela equinoctial parameters.
double	getTrueAnomaly() Get the true anomaly.
int	hashCode() Get a hashCode for the orbit.
static double	solveKeplerEquationEccentricAnomaly(double meanAnomaly, double eccentricity) Solve the Kepler equation to get the eccentric anomaly : E - e*sin(E)= M
String	toString() Returns a string representation of this keplerian parameters object.

Methods inherited from class fr.cnes.sirius.patrius.orbits.orbitalparameters.AbstractOrbitalParameters

getMu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KeplerianParameters

public KeplerianParameters(double aIn,
                           double eIn,
                           double iIn,
                           double paIn,
                           double raanIn,
                           double anomaly,
                           PositionAngle type,
                           double mu)

Creates a new instance.

Parameters:

aIn - semi-major axis (m), negative for hyperbolic orbits

eIn - eccentricity (e >= 0)

iIn - inclination (rad)

paIn - perigee argument (ω, rad)

raanIn - right ascension of ascending node (Ω, rad)

anomaly - mean, eccentric or true anomaly (rad)

type - type of anomaly

mu - central attraction coefficient (m³/s²)

Throws:

IllegalArgumentException - a and e don't match for hyperbolic orbits, or v is out of range for hyperbolic orbits

Method Detail

getA

public double getA()

Get the semi-major axis.

Returns:

semi-major axis (m)

getE

public double getE()

Get the eccentricity.

Returns:

eccentricity

getI

public double getI()

Get the inclination.

Returns:

inclination (rad)

getPerigeeArgument

public double getPerigeeArgument()

Get the perigee argument.

Returns:

perigee argument (rad)

getRightAscensionOfAscendingNode

public double getRightAscensionOfAscendingNode()

Get the right ascension of the ascending node.

Returns:

right ascension of the ascending node (rad)

getAnomaly

public double getAnomaly(PositionAngle type)

Get the anomaly.

Parameters:

type - type of the angle

Returns:

anomaly (rad)

getTrueAnomaly

public double getTrueAnomaly()

Get the true anomaly.

Returns:

true anomaly (rad)

getEccentricAnomaly

public double getEccentricAnomaly()

Get the eccentric anomaly.

Returns:

eccentric anomaly (rad)

getMeanAnomaly

public double getMeanAnomaly()

Get the mean anomaly.

Returns:

mean anomaly (rad)

solveKeplerEquationEccentricAnomaly

public static double solveKeplerEquationEccentricAnomaly(double meanAnomaly,
                                                         double eccentricity)

Solve the Kepler equation to get the eccentric anomaly : E - e*sin(E)= M

Parameters:

meanAnomaly - the mean anomaly (rad)

eccentricity - the eccentricity of the orbit

Returns:

the eccentric anomaly (rad)

getCartesianParameters

public CartesianParameters getCartesianParameters()

Convert current orbital parameters into cartesian parameters.

Returns:

current orbital parameters converted into cartesian parameters

See Also:

CartesianParameters

getKeplerianParameters

public KeplerianParameters getKeplerianParameters()

Convert current orbital parameters into Keplerian parameters.

Returns:

current orbital parameters converted into Keplerian parameters

See Also:

KeplerianParameters

getCircularParameters

public CircularParameters getCircularParameters()

Convert current orbital parameters into circular parameters.

Returns:

current orbital parameters converted into circular parameters

See Also:

CircularParameters

getEquatorialParameters

public EquatorialParameters getEquatorialParameters()

Convert current orbital parameters into equatorial parameters.

Returns:

current orbital parameters converted into equatorial parameters

See Also:

EquatorialParameters

getEquinoctialParameters

public EquinoctialParameters getEquinoctialParameters()

Convert current orbital parameters into equinoctial parameters.

Returns:

current orbital parameters converted into equinoctial parameters

See Also:

EquinoctialParameters

getApsisAltitudeParameters

public ApsisAltitudeParameters getApsisAltitudeParameters(double ae)

Convert current orbital parameters into apsis (using altitude) parameters.

Parameters:

ae - equatorial radius (m)

Returns:

current orbital parameters converted into apsis (using altitude) parameters

See Also:

ApsisAltitudeParameters

getApsisRadiusParameters

public ApsisRadiusParameters getApsisRadiusParameters()

Convert current orbital parameters into apsis (using radius) parameters.

Returns:

current orbital parameters converted into apsis (using radius) parameters

See Also:

ApsisRadiusParameters

getReentryParameters

public ReentryParameters getReentryParameters(double ae,
                                              double f)

Convert current orbital parameters into reentry parameters.

Parameters:

ae - equatorial radius (m)

f - flattening (f = (a-b)/a)

Returns:

current orbital parameters converted into reentry parameters

See Also:

ReentryParameters

getStelaEquinoctialParameters

public StelaEquinoctialParameters getStelaEquinoctialParameters()

Convert current orbital parameters into Stela equinoctial parameters.

Returns:

current orbital parameters converted into Stela equinoctial parameters

See Also:

StelaEquinoctialParameters

getAlternateEquinoctialParameters

public AlternateEquinoctialParameters getAlternateEquinoctialParameters()

Convert current orbital parameters into alternate equinoctial parameters.

Returns:

current orbital parameters converted into alternate equinoctial parameters

See Also:

AlternateEquinoctialParameters

toString

public String toString()

Returns a string representation of this keplerian parameters object.

Overrides:

toString in class Object

Returns:

a string representation of this object

equals

public boolean equals(Object object)

Test for the equality of two orbits.

Orbits are considered equals if they have the same type and all their attributes are equals. In particular, the orbits frame are considered equals if they represent the same instance. If they have the same attributes but are not the same instance, the method will return false.

Specified by:

equals in interface IOrbitalParameters

Overrides:

equals in class Object

Parameters:

object - Object to test for equality to this

Returns:

true if two orbits are equal

hashCode

public int hashCode()

Get a hashCode for the orbit.

Specified by:

hashCode in interface IOrbitalParameters

Overrides:

hashCode in class Object

Returns:

a hash code value for this object