synthpop.modules.kinematics.koshimoto2021_disk
==============================================

.. py:module:: synthpop.modules.kinematics.koshimoto2021_disk

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   synthpop.modules.kinematics.koshimoto2021_disk.Koshimoto2021Disk


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

.. py:class:: Koshimoto2021Disk(sigma_r_sun, sigma_z_sun, beta_r, beta_z, R_sigma_r, R_sigma_z, pop_age, **kwargs)

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


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


   .. py:attribute:: kinematics_func_name
      :value: 'Koshimoto2021Disk'



   .. py:attribute:: sigma_r_sun


   .. py:attribute:: sigma_z_sun


   .. py:attribute:: beta_r


   .. py:attribute:: beta_z


   .. py:attribute:: R_sigma_r


   .. py:attribute:: R_sigma_z


   .. py:attribute:: pop_age


   .. py:attribute:: rot_curve


   .. py:method:: draw_random_velocity(x: np.ndarray or float, y: np.ndarray or float, z: np.ndarray or float, **kwargs) -> Tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray]

      Generate a random velocities u,v,w  by using a velocity dispersion

      Parameters
      ----------
      x, y, z : nparray, float [kpc]
          galactocentric coordinates

      Returns
      -------
      u, v, w : ndarray [km/s]
          velocity in galactocentric x,y,and z direction.