-
Notifications
You must be signed in to change notification settings - Fork 0
/
mpl_get_data_hut.py
100 lines (80 loc) · 3.85 KB
/
mpl_get_data_hut.py
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
"""
.. module:: mpl_get_data_hut
:synopsis: Returns HUT spectral data as a JSON string through Randy's
mast_plot.pl service.
.. moduleauthor:: Scott W. Fleming <[email protected]>
"""
import collections
from operator import itemgetter
from data_series import DataSeries
import requests
#--------------------
def mpl_get_data_hut(obsid):
"""
Given a HUT observation ID, returns the spectral data.
:param obsid: The HUT observation ID to retrieve the data from.
:type obsid: str
:returns: JSON -- The spectral data for this observation ID.
Error codes:
0 = No error.
1 = HTTP Error 500 code returned.
2 = "File not found error" returned by mast_plot.pl.
3 = Wavelength and/or flux arrays are zero length.
4 = Wavelength and flux arrays are not of equal length.
"""
# This defines a data point for a DataSeries object as a namedtuple.
data_point = collections.namedtuple('DataPoint', ['x', 'y'])
# For HUT, this defines the x-axis and y-axis units as a string.
hut_xunit = "Angstroms"
hut_yunit = "ergs/cm^2/s/Angstrom"
# Initiate a reqest from Randy's perl script service. Note the return is
# a 3-element list, each element itself if a list containing another list.
return_request = requests.get("https://archive.stsci.edu/cgi-bin/mast_plot"
".pl?HUT=" + obsid.upper())
if return_request.status_code == 500:
# If an HTTP 500 error is returned, catch it here, since it can't
# be converted to a JSON string using the built-in json().
errcode = 1
return_dataseries = DataSeries('hut', obsid, [], [], [], [], errcode)
else:
return_request = return_request.json()
if not return_request[0]:
# File not found by service.
errcode = 2
return_dataseries = DataSeries('hut', obsid, [], [], [], [],
errcode)
else:
# Wavelengths are the first list in the returned 3-element list.
wls = [float("{0:.8f}".format(x)) for x in return_request[0][0]]
# Fluxes are the second list in the returned 3-element list.
fls = [float("{0:.8e}".format(x)) for x in return_request[1][0]]
# This error code will be used unless there's a problem reading any
# of the FITS files in the list.
errcode = 0
# Make sure wavelengths and fluxes are not empty and are same size.
if wls and fls and len(wls) == len(fls):
# Make sure wavelengths and fluxes are sorted
# from smallest wavelength to largest.
sort_indexes = [x[0] for x in sorted(enumerate(wls),
key=itemgetter(1))]
wls = [wls[x] for x in sort_indexes]
fls = [fls[x] for x in sort_indexes]
# Zip the wavelengths and fluxes into tuples to create the plot
# series.
plot_series = [[data_point(x=x, y=y) for x, y in zip(wls, fls)]]
# Create the return DataSeries object.
return_dataseries = DataSeries('hut', obsid, plot_series,
['HUT_' + obsid[3:]],
[hut_xunit], [hut_yunit],
errcode)
elif not wls or not fls:
errcode = 3
return_dataseries = DataSeries('hut', obsid, [], [], [], [],
errcode)
else:
errcode = 4
return_dataseries = DataSeries('hut', obsid, [], [], [], [],
errcode)
# Return the DataSeries object back to the calling module.
return return_dataseries
#--------------------