synthpop.modules.extinction.maps_from_dustmaps
==============================================

.. py:module:: synthpop.modules.extinction.maps_from_dustmaps

.. autoapi-nested-parse::

   Extinction maps collected from the dustmap module (Green, 2018)

   Extinction form (i.e. reference wavelength / color excess) depends on
   map used.

   Publication DOI: 10.21105/joss.00695

   Before using this module you need to fatch the data once.
   See https://dustmaps.readthedocs.io/en/latest/installation.html



Classes
-------

.. autoapisummary::

   synthpop.modules.extinction.maps_from_dustmaps.MapsFromDustmaps


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

.. py:class:: MapsFromDustmaps(dustmap_name=None, dist_2d=0.0, **kwargs)

   Bases: :py:obj:`synthpop.modules.extinction._extinction.ExtinctionMap`


   Extinction maps from dustmaps

   Attributes
   ----------
   dustmap_name : string
       name of the map from dustmaps to use.
       options are "bayestar", "bh", "chen2014", "csfd", "decaps",
       "gaia_tge", "iphas", "leike_ensslin_2019", "leike_2020",
       "edenhofer2023", "lenz2017", "marshall", "pg2010",
       "planck_gnlc", "planck", "sfd"
   dist_2d=0.0 : float
       if a 2-d map is applied, this sets the distance [kpc] where
       the extinction is applied as a single infinitely thin screen

   Methods
   -------
   extinction_in_map(l_deg, b_deg, dist):
       estimates extinction for a list of star positions


   .. py:attribute:: extinction_map_name
      :value: 'dustmaps.None'



   .. py:attribute:: is_3D


   .. py:attribute:: kwargs


   .. py:attribute:: query


   .. py:attribute:: ref_wavelength


   .. py:attribute:: A_or_E_type


   .. py:attribute:: bands
      :value: []



   .. py:attribute:: eff_wavelengths


   .. 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 defined as self.A_or_E_type