synthpop.modules.population_density.koshimoto2021_thickdisk
===========================================================

.. py:module:: synthpop.modules.population_density.koshimoto2021_thickdisk

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.koshimoto2021_thickdisk.Koshimoto2021Thickdisk


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

.. py:class:: Koshimoto2021Thickdisk(rho0=(0.0017 + 0.00044) * 10**9, z0=0.903, R0=2.2, Rbreak=5.3, **kwargs)

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


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

   Attributes
   ----------
   R0 : float [kpc]
       disk scale length
   z0 : float [kpc]
       disk scale height
   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:: rho0
      :value: 2140000.0



   .. py:attribute:: z0
      :value: 0.903



   .. py:attribute:: R0
      :value: 2.2



   .. 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.