synthpop.modules.population_density.besancon2003_bulge
======================================================

.. py:module:: synthpop.modules.population_density.besancon2003_bulge

.. autoapi-nested-parse::

   Density Subclass to describe the bulge density
   from the Besancon model (Robin et al., 2003)



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.besancon2003_bulge.Besancon2003Bulge


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

.. py:class:: Besancon2003Bulge(x0=1.59, y0=0.424, z0=0.424, Rc=2.54, n0=13700000000.0, bar_angle=11.1, **kwargs)

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


   Besancon model (Robin et al. 2003) bulge density

   Attributes
   ----------
   x0, y0, z0 : float [kpc]
       semi major axis of the bulge
   Rc  : float [kpc]
       critical Radius
   n0 : float [stars/kpc^3]
       central number density
   bar_angle : float [°]
       angle of the bar,


   .. py:attribute:: population_density_name
      :value: 'Besancon2003Bulge'



   .. py:attribute:: density_unit
      :value: 'number'



   .. py:attribute:: x0
      :value: 1.59



   .. py:attribute:: y0
      :value: 0.424



   .. py:attribute:: z0
      :value: 0.424



   .. py:attribute:: Rc
      :value: 2.54



   .. py:attribute:: n0
      :value: 13700000000.0



   .. py:attribute:: bar_ang


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