galpy.orbit.Orbit.e¶
- Orbit.e(analytic=False, pot=None, **kwargs)[source]¶
Calculate the eccentricity, either numerically from the numerical orbit integration or using analytical means.
- Parameters:
analytic (bool, optional) – If True, compute this analytically. Default is False.
pot (Potential or list of Potential instances, optional) – Gravitational potential to use for analytical calculation. Default is the gravitational field used for the orbit integration.
type ({'staeckel', 'adiabatic', 'spherical'}, optional) – Type of actionAngle module to use when analytic=True. Default is ‘staeckel’.
- Returns:
Eccentricity of the orbit.
- Return type:
float or numpy.ndarray [*input_shape]
Notes
Keyword arguments also include the actionAngle module setup kwargs for the corresponding actionAngle modules
2019-02-25 - Written - Bovy (UofT)
