synthpop.modules.extinction.lallement
=====================================

.. py:module:: synthpop.modules.extinction.lallement

.. autoapi-nested-parse::

   Extinction map from Lallement et al 2019, for dust within 3 kpc based on
   Gaia & 2MASS observations.

   Extinction is given as 'A0', or total extinction at reference wavelength 5500 Angstroms.

   The user may determine whether to integrate over the map individually for each star, or to
   integrate for the average sightline and interpolate for distances. The user can also adjust
   the dr used for extinction integration.

   Publication DOI: 10.1051/0004-6361/201834695

   Data file FTP: https://cdsarc.cds.unistra.fr/ftp/J/A+A/625/A135/



Classes
-------

.. autoapisummary::

   synthpop.modules.extinction.lallement.Lallement


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

.. py:class:: Lallement(dr=0.001, per_sightline=True, **kwargs)

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


   Extinction map from Lallement et al. 2019

   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
   -------
   lallement_ext_func(l_deg, b_deg, dist):
       get extinction value in map for list of star locations
   extinction_in_map(l_deg, b_deg, dist):
       equivalent to lallement_ext_func


   .. py:attribute:: extinction_map_name
      :value: 'Lallement'



   .. py:attribute:: ref_wavelength
      :value: 0.55



   .. py:attribute:: A_or_E_type
      :value: 'A0'



   .. py:attribute:: per_sightline
      :value: True



   .. py:attribute:: dr
      :value: 0.001



   .. py:attribute:: grid_dr
      :value: 0.005



   .. py:attribute:: grid_x_mid
      :value: 600



   .. py:attribute:: grid_y_mid
      :value: 600



   .. py:attribute:: grid_z_mid
      :value: 80



   .. py:attribute:: x_extent
      :value: 3.0



   .. py:attribute:: y_extent
      :value: 3.0



   .. py:attribute:: z_extent
      :value: 0.4



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

      Get extinction value from Lallement et al. (2019) map
      for an array 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



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