synthpop.modules.population_density.gums_bar
============================================

.. py:module:: synthpop.modules.population_density.gums_bar

.. autoapi-nested-parse::

   Bar density model from the Gaia Universe Model Snapshot



Classes
-------

.. autoapisummary::

   synthpop.modules.population_density.gums_bar.GumsBar


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

.. py:class:: GumsBar(n0, x0, y0, z0, alpha, beta, gamma, c_perp, c_para, dz_bone=0, x_bone=0, r_max=np.inf, sigma_cut_of=1e-10, **kwargs)

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


   Bar density model from the Gaia Universe Model Snapshot

   Attributes
   ----------
   n0 : float
   x0 : float
   y0 : float
   z0 : float
   sigma_cut_of : float
   c_para : float
   c_perp : float
   dz_bone : float
   x_bone : float
   r_max : float


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



   .. py:attribute:: n0


   .. py:attribute:: x0


   .. py:attribute:: y0


   .. py:attribute:: z0


   .. py:attribute:: sigma_cut_of
      :value: 1e-10



   .. py:attribute:: c_para


   .. py:attribute:: c_perp


   .. py:attribute:: dz_bone
      :value: 0



   .. py:attribute:: x_bone
      :value: 0



   .. py:attribute:: r_max


   .. py:attribute:: rot


   .. 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
      -------
      n : ndarray [#/kpc^3]
          density at the given location in number density.