synthpop.modules.kinematics.koshimoto2021_bulge
===============================================

.. py:module:: synthpop.modules.kinematics.koshimoto2021_bulge

.. autoapi-nested-parse::

   Kinematic module for the based on the Koshimoto et al (2021) bulge kinematic model



Classes
-------

.. autoapisummary::

   synthpop.modules.kinematics.koshimoto2021_bulge.Koshimoto2021Bulge


Module Contents
---------------

.. py:class:: Koshimoto2021Bulge(v0_stream, y0_stream, C_par_r, C_perp_r, C_par_z, C_perp_z, h0_r, h0_z, sigma_i0, sigma_i1, omega_p, bar_angle=27, **kwargs)

   Bases: :py:obj:`synthpop.modules.kinematics._kinematics.Kinematics`


   Kinematic module for the bulge based on Koshimoto et al. (2021)


   .. py:attribute:: v0_stream


   .. py:attribute:: y0_stream


   .. py:attribute:: C_par_r


   .. py:attribute:: C_perp_r


   .. py:attribute:: C_par_z


   .. py:attribute:: C_perp_z


   .. py:attribute:: h0_r


   .. py:attribute:: h0_z


   .. py:attribute:: sigma_i0


   .. py:attribute:: sigma_i1


   .. py:attribute:: omega_p


   .. py:attribute:: bar_ang


   .. py:method:: vel_disp(xp, yp, zp, i)


   .. py:method:: draw_random_velocity(x, y, z, **kwargs)

      Generate a random u,v,w velocity vector given galactic x,y,z coordinates

      Parameters
      ----------
      x : float [kpc]
      y : float [kpc]
      z : float [kpc]

      Returns
      -------
      u : float [km/s]
      v : float [km/s]
      w : float [km/s]



   .. py:method:: mean_galactic_uvw(x, y, z, **kwargs)

      Generate a random u,v,w velocity vector given galactic x,y,z coordinates

      Parameters
      ----------
      x : float [kpc]
      y : float [kpc]
      z : float [kpc]

      Returns
      -------
      u : float [km/s]
      v : float [km/s]
      w : float [km/s]