galpy.orbit.Orbit.Jacobi¶

Orbit.Jacobi(*args, **kwargs)[source]¶

Calculate the Jacobi integral E - Omega L.

Parameters:

t (numeric, numpy.ndarray or Quantity, optional) – Time at which to get the Jacobi integral. Default is the initial time.
OmegaP (numeric or Quantity, optional) – Pattern speed.
pot (Potential, DissipativeForce or list of such instances) – Gravity potential to use for the calculation (DissipativeForce instances are ignored). Default is the gravitational field used to integrate the orbit.
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:

Jacobi integral.

Return type:

float, numpy.ndarray or Quantity [*input_shape,nt]

Notes