galpy.orbit.Orbit.z

Orbit.z(*args, **kwargs)[source]

Return vertical height.

Parameters:
  • t (numeric, numpy.ndarray or Quantity, optional) – Time at which to get the vertical height. Default is the initial time.

  • 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.

Returns:

Vertical height.

Return type:

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

Notes

  • 2019-02-20: Written by Bovy (UofT).