synthpop.modules.population_density.koshimoto2021_thindisk
==========================================================

.. py:module:: synthpop.modules.population_density.koshimoto2021_thindisk

.. autoapi-nested-parse::

   Thin disk density profile from Koshimoto et al (2021)



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.koshimoto2021_thindisk.Koshimoto2021Thindisk


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

.. py:class:: Koshimoto2021Thindisk(R0, z0, z45, rho0, Rbreak=5.3, **kwargs)

   Bases: :py:obj:`synthpop.modules.population_density._population_density.PopulationDensity`


   Thin disk density profile from Koshimoto et al. (2021)

   Attributes
   ----------
   R0 : float [kpc]
       disk scale length
   z0 : float [kpc]
       disk scale height at the solar position for linear scale height model
   z45 : float [kpc]
       disk scale height at 4.5 kpc for linear scale height model
   rho0 : float [M_sum/kpc^3]
       mass density at the solar position
   Rbreak : float [kpc]
       distance within which surface density is flat


   .. py:attribute:: density_unit
      :value: 'mass'



   .. py:attribute:: R0


   .. py:attribute:: z0


   .. py:attribute:: z45


   .. py:attribute:: rho0


   .. py:attribute:: Rbreak
      :value: 5.3



   .. py:method:: density(r: numpy.ndarray, phi_rad: numpy.ndarray, z: numpy.ndarray) -> numpy.ndarray

      Estimates the density at the given position

      Parameters
      ----------
      r : ndarray ['kpc']
          Distance to z axis
      phi_rad : ndarray ['rad']
          azimuth angle of the stars. phi_rad = 0 is pointing towards sun.
      z : height above the galactic plane (corrected for warp of the galaxy)

      Returns
      -------
      rho : ndarray [M_sun/kpc^3 or #/kpc^3]
          density at the given location, either in number density evolved
          mass density or initial mass density should be specified in density_unit.