synthpop.modules.extinction.gums
================================

.. py:module:: synthpop.modules.extinction.gums

.. autoapi-nested-parse::

   Extinction map used in the GAIA Universe Model, DR3 version, which
   combines Lallement et al (2019) & Marshall (2006)

   Extinction is returned as A0, total extinction at reference wavelength 5500 Angstroms

   GUMS documentation: https://gea.esac.esa.int/archive/documentation/GDR3/Data_processing/chap_cu2sim/sec_cu2UM/ssec_cu2extmodel.html



Classes
-------

.. autoapisummary::

   synthpop.modules.extinction.gums.Gums


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

.. py:class:: Gums(dr=0.001, **kwargs)

   Bases: :py:obj:`synthpop.modules.extinction.lallement.Lallement`, :py:obj:`synthpop.modules.extinction._extinction.ExtinctionMap`


   Extinction map from Gaia Universe Model Snapshot

   Attributes
   ----------
   dr=0.001 : float
       step size for extinction integration in kpc
   per_sightline=True : boolean
       calculate extinction integral once per sightline if True (faster)
       calculate extinciton integral individually per star if False (slower)

   Methods
   -------
   gums_ext_func(l_deg, b_deg, dist):
       get extinction value in combo Lallement/Marshall combo map for list of star locations
   extinction_in_map(l_deg, b_deg, dist):
       equivalent to gums_ext_func


   .. py:attribute:: extinction_map_name
      :value: 'GUMS'



   .. py:attribute:: marshall_query


   .. py:method:: gums_ext_func(l_deg, b_deg, dist)

      Estimates the extinction for a list of star positions.

      Parameters
      ----------
      l_deg: ndarray [degrees]
          galactic longitude
      b_deg: ndarray [degrees]
          galactic latitude
      dist: ndarray [kpc]
          radial distance from the Sun

      Returns
      -------
      extinction_value: ndarray [mag]
          extinction at each star position



   .. py:method:: extinction_in_map(l_deg, b_deg, dist)

      Estimates the extinction for a list of star positions.

      Parameters
      ----------
      l_deg: ndarray [degrees]
          galactic longitude
      b_deg: ndarray [degrees]
          galactic latitude
      dist: ndarray [kpc]
          radial distance from the Sun

      Returns
      -------
      extinction_value: ndarray [mag]
          extinction at each star position