EquatorialParameters (patrimoine de base SIRIUS 4.17 API)

java.lang.Object
- fr.cnes.sirius.patrius.orbits.orbitalparameters.AbstractOrbitalParameters
- - fr.cnes.sirius.patrius.orbits.orbitalparameters.EquatorialParameters

All Implemented Interfaces:

IOrbitalParameters, Serializable
```
public class EquatorialParameters
extends AbstractOrbitalParameters
```
This class handles non circular equatorial orbital parameters.
The parameters used internally are the following elements:
```
     a semi-major axis (m)
     e eccentricity
     pomega = ω + Ω , longitude of the periapsis;
     ix = 2 sin(i/2) cos(Ω), first component of inclination vector
     iy = 2 sin(i/2) sin(Ω), second component of inclination vector
     anomaly (M or E or v);, mean, eccentric or true anomaly (rad)
 
```
where ω stands for the Periapsis Argument, Ω stands for the Right Ascension of the Ascending Node.

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: EquatorialParameters.java 18071 2017-10-02 16:46:39Z bignon $

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Field Summary
- Fields inherited from class fr.cnes.sirius.patrius.orbits.orbitalparameters.AbstractOrbitalParameters
  mu

Constructor Summary

Constructors
Constructor and Description
`EquatorialParameters(double aIn, double eIn, double pomegaIn, double ixIn, double iyIn, double anomaly, PositionAngle type, double mu)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
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 the current orbital parameters into apsis (using altitude) parameters.
`ApsisRadiusParameters`	`getApsisRadiusParameters()` Convert the current orbital parameters into apsis (using radius) parameters.
`CartesianParameters`	`getCartesianParameters()` Convert the current orbital parameters into cartesian parameters.
`CircularParameters`	`getCircularParameters()` Convert the current orbital parameters into circular parameters.
`double`	`getE()` Get the eccentricity.
`double`	`getEccentricAnomaly()` Get the eccentric anomaly.
`EquatorialParameters`	`getEquatorialParameters()` Convert the current orbital parameters into equatorial parameters.
`EquinoctialParameters`	`getEquinoctialParameters()` Convert the current orbital parameters into equinoctial parameters.
`Pair<Double,PositionAngle>`	`getInitializedAnomaly()` Evaluate which of the three anomaly is initialized ({@code !
`double`	`getIx()` Get the first component of the inclination vector.
`double`	`getIy()` Get the second component of the inclination vector.
`KeplerianParameters`	`getKeplerianParameters()` Convert the current orbital parameters into Keplerian parameters.
`double`	`getMeanAnomaly()` Get the mean anomaly.
`double`	`getPomega()` Get the longitude of the periapsis (ω + Ω).
`ReentryParameters`	`getReentryParameters(double ae, double f)` Convert the current orbital parameters into reentry parameters.
`StelaEquinoctialParameters`	`getStelaEquinoctialParameters()` Convert the current orbital parameters into Stela equinoctial parameters.
`double`	`getTrueAnomaly()` Get the true anomaly.
`int`	`hashCode()` Get a hashCode for the orbit.
`String`	`toString()` Returns a string representation of this non circular equatorial orbital 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
  - EquatorialParameters
```
public EquatorialParameters(double aIn,
                            double eIn,
                            double pomegaIn,
                            double ixIn,
                            double iyIn,
                            double anomaly,
                            PositionAngle type,
                            double mu)
```
    Creates a new instance.
    
    Parameters:
    
    aIn - semi-major axis (m)
    
    eIn - eccentricity
    
    pomegaIn - ω + Ω (rad)
    
    ixIn - 2 sin(i/2) cos(Ω), first component of inclination vector
    
    iyIn - 2 sin(i/2) sin(Ω), second component of inclination vector
    
    anomaly - mean, eccentric or true anomaly (rad)
    
    type - type of anomaly
    
    mu - central attraction coefficient (m³/s²)
    
    Throws:
    
    IllegalArgumentException - if the orbit is hyperbolic (when a < 0)
    if the orbit is neither elliptic with a > 0 and e < 1 nor hyperbolic with a < 0 and e > 1
    if inclination vector is not valid, meaning ix^2 + iy^2 > 4
    if the true anomaly is out of range for hyperbolic orbits
    if the provided anomaly is Double.NaN
- Method Detail
  - getA
```
public double getA()
```
    Get the semi-major axis.
    
    Returns:
    
    the semi-major axis (m)
  - getE
```
public double getE()
```
    Get the eccentricity.
    
    Returns:
    
    the eccentricity
  - getIx
```
public double getIx()
```
    Get the first component of the inclination vector.
    ix = 2 sin(i/2) cos(Ω)
    
    Returns:
    
    the first component of the inclination vector.
  - getIy
```
public double getIy()
```
    Get the second component of the inclination vector.
    iy = 2 sin(i/2) sin(Ω)
    
    Returns:
    
    the second component of the inclination vector.
  - getPomega
```
public double getPomega()
```
    Get the longitude of the periapsis (ω + Ω).
    
    Returns:
    
    the longitude of the periapsis (rad)
  - getAnomaly
```
public double getAnomaly(PositionAngle type)
```
    Get the anomaly.
    
    Parameters:
    
    type - type of the angle
    
    Returns:
    
    the anomaly (rad)
  - getInitializedAnomaly
```
public Pair<Double,PositionAngle> getInitializedAnomaly()
```
    Evaluate which of the three anomaly is initialized (!= Double.NaN), then return it with its associated type.
    The first initialized anomaly is returned, evaluated in this order: true, mean, eccentric.
    
    Returns:
    
    the first initialized anomaly and its type
  - getMeanAnomaly
```
public double getMeanAnomaly()
```
    Get the mean anomaly.
    
    Returns:
    
    the mean anomaly (rad)
  - getEccentricAnomaly
```
public double getEccentricAnomaly()
```
    Get the eccentric anomaly.
    
    Returns:
    
    the eccentric anomaly (rad)
  - getTrueAnomaly
```
public final double getTrueAnomaly()
```
    Get the true anomaly.
    
    Returns:
    
    the true anomaly (rad)
  - getCartesianParameters
```
public CartesianParameters getCartesianParameters()
```
    Convert the current orbital parameters into cartesian parameters.
    
    Returns:
    
    the current orbital parameters converted into cartesian parameters
    
    See Also:
    
    CartesianParameters
  - getKeplerianParameters
```
public KeplerianParameters getKeplerianParameters()
```
    Convert the current orbital parameters into Keplerian parameters.
    
    Returns:
    
    the current orbital parameters converted into Keplerian parameters
    
    See Also:
    
    KeplerianParameters
  - getCircularParameters
```
public CircularParameters getCircularParameters()
```
    Convert the current orbital parameters into circular parameters.
    
    Returns:
    
    the current orbital parameters converted into circular parameters
    
    See Also:
    
    CircularParameters
  - getEquatorialParameters
```
public EquatorialParameters getEquatorialParameters()
```
    Convert the current orbital parameters into equatorial parameters.
    
    Returns:
    
    the current orbital parameters converted into equatorial parameters
    
    See Also:
    
    EquatorialParameters
  - getEquinoctialParameters
```
public EquinoctialParameters getEquinoctialParameters()
```
    Convert the current orbital parameters into equinoctial parameters.
    
    Returns:
    
    the current orbital parameters converted into equinoctial parameters
    
    See Also:
    
    EquinoctialParameters
  - getApsisAltitudeParameters
```
public ApsisAltitudeParameters getApsisAltitudeParameters(double ae)
```
    Convert the current orbital parameters into apsis (using altitude) parameters.
    
    Parameters:
    
    ae - equatorial radius (m)
    
    Returns:
    
    the current orbital parameters converted into apsis (using altitude) parameters
    
    See Also:
    
    ApsisAltitudeParameters
  - getApsisRadiusParameters
```
public ApsisRadiusParameters getApsisRadiusParameters()
```
    Convert the current orbital parameters into apsis (using radius) parameters.
    
    Returns:
    
    the current orbital parameters converted into apsis (using radius) parameters
    
    See Also:
    
    ApsisRadiusParameters
  - getReentryParameters
```
public ReentryParameters getReentryParameters(double ae,
                                              double f)
```
    Convert the current orbital parameters into reentry parameters.
    
    Parameters:
    
    ae - equatorial radius (m)
    
    f - flattening (f = (a-b)/a)
    
    Returns:
    
    the current orbital parameters converted into reentry parameters
    
    See Also:
    
    ReentryParameters
  - getStelaEquinoctialParameters
```
public StelaEquinoctialParameters getStelaEquinoctialParameters()
```
    Convert the current orbital parameters into Stela equinoctial parameters.
    
    Returns:
    
    the 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 non circular equatorial orbital 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

Class EquatorialParameters

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

EquatorialParameters

Method Detail

getA

getE

getIx

getIy

getPomega

getAnomaly

getInitializedAnomaly

getMeanAnomaly

getEccentricAnomaly

getTrueAnomaly

getCartesianParameters

getKeplerianParameters

getCircularParameters

getEquatorialParameters

getEquinoctialParameters

getApsisAltitudeParameters

getApsisRadiusParameters

getReentryParameters

getStelaEquinoctialParameters

getAlternateEquinoctialParameters

toString

equals

hashCode