/usr/lib/python3/dist-packages/photutils/datasets/load.py is in python3-photutils 0.3-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | # Licensed under a 3-clause BSD style license - see LICENSE.rst
"""
Load example datasets.
"""
from __future__ import (absolute_import, division, print_function,
unicode_literals)
from astropy.io import fits
from astropy.table import Table
from astropy.utils.data import get_pkg_data_filename, download_file
__all__ = ['get_path', 'load_spitzer_image', 'load_spitzer_catalog',
'load_irac_psf', 'load_fermi_image', 'load_star_image']
def get_path(filename, location='local', cache=False):
"""Get path (location on your disk) for a given file.
Parameters
----------
filename : str
File name in the local or remote data folder
location : {'local', 'remote'}
File location.
``'local'`` means bundled with ``photutils``.
``'remote'`` means a server or the Astropy cache on your machine.
cache : bool, optional
Whether to cache the contents of remote URLs. Default is
currently `False` because `True` will fail with Python 3.
Returns
-------
path : str
Path (location on your disk) of the file.
Examples
--------
>>> from astropy.io import fits
>>> from photutils import datasets
>>> hdu_list = fits.open(datasets.get_path('fermi_counts.fits.gz'))
"""
if location == 'local':
path = get_pkg_data_filename('data/' + filename)
elif location == 'remote': # pragma: no cover
url = ('https://github.com/astropy/photutils-datasets/blob/master/'
'data/{0}?raw=true'.format(filename))
path = download_file(url, cache=cache)
else:
raise ValueError('Invalid location: {0}'.format(location))
return path
def load_spitzer_image(): # pragma: no cover
"""
Load 4.5 micron Spitzer image.
Returns
-------
hdu : `~astropy.io.fits.ImageHDU`
The 4.5 micron image
Examples
--------
.. plot::
:include-source:
from photutils import datasets
hdu = datasets.load_spitzer_image()
plt.imshow(hdu.data, origin='lower', vmax=50)
"""
path = get_path('spitzer_example_image.fits', location='remote')
hdu = fits.open(path)[0]
return hdu
def load_spitzer_catalog(): # pragma: no cover
"""
Load 4.5 micron Spitzer catalog.
This is the catalog corresponding to the image returned by
`~photutils.datasets.load_spitzer_image`.
Returns
-------
catalog : `~astropy.table.Table`
The catalog of sources
Examples
--------
.. plot::
:include-source:
from photutils import datasets
catalog = datasets.load_spitzer_catalog()
plt.scatter(catalog['l'], catalog['b'])
plt.xlim(18.39, 18.05)
plt.ylim(0.13, 0.30)
"""
path = get_path('spitzer_example_catalog.xml', location='remote')
table = Table.read(path)
return table
def load_irac_psf(channel): # pragma: no cover
"""
Load Spitzer IRAC PSF.
Parameters
----------
channel : int (1-4)
The IRAC channel number:
* Channel 1: 3.6 microns
* Channel 2: 4.5 microns
* Channel 3: 5.8 microns
* Channel 4: 8.0 microns
Returns
-------
hdu : `~astropy.io.fits.ImageHDU`
The IRAC PSF.
Examples
--------
.. plot::
:include-source:
from photutils.datasets import load_irac_psf
hdu = load_irac_psf(1)
plt.imshow(hdu.data, origin='lower')
"""
channel = int(channel)
if channel < 1 or channel > 4:
raise ValueError('channel must be 1, 2, 3, or 4')
fn = 'irac_ch{0}_flight.fits'.format(channel)
path = get_path(fn, location='remote')
hdu = fits.open(path)[0]
return hdu
def load_fermi_image():
"""Load Fermi counts image for the Galactic center region.
Returns
-------
hdu : `~astropy.io.fits.ImageHDU`
Image HDU
Examples
--------
.. plot::
:include-source:
from photutils import datasets
hdu = datasets.load_fermi_image()
plt.imshow(hdu.data, origin='lower', vmax=10)
"""
path = get_path('fermi_counts.fits.gz', location='local')
hdu = fits.open(path)[1]
return hdu
def load_star_image(): # pragma: no cover
"""Load an optical image with stars.
Returns
-------
hdu : `~astropy.io.fits.ImageHDU`
Image HDU
Examples
--------
.. plot::
:include-source:
from photutils import datasets
hdu = datasets.load_star_image()
plt.imshow(hdu.data, origin='lower', cmap='gray')
"""
path = get_path('M6707HH.fits.gz', location='remote')
hdu = fits.open(path)[0]
return hdu
|