synthpop.modules.population_density.besancon2003_thickdisk
==========================================================

.. py:module:: synthpop.modules.population_density.besancon2003_thickdisk

.. autoapi-nested-parse::

   Thick disk density from the Besancon model (Robin et al., 2003)



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.besancon2003_thickdisk.Besancon2003Thickdisk


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

.. py:class:: Besancon2003Thickdisk(rho0, hr, hz, xl, flare_flag=False, **kwargs)

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


   Besancon Model (Robin et al., 2003) thick disk

   Attributes
   ----------
   rho0 : float [Msun/kpc**3]
       density at the location of the sun
   hr : float [kpc]
       scale height in radii
   hz  : float [kpc]
           scale height in height
   xl : float
       transit point
   flare_flag: boolean
       flag if flare is included or not


   .. py:attribute:: population_density_name
      :value: 'ThickDisk'



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



   .. py:attribute:: rho0


   .. py:attribute:: xl


   .. py:attribute:: hr


   .. py:attribute:: hz


   .. py:attribute:: flare_flag
      :value: False



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