AlternateEquinoctialParameters (patrius 4.6.1 API)

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

All Implemented Interfaces:

IOrbitalParameters, Serializable
```
public class AlternateEquinoctialParameters
extends AbstractOrbitalParameters
```
This class handles alternate equinoctial orbital parameters, which can support both circular and equatorial orbits.
The parameters used internally are the alternate equinoctial elements which can be related to keplerian elements as follows:
```
     n
     ex = e cos(ω + Ω)
     ey = e sin(ω + Ω)
     hx = tan(i/2) cos(Ω)
     hy = tan(i/2) sin(Ω)
     lM = M + ω + Ω
 
```
where ω stands for the Perigee Argument and Ω stands for the Right Ascension of the Ascending Node.

Alternate equinoctial parameters are derived from equinoctial parameter (see EquinoctialParameters for more information) and they are particularly interesting for uncertainty propagation.
Since:

3.0

Version:

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

Author:

Stefano Crepaldi

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors
Constructor and Description
`AlternateEquinoctialParameters(double nIn, double exIn, double eyIn, double hxIn, double hyIn, double l, 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.
`AlternateEquinoctialParameters`	`getAlternateEquinoctialParameters()` Convert current orbital parameters into alternate equinoctial parameters.
`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.
`EquatorialParameters`	`getEquatorialParameters()` Convert current orbital parameters into equatorial parameters.
`double`	`getEquinoctialEx()` Get the first component of the eccentricity vector.
`double`	`getEquinoctialEy()` Get the second component of the eccentricity vector.
`EquinoctialParameters`	`getEquinoctialParameters()` Convert current orbital parameters into equinoctial parameters.
`double`	`getHx()` Get the first component of the inclination vector.
`double`	`getHy()` Get the second component of the inclination vector.
`KeplerianParameters`	`getKeplerianParameters()` Convert current orbital parameters into Keplerian parameters.
`double`	`getL(PositionAngle type)` Get the longitude argument.
`double`	`getLE()` Get the eccentric longitude argument.
`double`	`getLM()` Get the mean longitude argument.
`double`	`getLv()` Get the true longitude argument.
`double`	`getN()` Get the mean motion.
`ReentryParameters`	`getReentryParameters(double ae, double f)` Convert current orbital parameters into reentry parameters.
`StelaEquinoctialParameters`	`getStelaEquinoctialParameters()` Convert current orbital parameters into Stela equinoctial parameters.
`int`	`hashCode()` Get a hashCode for the orbit.
`String`	`toString()` Returns a string representation of this orbit 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
  - AlternateEquinoctialParameters
```
public AlternateEquinoctialParameters(double nIn,
                                      double exIn,
                                      double eyIn,
                                      double hxIn,
                                      double hyIn,
                                      double l,
                                      PositionAngle type,
                                      double mu)
```
    Creates a new instance.
    
    Parameters:
    
    nIn - mean motion (1/s)
    
    exIn - e cos(ω + Ω), first component of eccentricity vector
    
    eyIn - e sin(ω + Ω), second component of eccentricity vector
    
    hxIn - tan(i/2) cos(Ω), first component of inclination vector
    
    hyIn - tan(i/2) sin(Ω), second component of inclination vector
    
    l - (M or E or v) + ω + Ω, mean, eccentric or true longitude argument (rad)
    
    type - type of longitude argument
    
    mu - central attraction coefficient (m³/s²)
    
    Throws:
    
    IllegalArgumentException - if eccentricity is equal to 1 or larger
- Method Detail
  - getN
```
public double getN()
```
    Get the mean motion.
    
    Returns:
    
    mean motion (1/s)
  - getEquinoctialEx
```
public double getEquinoctialEx()
```
    Get the first component of the eccentricity vector.
    
    Returns:
    
    e cos(ω + Ω), first component of the eccentricity vector
  - getEquinoctialEy
```
public double getEquinoctialEy()
```
    Get the second component of the eccentricity vector.
    
    Returns:
    
    e sin(ω + Ω), second component of the eccentricity vector
  - getHx
```
public double getHx()
```
    Get the first component of the inclination vector.
    
    Returns:
    
    tan(i/2) cos(Ω), first component of the inclination vector
  - getHy
```
public double getHy()
```
    Get the second component of the inclination vector.
    
    Returns:
    
    tan(i/2) sin(Ω), second component of the inclination vector
  - getL
```
public double getL(PositionAngle type)
```
    Get the longitude argument.
    
    Parameters:
    
    type - type of the angle
    
    Returns:
    
    longitude argument (rad)
  - getLM
```
public double getLM()
```
    Get the mean longitude argument.
    
    Returns:
    
    M + ω + Ω true longitude argument (rad)
  - getLv
```
public double getLv()
```
    Get the true longitude argument.
    
    Returns:
    
    v + ω + Ω true longitude argument (rad)
  - getLE
```
public double getLE()
```
    Get the eccentric longitude argument.
    
    Returns:
    
    E + ω + Ω eccentric longitude argument (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
  - getAlternateEquinoctialParameters
```
public AlternateEquinoctialParameters getAlternateEquinoctialParameters()
```
    Convert current orbital parameters into alternate equinoctial parameters.
    
    Returns:
    
    current orbital parameters converted into alternate equinoctial parameters
    
    See Also:
    
    AlternateEquinoctialParameters
  - 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
  - toString
```
public String toString()
```
    Returns a string representation of this orbit 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 AlternateEquinoctialParameters

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

AlternateEquinoctialParameters

Method Detail

getN

getEquinoctialEx

getEquinoctialEy

getHx

getHy

getL

getLM

getLv

getLE

getCartesianParameters

getKeplerianParameters

getCircularParameters

getEquatorialParameters

getAlternateEquinoctialParameters

getEquinoctialParameters

getApsisAltitudeParameters

getApsisRadiusParameters

getReentryParameters

getStelaEquinoctialParameters

toString

equals

hashCode