Orbit.zmax(analytic=False, pot=None, **kwargs)[source]

Calculate the maximum vertical height, either numerically from the numerical orbit integration or using analytical means.

  • analytic (bool, optional) – Compute this analytically. Default is False.

  • pot (Potential or list of Potential instances, optional) – Gravitational potential for the analytical calculation. Default is the gravitational field used for the orbit integration.

  • type ({'staeckel', 'adiabatic', 'spherical'}, optional) – Type of actionAngle module to use for 3D orbits when analytic=True. Default is ‘staeckel’.

  • ro (float or Quantity, optional) – Physical scale in kpc for distances 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.


Maximum vertical height.

Return type:

float, numpy.ndarray or Quantity [*input_shape]


  • Keyword arguments also include the actionAngle module setup kwargs for the corresponding actionAngle modules

  • 2019-02-25 - Written - Bovy (UofT)