synthpop.modules.population_density.koshimoto2021_bulge_b
=========================================================

.. py:module:: synthpop.modules.population_density.koshimoto2021_bulge_b

.. autoapi-nested-parse::

   Bulge density profile from from unpublished work related to Koshimoto et al 2021



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.koshimoto2021_bulge_b.Koshimoto2021BulgeB


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

.. py:class:: Koshimoto2021BulgeB(x0=0.849918751795326, y0=0.339420928043361, z0=0.286256780667543, n0=7530340000.0, C_perp=1.28032639342739, C_par=3.24013809549932, bar_angle=27, **kwargs)

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


   Bessell function bulge density distributions from Koshimoto for
   (private communication, unpublished work related to Koshimoto+21)

   Attributes
   ----------
   x0 : float
   y0 : float
   z0 : float
   C_par : float
   C_perp : float
   bar_ang : float


   .. py:attribute:: x0
      :value: 0.849918751795326



   .. py:attribute:: y0
      :value: 0.339420928043361



   .. py:attribute:: z0
      :value: 0.286256780667543



   .. py:attribute:: n0
      :value: 7530340000.0



   .. py:attribute:: C_par
      :value: 3.24013809549932



   .. py:attribute:: C_perp
      :value: 1.28032639342739



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



   .. py:attribute:: bar_ang


   .. py:method:: density(r, theta, z)

      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.