Skip to main content

Uniform interface for multiple dust reddening maps.

Project description

The dustmaps package provides a uniform interface for dealing with a number of 2D and 3D maps of interstellar dust reddening/extinction.

Supported Dust Maps

The currently supported dust maps are:

  1. Burstein & Heiles (1982; BH’82)

  2. Chen et al. (2014)

  3. Green, Schlafly, Finbeiner et al. (2015,2018; Bayestar)

  4. Marshall et al. (2006)

  5. Planck Collaboration (2013)

  6. Sale et al. (2014; IPHAS)

  7. Schlegel, Finkbeiner & Davis (1998; SFD’98)

  8. Lenz, Hensley & Doré (2017)

To request addition of another dust map in this package, [file an issue on GitHub](https://github.com/gregreen/dustmaps/issues), or submit a pull request.

Installation

Download the repository from [GitHub](https://github.com/gregreen/dustmaps) and then run:

python setup.py install –large-data-dir=/path/where/you/want/large/data/files/stored

Alternatively, you can use the Python package manager pip:

pip install dustmaps

Getting the Data

To fetch the data for the SFD dust map, run:

python setup.py fetch –map-name=sfd

You can download the other dust maps by changing “sfd” to “planck”, “bayestar”, “iphas”, “marshall”, “chen2014”, “lenz2017” or “bh”.

Alternatively, if you have used pip to install dustmaps, then you can configure the data directory and download the data by opening up a python interpreter and running:

>>> from dustmaps.config import config
>>> config['data_dir'] = '/path/where/you/want/large/data/files/stored'
>>>
>>> import dustmaps.sfd
>>> dustmaps.sfd.fetch()
>>>
>>> import dustmaps.planck
>>> dustmaps.planck.fetch()
>>>
>>> import dustmaps.bayestar
>>> dustmaps.bayestar.fetch()
>>>
>>> import dustmaps.iphas
>>> dustmaps.iphas.fetch()
>>>
>>> import dustmaps.marshall
>>> dustmaps.marshall.fetch()
>>>
>>> import dustmaps.chen2014
>>> dustmaps.chen2014.fetch()
>>>
>>> import dustmaps.lenz2017
>>> dustmaps.lenz2017.fetch()

Querying the Maps

Maps are queried using [astropy.coordinates.SkyCoord](http://docs.astropy.org/en/stable/api/astropy.coordinates.SkyCoord.html#astropy.coordinates.SkyCoord) objects. This means that any coordinate system supported by astropy can be used as input. For example, we can query SFD’98 as follows:

>>> from dustmaps.sfd import SFDQuery
>>> from astropy.coordinates import SkyCoord
>>>
>>> sfd = SFDQuery()
>>>
>>> c = SkyCoord(
        '05h00m00.00000s',
        '+30d00m00.0000s',
        frame='icrs')
>>> print sfd(c)
0.483961

Above, we have used the ICRS coordinate system (the inputs are RA and Dec). We can use other coordinate systems, such as Galactic coordinates, and we can provide coordinate arrays. The following example uses both features:

>>> c = SkyCoord(
        [75.00000000, 130.00000000],
        [-89.00000000, 10.00000000],
        frame='galactic',
        unit='deg')
>>> print sfd(c)
[ 0.0146584   0.97695869]

Documentation

Read the full documentation at http://dustmaps.readthedocs.io/en/latest/.

Development

Development of dustmaps takes place on GitHub, at https://github.com/gregreen/dustmaps. Any bugs, feature requests, pull requests, or other issues can be filed there. Contributions to the software are welcome.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dustmaps-1.0.tar.gz (421.3 kB view details)

Uploaded Source

File details

Details for the file dustmaps-1.0.tar.gz.

File metadata

  • Download URL: dustmaps-1.0.tar.gz
  • Upload date:
  • Size: 421.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for dustmaps-1.0.tar.gz
Algorithm Hash digest
SHA256 f9099f12b84aa28959b171ea9057f178511595c50db9e3b1775e1fb924910108
MD5 cc9cd7884a018716a04d78409718bc1f
BLAKE2b-256 e1a716ac1cba3cb7f4c4d889098b684e40c1d7259918fdfcd374c5daa15ff554

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page