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

CartesianOrbit
==============

.. currentmodule:: gala.dynamics

.. autoclass:: CartesianOrbit
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

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

   .. rubric:: Methods Summary

   .. autosummary::

      ~CartesianOrbit.align_circulation_with_z
      ~CartesianOrbit.angular_momentum
      ~CartesianOrbit.apocenter
      ~CartesianOrbit.circulation
      ~CartesianOrbit.eccentricity
      ~CartesianOrbit.energy
      ~CartesianOrbit.estimate_period
      ~CartesianOrbit.from_hdf5
      ~CartesianOrbit.from_w
      ~CartesianOrbit.get_components
      ~CartesianOrbit.kinetic_energy
      ~CartesianOrbit.orbit_gen
      ~CartesianOrbit.pericenter
      ~CartesianOrbit.plot
      ~CartesianOrbit.potential_energy
      ~CartesianOrbit.represent_as
      ~CartesianOrbit.to_coord_frame
      ~CartesianOrbit.to_frame
      ~CartesianOrbit.to_hdf5
      ~CartesianOrbit.w
      ~CartesianOrbit.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:: apocenter
   .. automethod:: circulation
   .. automethod:: eccentricity
   .. automethod:: energy
   .. automethod:: estimate_period
   .. automethod:: from_hdf5
   .. automethod:: from_w
   .. automethod:: get_components
   .. automethod:: kinetic_energy
   .. automethod:: orbit_gen
   .. automethod:: pericenter
   .. automethod:: plot
   .. automethod:: potential_energy
   .. automethod:: represent_as
   .. automethod:: to_coord_frame
   .. automethod:: to_frame
   .. automethod:: to_hdf5
   .. automethod:: w
   .. automethod:: zmax