synthpop.modules.population_density.gums_thickdisk
==================================================

.. py:module:: synthpop.modules.population_density.gums_thickdisk

.. autoapi-nested-parse::

   Thick Disk density model from the Gaia Unvierse Model Snapshot



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.gums_thickdisk.GumsThickdisk


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

.. py:class:: GumsThickdisk(rho0, hr, hz, flare_flag=True, **kwargs)

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


   Thick Disk density model from the Gaia Unvierse Model Snapshot

   Attributes
   ----------
   rho0 : float
   hz : float
   hr : float
   flare_flag : boolean


   .. py:attribute:: name
      :value: 'GumsThickdisk'



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



   .. py:attribute:: rho0


   .. py:attribute:: hz


   .. py:attribute:: hr


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