galpy.orbit.Orbit.rguiding¶
- Orbit.rguiding(*args, **kwargs)[source]¶
Calculate the guiding-center radius (the radius of a circular orbit with the same angular momentum).
- Parameters:
pot (Potential or list of Potential instances, optional) – Gravitational potential. Default is the gravitational field used for the orbit integration.
ro (float or Quantity, optional) – Physical scale in kpc for distances to use to convert. Default is object-wide default.
vo (float or Quantity, optional) – Physical scale in km/s for velocities to use to convert. Default is object-wide default.
use_physical (bool, optional) – Use to override object-wide default for using a physical scale for output.
quantity (bool, optional) – If True, return an Astropy Quantity object. Default from configuration file.
- Returns:
Guiding-center radius of the orbit.
- Return type:
float, numpy.ndarray or Quantity [*input_shape,nt]
Notes
2019-03-02 - Written as thin wrapper around Potential.rl - Bovy (UofT)
See also