.. include:: ../dynamics/references.txt

Orbit
=====

.. currentmodule:: gala.dynamics

.. autoclass:: Orbit
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Orbit.data
      ~Orbit.hamiltonian
      ~Orbit.norbits
      ~Orbit.ntimes
      ~Orbit.pos_components
      ~Orbit.representation_mappings
      ~Orbit.shape
      ~Orbit.vel_components

   .. rubric:: Methods Summary

   .. autosummary::

      ~Orbit.align_circulation_with_z
      ~Orbit.angular_momentum
      ~Orbit.animate
      ~Orbit.apocenter
      ~Orbit.circulation
      ~Orbit.eccentricity
      ~Orbit.energy
      ~Orbit.estimate_period
      ~Orbit.from_galpy_orbit
      ~Orbit.from_hdf5
      ~Orbit.from_w
      ~Orbit.get_components
      ~Orbit.guiding_radius
      ~Orbit.kinetic_energy
      ~Orbit.orbit_gen
      ~Orbit.pericenter
      ~Orbit.plot
      ~Orbit.plot_3d
      ~Orbit.potential_energy
      ~Orbit.represent_as
      ~Orbit.reshape
      ~Orbit.to_coord_frame
      ~Orbit.to_frame
      ~Orbit.to_galpy_orbit
      ~Orbit.to_hdf5
      ~Orbit.w
      ~Orbit.zmax

   .. rubric:: Attributes Documentation

   .. autoattribute:: data
   .. autoattribute:: hamiltonian
   .. autoattribute:: norbits
   .. autoattribute:: ntimes
   .. autoattribute:: pos_components
   .. autoattribute:: representation_mappings
   .. autoattribute:: shape
   .. autoattribute:: vel_components

   .. rubric:: Methods Documentation

   .. automethod:: align_circulation_with_z
   .. automethod:: angular_momentum
   .. automethod:: animate
   .. automethod:: apocenter
   .. automethod:: circulation
   .. automethod:: eccentricity
   .. automethod:: energy
   .. automethod:: estimate_period
   .. automethod:: from_galpy_orbit
   .. automethod:: from_hdf5
   .. automethod:: from_w
   .. automethod:: get_components
   .. automethod:: guiding_radius
   .. automethod:: kinetic_energy
   .. automethod:: orbit_gen
   .. automethod:: pericenter
   .. automethod:: plot
   .. automethod:: plot_3d
   .. automethod:: potential_energy
   .. automethod:: represent_as
   .. automethod:: reshape
   .. automethod:: to_coord_frame
   .. automethod:: to_frame
   .. automethod:: to_galpy_orbit
   .. automethod:: to_hdf5
   .. automethod:: w
   .. automethod:: zmax