synthpop.modules.population_density.besancon2003_thindisk
=========================================================

.. py:module:: synthpop.modules.population_density.besancon2003_thindisk

.. autoapi-nested-parse::

   Einasto density profiles, used e.g. for the thin disk in the
   Besancon Model (Robin et al., 2003).



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.besancon2003_thindisk.Besancon2003Thindisk


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

.. py:class:: Besancon2003Thindisk(e, p0, hrp, hrm, offset=0, power=1, disk_cutoff=14, flare_flag=True, **kwargs)

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


   Einasto profile

   Attributes
   ----------
   e : float
       disc axis ratio
   p0 : float [Msun/kpc**3]
       density at the position of sun
   hrp : float [kpc]
       scale radius of the positive Gaussian
   hrm : float [kpc]
       hrm is the scale radius of the disk hole
   offset : float
       modification of the exponent
   power :  float
       modification of the exponent
       for the Besancon thin disk:
       offset = 0; power = 2 for age<=0.15 Gyr
       offset = 0.5; power = 1 for age> 0.15 Gyr
   disk_cutoff : float [kpc]
       outer edge of the disc
   flare_flag : bool
       include flare


   .. py:attribute:: population_density_name
      :value: 'Besancon2003Thindisk'



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



   .. py:attribute:: disk_cutoff
      :value: 14



   .. py:attribute:: p0


   .. py:attribute:: e


   .. py:attribute:: hrp


   .. py:attribute:: hrm


   .. py:attribute:: offset
      :value: 0



   .. py:attribute:: power
      :value: 1



   .. py:attribute:: flare_flag
      :value: True



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