synthpop.modules.population_density.gums_halo
=============================================

.. py:module:: synthpop.modules.population_density.gums_halo

.. autoapi-nested-parse::

   Spheroidal density distribution, used for the Halo in the Gaia Universe Model Snapshot
   and other models.



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.gums_halo.GumsHalo


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

.. py:class:: GumsHalo(rho0, e=0.774, rc=2.175827881, ah=1, dh=2.777231, **kwargs)

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


   This is the Parent Class for population densities functions

   Attributes
   ----------
   population_density_name : str
       name of the population density
   density_unit : str
       specifier if density profile returns "number"-, "mass"- or "init_mass"-density
   (more attributes are specified in the subclasses)

   Methods
   -------
   __init__() :
       Initialize the PopulationDensity class
   density(r: ndarray, theta, ndarray, z: ndarray) : ndarray
       estimate the density at (r,theta,z)
       (specified in the subclasses)


   .. py:attribute:: population_density_name
      :value: 'GumsHalo'



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



   .. py:attribute:: rho0


   .. py:attribute:: e
      :value: 0.774



   .. py:attribute:: rc
      :value: 2.175827881



   .. py:attribute:: ah
      :value: 1



   .. py:attribute:: dh
      :value: 2.777231



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