galpy.orbit.Orbit.vr¶
- Orbit.vr(*args, **kwargs)[source]¶
Return spherical radial velocity. For < 3 dimensions returns vR.
- Parameters:
t (numeric, numpy.ndarray or Quantity, optional) – Time at which to get the radial velocity. Default is the initial time.
vo (float or Quantity, optional) – Physical scale for velocities in km/s 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:
Radial velocity.
- Return type:
float, numpy.ndarray or Quantity [*input_shape,nt]
Notes
2020-07-01: Written by James Lane (UofT).