galpy.orbit.Orbit.jz¶
- Orbit.jz(pot=None, **kwargs)[source]¶
Calculate the vertical action.
- Parameters:
pot (Potential or list of Potential instances, optional) – Gravitational potential. Default is the gravitational field used for the orbit integration.
type ({'staeckel', 'adiabatic', 'isochroneApprox', 'spherical'}, optional) – Type of actionAngle module to use. Default is ‘staeckel’.
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:
Vertical action.
- Return type:
float, numpy.ndarray or Quantity [*input_shape]
Notes
Keyword arguments also include the actionAngle module setup kwargs for the corresponding actionAngle modules
2019-02-27 - Written - Bovy (UofT)
