synthpop.modules.extinction.surot
=================================

.. py:module:: synthpop.modules.extinction.surot

.. autoapi-nested-parse::

   Extinction map from Surot et al 2020. This is a 2-d map which may be used
   as a screen at some distance, or projected into 3-d following the scheme used
   in Galaxia (see galaxia_3d module / Sharma et al. 2011).

   Extinction is provided as total extinction A_Ks at 2.15 microns

   Publication DOI: 10.1051/0004-6361/202038346

   Data file FTP: https://cdsarc.cds.unistra.fr/ftp/J/A+A/644/A140/ejkmap.dat.gz



Classes
-------

.. autoapisummary::

   synthpop.modules.extinction.surot.Surot


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

.. py:class:: Surot(project_3d=True, dist_2d=8.15, **kwargs)

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


   Extinction map from Surot et al. 2020
   On first use, the map is downloaded and converted from E(J-Ks) to A_Ks values

   Attributes
   ----------
   project_3d=True : boolean
       whether to project the map into 3-d or keep as 2-d
   dist_2d=8.15 : float
       for 3-d: distance where the map value is the true extinction value;
       for 2-d: distance where extinction is applied as a screen

   Methods
   -------
   extinction_in_map(l_deg, b_deg, dist):
       equivalent to lallement_ext_func


   .. py:attribute:: extinction_map_name
      :value: 'Surot'



   .. py:attribute:: ref_wavelength
      :value: 2.152152



   .. py:attribute:: A_or_E_type
      :value: 'A_Ks'



   .. py:attribute:: project_3d
      :value: True



   .. py:attribute:: dist_2d
      :value: 8.15



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