forked from GalSim-developers/GalSim
-
Notifications
You must be signed in to change notification settings - Fork 1
/
test_fitsheader.py
299 lines (257 loc) · 10.2 KB
/
test_fitsheader.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
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
# Copyright (c) 2012-2023 by the GalSim developers team on GitHub
# https://github.com/GalSim-developers
#
# This file is part of GalSim: The modular galaxy image simulation toolkit.
# https://github.com/GalSim-developers/GalSim
#
# GalSim is free software: redistribution and use in source and binary forms,
# with or without modification, are permitted provided that the following
# conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions, and the disclaimer given in the accompanying LICENSE
# file.
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the disclaimer given in the documentation
# and/or other materials provided with the distribution.
#
import numpy as np
import os
import sys
import galsim
from galsim_test_helpers import *
# Get whatever version of pyfits or astropy we are using
from galsim._pyfits import pyfits
@timer
def test_read():
"""Test reading a FitsHeader from an existing FITS file
"""
tpv_len = 215
def check_tpv(header):
"""Check that the header object has correct values from the tpv.fits file
"""
# Check using a few different access methods.
assert header['TIME-OBS'] == '04:28:14.105'
assert header.get('FILTER') == 'I'
assert header['AIRMASS'] == 1.185
assert len(header) == tpv_len
assert 'ADC' in header
assert ('FILPOS',6) in header.items()
assert ('FILPOS',6) in header.iteritems()
assert 'OBSERVAT' in header.keys()
assert 'OBSERVAT' in header.iterkeys()
assert 54384.18627436 in header.values() # MJD-OBS
assert 54384.18627436 in header.itervalues()
file_name = 'tpv.fits'
dir = 'fits_files'
# First option: give a file_name
header = galsim.FitsHeader(file_name=os.path.join(dir,file_name))
check_tpv(header)
check_pickle(header)
# Let the FitsHeader init handle the dir
header = galsim.FitsHeader(file_name=file_name, dir=dir)
check_tpv(header)
check_pickle(header)
# If the first arg is a str, then it should be interpreted as a file name
header = galsim.FitsHeader(file_name, dir=dir)
check_tpv(header)
# If you pass in a pyfits hdulist, that should also work
with pyfits.open(os.path.join(dir,file_name)) as hdu_list:
header = galsim.FitsHeader(hdu_list=hdu_list)
check_tpv(header)
check_pickle(header)
# Can explicitly give an hdu number to use. In this case, there is only 1, so need to use 0.
with pyfits.open(os.path.join(dir,file_name)) as hdu_list:
header = galsim.FitsHeader(hdu_list=hdu_list, hdu=0)
check_tpv(header)
check_pickle(header)
# Can explicitly give an hdu number to use. In this case, there is only 1, so need to use 0.
header = galsim.FitsHeader(file_name=file_name, dir=dir, hdu=0)
check_tpv(header)
check_pickle(header)
# If you pass in a pyfits Header object, that should also work
with pyfits.open(os.path.join(dir,file_name)) as hdu_list:
header = galsim.FitsHeader(header=hdu_list[0].header)
check_tpv(header)
check_pickle(header)
# The header is the first parameter, so don't need to name it.
with pyfits.open(os.path.join(dir,file_name)) as hdu_list:
header = galsim.FitsHeader(hdu_list[0].header)
check_tpv(header)
# FitsHeader can read from a compressed file too
header = galsim.FitsHeader(file_name=file_name + '.gz', dir=dir, compression='auto')
check_tpv(header)
check_pickle(header)
header = galsim.FitsHeader(file_name=file_name + '.gz', dir=dir, compression='gzip')
check_tpv(header)
check_pickle(header)
assert_raises(TypeError, galsim.FitsHeader, file_name=file_name, header=header)
with pyfits.open(os.path.join(dir,file_name)) as hdu_list:
assert_raises(TypeError, galsim.FitsHeader, file_name=file_name, hdu_list=hdu_list)
assert_raises(TypeError, galsim.FitsHeader, header=header, hdu_list=hdu_list)
# Remove an item from the header
# Start with file_name constructor, to test that the repr is changed by the edit.
orig_header = header
header = galsim.FitsHeader(file_name=os.path.join(dir,file_name))
assert header == orig_header
del header['AIRMASS']
assert 'AIRMASS' not in header
assert len(header) == tpv_len-1
assert header != orig_header
check_pickle(header)
# Should be able to get with a default value if the key is not present
assert header.get('AIRMASS', 2.0) == 2.0
# key should still not be in the header
assert 'AIRMASS' not in header
assert len(header) == tpv_len-1
assert header != orig_header
# Add items to a header
header['AIRMASS'] = 2
assert header.get('AIRMASS') == 2
assert header != orig_header
# Pop does a similar thing:
assert header.pop('AIRMASS') == 2.0
assert 'AIRMASS' not in header
# Works if not preset, given default
assert header.pop('AIRMASS', 2.0) == 2.0
assert 'AIRMASS' not in header
header['AIRMASS'] = 2
assert header['AIRMASS'] == 2
# Get real value if preset and given default value
assert header.pop('AIRMASS', 1.9) == 2.0
assert 'AIRMASS' not in header
header['AIRMASS'] = 2
assert header['AIRMASS'] == 2
# Overwrite an existing value
header['AIRMASS'] = 1.7
assert header.get('AIRMASS') == 1.7
assert header != orig_header
# Set with a comment field
header['AIRMASS'] = (1.9, 'The airmass of the observation')
assert header.get('AIRMASS') == 1.9
assert header != orig_header
# Update with a dict
d = { 'AIRMASS' : 1.185 }
header.update(d)
assert header.get('AIRMASS') == 1.185
# Extend is similar, but skip duplicates, and must be a FitsHeader
h = galsim.FitsHeader({ 'AIRMASS' : 1.2, 'RA': 123 })
header.extend(h)
assert header['AIRMASS'] == 1.185 # unchanged
assert header['RA'] == 123
# If replace = true, then update to the new values.
h['DEC'] = -22.5
header.extend(h, replace=True)
assert header['AIRMASS'] == 1.2 # changed
assert header['RA'] == 123
assert header['DEC'] == -22.5
# We are essentially back to where we started, except the len won't be right.
# Deleting a key removed an item each time, but setting it overwrote a blank item.
# But if we add back another few of these, we should be back to the original values.
header.append('','', useblanks=False)
header.append('','', useblanks=False)
header.append('','', useblanks=False)
header['AIRMASS'] = 1.185
check_tpv(header)
check_pickle(header)
assert header != orig_header # It's still not equal, because the AIRMASS item is in a
# different location in the list, which is relevant for equality.
# Clear all values
header.clear()
assert 'AIRMASS' not in header
assert 'FILTER' not in header
assert len(header) == 0
check_pickle(header)
assert header != orig_header
@timer
def test_scamp():
"""Test that we can read in a SCamp .head file correctly
"""
dir = 'fits_files'
file_name = 'scamp.head'
header = galsim.FitsHeader(file_name=file_name, dir=dir, text_file=True)
# Just check a few values. The full test of this file as a wcs is in test_wcs.py
assert header['RADECSYS'] == 'FK5'
assert header['MAGZEROP'] == 30.
assert header['ASTINST'] == 39
check_pickle(header)
def check_dict(d):
def check_dict(header):
"""Check that the header object has correct values from the given dict
"""
assert header['TIME-OBS'] == '04:28:14.105'
assert header['FILTER'] == 'I'
assert header['AIRMASS'] == 1.185
assert len(header) == 3
# Construct from a given dict
header = galsim.FitsHeader(header = d)
check_dict(header)
check_pickle(header)
# Start with a blank dict and add elements individually
header = galsim.FitsHeader(header = {})
check_pickle(header)
for k in d:
header[k] = d[k]
check_dict(header)
check_pickle(header)
# Set with a comment field
header = galsim.FitsHeader(header = {})
for k in d:
header[k] = (d[k], 'The value of ' + k)
check_dict(header)
check_pickle(header)
# Use update
header = galsim.FitsHeader({})
header.update(d)
check_dict(header)
check_pickle(header)
# Use default constructor
header = galsim.FitsHeader()
check_pickle(header)
assert len(header) == 0
header.update(d)
check_dict(header)
check_pickle(header)
@timer
def test_dict():
"""Test that we can create a FitsHeader from a dict
"""
d = { 'TIME-OBS' : '04:28:14.105' ,
'FILTER' : 'I',
'AIRMASS' : 1.185 }
check_dict(d)
@timer
def test_lowercase():
"""Test that lowercase keys are turned into uppercase.
"""
d = { 'Time-Obs' : '04:28:14.105' ,
'filter' : 'I',
'AirMAsS' : 1.185 }
check_dict(d)
@timer
def test_comments():
"""Test that comments are correctly added to the cards.
"""
# cf. Issue #877
# This test is taken directly from Bryan's failing example
im1 = galsim.Image(1,1,dtype=float)
im1.header = galsim.FitsHeader()
im1.header["CARD"] = ("value","comment")
galsim.fits.write(im1,os.path.join('output','test_comments_im1.fits'))
im2 = galsim.Image(1,1,dtype=float)
im2.header = {}
im2.header["CARD"] = ("value","comment")
galsim.fits.write(im1,os.path.join('output','test_comments_im2.fits'))
im3 = galsim.Image(1,1,dtype=float)
im3.header = {"CARD": ("value","comment")}
galsim.fits.write(im1,os.path.join('output','test_comments_im3.fits'))
im1 = galsim.fits.read(os.path.join('output','test_comments_im1.fits'), read_header=True)
im2 = galsim.fits.read(os.path.join('output','test_comments_im2.fits'), read_header=True)
im3 = galsim.fits.read(os.path.join('output','test_comments_im3.fits'), read_header=True)
for im in [im1, im2, im3]:
assert im.header['CARD'] == 'value'
assert im.header.comment('CARD') == 'comment'
if __name__ == "__main__":
testfns = [v for k, v in vars().items() if k[:5] == 'test_' and callable(v)]
for testfn in testfns:
testfn()