KeplerianParameters (patrius 4.3 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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, equals, finalize, getClass, hashCode, 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)
  - 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

Class KeplerianParameters

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

KeplerianParameters

Method Detail

getA

getE

getI

getPerigeeArgument

getRightAscensionOfAscendingNode

getAnomaly

getTrueAnomaly

getEccentricAnomaly

getMeanAnomaly

getCartesianParameters

getKeplerianParameters

getCircularParameters

getEquatorialParameters

getEquinoctialParameters

getApsisAltitudeParameters

getApsisRadiusParameters

getReentryParameters

getStelaEquinoctialParameters

getAlternateEquinoctialParameters

toString