forked from pytroll/satpy
/
test_ahi_hsd.py
452 lines (412 loc) · 20.3 KB
/
test_ahi_hsd.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2018 Satpy developers
#
# This file is part of satpy.
#
# satpy is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# satpy is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# satpy. If not, see <http://www.gnu.org/licenses/>.
"""The ahi_hsd reader tests package."""
import unittest
import warnings
from datetime import datetime
from unittest import mock
import dask.array as da
import numpy as np
from satpy.readers.ahi_hsd import AHIHSDFileHandler
from satpy.readers.utils import get_geostationary_mask
class TestAHIHSDNavigation(unittest.TestCase):
"""Test the AHI HSD reader navigation."""
@mock.patch('satpy.readers.ahi_hsd.np2str')
@mock.patch('satpy.readers.ahi_hsd.np.fromfile')
def test_region(self, fromfile, np2str):
"""Test region navigation."""
from pyresample.utils import proj4_radius_parameters
np2str.side_effect = lambda x: x
m = mock.mock_open()
with mock.patch('satpy.readers.ahi_hsd.open', m, create=True):
fh = AHIHSDFileHandler('somefile',
{'segment': 1, 'total_segments': 1},
filetype_info={'file_type': 'hsd_b01'},
user_calibration=None)
fh.proj_info = {'CFAC': 40932549,
'COFF': -591.5,
'LFAC': 40932549,
'LOFF': 5132.5,
'blocklength': 127,
'coeff_for_sd': 1737122264.0,
'distance_from_earth_center': 42164.0,
'earth_equatorial_radius': 6378.137,
'earth_polar_radius': 6356.7523,
'hblock_number': 3,
'req2_rpol2': 1.006739501,
'req2_rpol2_req2': 0.0066943844,
'resampling_size': 4,
'resampling_types': 0,
'rpol2_req2': 0.993305616,
'spare': '',
'sub_lon': 140.7}
fh.data_info = {'blocklength': 50,
'compression_flag_for_data': 0,
'hblock_number': 2,
'number_of_bits_per_pixel': 16,
'number_of_columns': 1000,
'number_of_lines': 1000,
'spare': ''}
area_def = fh.get_area_def(None)
proj_dict = area_def.proj_dict
a, b = proj4_radius_parameters(proj_dict)
self.assertEqual(a, 6378137.0)
self.assertEqual(b, 6356752.3)
self.assertEqual(proj_dict['h'], 35785863.0)
self.assertEqual(proj_dict['lon_0'], 140.7)
self.assertEqual(proj_dict['proj'], 'geos')
self.assertEqual(proj_dict['units'], 'm')
np.testing.assert_allclose(area_def.area_extent, (592000.0038256242, 4132000.0267018233,
1592000.0102878273, 5132000.033164027))
@mock.patch('satpy.readers.ahi_hsd.np2str')
@mock.patch('satpy.readers.ahi_hsd.np.fromfile')
def test_segment(self, fromfile, np2str):
"""Test segment navigation."""
from pyresample.utils import proj4_radius_parameters
np2str.side_effect = lambda x: x
m = mock.mock_open()
with mock.patch('satpy.readers.ahi_hsd.open', m, create=True):
fh = AHIHSDFileHandler('somefile', {'segment': 8, 'total_segments': 10},
filetype_info={'file_type': 'hsd_b01'})
fh.proj_info = {'CFAC': 40932549,
'COFF': 5500.5,
'LFAC': 40932549,
'LOFF': 5500.5,
'blocklength': 127,
'coeff_for_sd': 1737122264.0,
'distance_from_earth_center': 42164.0,
'earth_equatorial_radius': 6378.137,
'earth_polar_radius': 6356.7523,
'hblock_number': 3,
'req2_rpol2': 1.006739501,
'req2_rpol2_req2': 0.0066943844,
'resampling_size': 4,
'resampling_types': 0,
'rpol2_req2': 0.993305616,
'spare': '',
'sub_lon': 140.7}
fh.data_info = {'blocklength': 50,
'compression_flag_for_data': 0,
'hblock_number': 2,
'number_of_bits_per_pixel': 16,
'number_of_columns': 11000,
'number_of_lines': 1100,
'spare': ''}
area_def = fh.get_area_def(None)
proj_dict = area_def.proj_dict
a, b = proj4_radius_parameters(proj_dict)
self.assertEqual(a, 6378137.0)
self.assertEqual(b, 6356752.3)
self.assertEqual(proj_dict['h'], 35785863.0)
self.assertEqual(proj_dict['lon_0'], 140.7)
self.assertEqual(proj_dict['proj'], 'geos')
self.assertEqual(proj_dict['units'], 'm')
np.testing.assert_allclose(area_def.area_extent, (-5500000.035542117, -3300000.021325271,
5500000.035542117, -2200000.0142168473))
class TestAHIHSDFileHandler(unittest.TestCase):
"""Test case for the file reading."""
def new_unzip(fname):
"""Fake unzipping."""
if fname[-3:] == 'bz2':
return fname[:-4]
return fname
@staticmethod
def _create_fake_file_handler(in_fname, filename_info=None, filetype_info=None):
if filename_info is None:
filename_info = {'segment': 8, 'total_segments': 10}
if filetype_info is None:
filetype_info = {'file_type': 'hsd_b01'}
fh = AHIHSDFileHandler(in_fname, filename_info, filetype_info)
# Check that the filename is altered for bz2 format files
assert in_fname != fh.filename
fh.proj_info = {
'CFAC': 40932549,
'COFF': 5500.5,
'LFAC': 40932549,
'LOFF': 5500.5,
'blocklength': 127,
'coeff_for_sd': 1737122264.0,
'distance_from_earth_center': 42164.0,
'earth_equatorial_radius': 6378.137,
'earth_polar_radius': 6356.7523,
'hblock_number': 3,
'req2_rpol2': 1.006739501,
'req2_rpol2_req2': 0.0066943844,
'resampling_size': 4,
'resampling_types': 0,
'rpol2_req2': 0.993305616,
'spare': '',
'sub_lon': 140.7
}
fh.nav_info = {
'SSP_longitude': 140.66,
'SSP_latitude': 0.03,
'distance_earth_center_to_satellite': 42165.04,
'nadir_longitude': 140.67,
'nadir_latitude': 0.04
}
fh.data_info = {
'blocklength': 50,
'compression_flag_for_data': 0,
'hblock_number': 2,
'number_of_bits_per_pixel': 16,
'number_of_columns': 11000,
'number_of_lines': 1100,
'spare': ''
}
fh.basic_info = {
'observation_area': np.array(['FLDK']),
'observation_start_time': np.array([58413.12523839]),
'observation_end_time': np.array([58413.12562439]),
'observation_timeline': np.array([300]),
}
fh.observation_area = fh.basic_info['observation_area']
return fh
@mock.patch('satpy.readers.ahi_hsd.np2str')
@mock.patch('satpy.readers.ahi_hsd.np.fromfile')
@mock.patch('satpy.readers.ahi_hsd.unzip_file',
mock.MagicMock(side_effect=new_unzip))
def setUp(self, fromfile, np2str):
"""Create a test file handler."""
np2str.side_effect = lambda x: x
m = mock.mock_open()
with mock.patch('satpy.readers.ahi_hsd.open', m, create=True):
# Check if file handler raises exception for invalid calibration mode
with self.assertRaises(ValueError):
AHIHSDFileHandler('somefile',
{'segment': 8, 'total_segments': 10},
filetype_info={'file_type': 'hsd_b01'},
calib_mode='BAD_MODE')
in_fname = 'test_file.bz2'
self.fh = self._create_fake_file_handler(in_fname)
def test_time_properties(self):
"""Test start/end/scheduled time properties."""
self.assertEqual(self.fh.start_time, datetime(2018, 10, 22, 3, 0, 20, 596896))
self.assertEqual(self.fh.end_time, datetime(2018, 10, 22, 3, 0, 53, 947296))
self.assertEqual(self.fh.scheduled_time, datetime(2018, 10, 22, 3, 0, 0, 0))
def test_scanning_frequencies(self):
"""Test scanning frequencies."""
self.fh.observation_area = 'JP04'
self.assertEqual(self.fh.scheduled_time, datetime(2018, 10, 22, 3, 7, 30, 0))
self.fh.observation_area = 'R304'
self.assertEqual(self.fh.scheduled_time, datetime(2018, 10, 22, 3, 7, 30, 0))
self.fh.observation_area = 'R420'
self.assertEqual(self.fh.scheduled_time, datetime(2018, 10, 22, 3, 9, 30, 0))
self.fh.observation_area = 'R520'
self.assertEqual(self.fh.scheduled_time, datetime(2018, 10, 22, 3, 9, 30, 0))
self.fh.observation_area = 'FLDK'
self.assertEqual(self.fh.scheduled_time, datetime(2018, 10, 22, 3, 0, 0, 0))
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._read_header')
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._read_data')
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._mask_invalid')
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler.calibrate')
def test_read_band(self, calibrate, *mocks):
"""Test masking of space pixels."""
nrows = 25
ncols = 100
self.fh.data_info['number_of_columns'] = ncols
self.fh.data_info['number_of_lines'] = nrows
calibrate.return_value = np.ones((nrows, ncols))
m = mock.mock_open()
with mock.patch('satpy.readers.ahi_hsd.open', m, create=True):
im = self.fh.read_band(info=mock.MagicMock(), key=mock.MagicMock())
# Note: Within the earth's shape get_geostationary_mask() is True but the numpy.ma mask
# is False
mask = im.to_masked_array().mask
ref_mask = np.logical_not(get_geostationary_mask(self.fh.area).compute())
self.assertTrue(np.all(mask == ref_mask))
# Test attributes
orb_params_exp = {'projection_longitude': 140.7,
'projection_latitude': 0.,
'projection_altitude': 35785863.0,
'satellite_actual_longitude': 140.66,
'satellite_actual_latitude': 0.03,
'nadir_longitude': 140.67,
'nadir_latitude': 0.04}
self.assertTrue(set(orb_params_exp.items()).issubset(set(im.attrs['orbital_parameters'].items())))
self.assertTrue(np.isclose(im.attrs['orbital_parameters']['satellite_actual_altitude'], 35786903.00581372))
# Test if masking space pixels disables with appropriate flag
self.fh.mask_space = False
with mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._mask_space') as mask_space:
self.fh.read_band(info=mock.MagicMock(), key=mock.MagicMock())
mask_space.assert_not_called()
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._read_header')
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._read_data')
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._mask_invalid')
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler.calibrate')
def test_scene_loading(self, calibrate, *mocks):
"""Test masking of space pixels."""
from satpy import Scene
nrows = 25
ncols = 100
calibrate.return_value = np.ones((nrows, ncols))
m = mock.mock_open()
with mock.patch('satpy.readers.ahi_hsd.open', m, create=True), \
mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler') as fh_cls:
fh_cls.return_value = self.fh
self.fh.filename_info['total_segments'] = 1
self.fh.filename_info['segment'] = 1
self.fh.data_info['number_of_columns'] = ncols
self.fh.data_info['number_of_lines'] = nrows
scn = Scene(reader='ahi_hsd', filenames=['HS_H08_20210225_0700_B07_FLDK_R20_S0110.DAT'])
scn.load(['B07'])
im = scn['B07']
# Make sure space masking worked
mask = im.to_masked_array().mask
ref_mask = np.logical_not(get_geostationary_mask(self.fh.area).compute())
self.assertTrue(np.all(mask == ref_mask))
def test_blocklen_error(self, *mocks):
"""Test erraneous blocklength."""
open_name = '%s.open' % __name__
fpos = 50
with mock.patch(open_name, create=True) as mock_open:
with mock_open(mock.MagicMock(), 'r') as fp_:
# Expected and actual blocklength match
fp_.tell.return_value = 50
with warnings.catch_warnings(record=True) as w:
self.fh._check_fpos(fp_, fpos, 0, 'header 1')
self.assertTrue(len(w) == 0)
# Expected and actual blocklength do not match
fp_.tell.return_value = 100
with warnings.catch_warnings(record=True) as w:
self.fh._check_fpos(fp_, fpos, 0, 'header 1')
self.assertTrue(len(w) > 0)
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler._check_fpos')
def test_read_header(self, *mocks):
"""Test header reading."""
nhdr = [
{'blocklength': 0},
{'blocklength': 0},
{'blocklength': 0},
{'blocklength': 0},
{'blocklength': 0, 'band_number': [4]},
{'blocklength': 0},
{'blocklength': 0},
{'blocklength': 0},
{'blocklength': 0, 'numof_correction_info_data': [1]},
{'blocklength': 0},
{'blocklength': 0, 'number_of_observation_times': [1]},
{'blocklength': 0},
{'blocklength': 0, 'number_of_error_info_data': [1]},
{'blocklength': 0},
{'blocklength': 0}]
with mock.patch('numpy.fromfile', side_effect=nhdr):
self.fh._read_header(mock.MagicMock())
class TestAHICalibration(unittest.TestCase):
"""Test case for various AHI calibration types."""
@mock.patch('satpy.readers.ahi_hsd.AHIHSDFileHandler.__init__',
return_value=None)
def setUp(self, *mocks):
"""Create fake data for testing."""
self.def_cali = [-0.0037, 15.20]
self.upd_cali = [-0.0074, 30.40]
self.bad_cali = [0.0, 0.0]
fh = AHIHSDFileHandler(filetype_info={'file_type': 'hsd_b01'})
fh.calib_mode = 'NOMINAL'
fh.user_calibration = None
fh.is_zipped = False
fh._header = {
'block5': {'band_number': [5],
'gain_count2rad_conversion': [self.def_cali[0]],
'offset_count2rad_conversion': [self.def_cali[1]],
'central_wave_length': [10.4073], },
'calibration': {'coeff_rad2albedo_conversion': [0.0019255],
'speed_of_light': [299792458.0],
'planck_constant': [6.62606957e-34],
'boltzmann_constant': [1.3806488e-23],
'c0_rad2tb_conversion': [-0.116127314574],
'c1_rad2tb_conversion': [1.00099153832],
'c2_rad2tb_conversion': [-1.76961091571e-06],
'cali_gain_count2rad_conversion': [self.upd_cali[0]],
'cali_offset_count2rad_conversion': [self.upd_cali[1]]},
}
self.counts = da.array(np.array([[0., 1000.],
[2000., 5000.]]))
self.fh = fh
def test_default_calibrate(self, *mocks):
"""Test default in-file calibration modes."""
self.setUp()
# Counts
self.assertEqual(self.fh.calibrate(data=123,
calibration='counts'),
123)
# Radiance
rad_exp = np.array([[15.2, 11.5],
[7.8, -3.3]])
rad = self.fh.calibrate(data=self.counts,
calibration='radiance')
self.assertTrue(np.allclose(rad, rad_exp))
# Brightness Temperature
bt_exp = np.array([[330.978979, 310.524688],
[285.845017, np.nan]])
bt = self.fh.calibrate(data=self.counts,
calibration='brightness_temperature')
np.testing.assert_allclose(bt, bt_exp)
# Reflectance
refl_exp = np.array([[2.92676, 2.214325],
[1.50189, 0.]])
refl = self.fh.calibrate(data=self.counts,
calibration='reflectance')
self.assertTrue(np.allclose(refl, refl_exp))
def test_updated_calibrate(self):
"""Test updated in-file calibration modes."""
# Standard operation
self.fh.calib_mode = 'UPDATE'
rad_exp = np.array([[30.4, 23.0],
[15.6, -6.6]])
rad = self.fh.calibrate(data=self.counts, calibration='radiance')
self.assertTrue(np.allclose(rad, rad_exp))
# Case for no updated calibration available (older data)
self.fh._header = {
'block5': {'band_number': [5],
'gain_count2rad_conversion': [self.def_cali[0]],
'offset_count2rad_conversion': [self.def_cali[1]],
'central_wave_length': [10.4073], },
'calibration': {'coeff_rad2albedo_conversion': [0.0019255],
'speed_of_light': [299792458.0],
'planck_constant': [6.62606957e-34],
'boltzmann_constant': [1.3806488e-23],
'c0_rad2tb_conversion': [-0.116127314574],
'c1_rad2tb_conversion': [1.00099153832],
'c2_rad2tb_conversion': [-1.76961091571e-06],
'cali_gain_count2rad_conversion': [self.bad_cali[0]],
'cali_offset_count2rad_conversion': [self.bad_cali[1]]},
}
rad = self.fh.calibrate(data=self.counts, calibration='radiance')
rad_exp = np.array([[15.2, 11.5],
[7.8, -3.3]])
self.assertTrue(np.allclose(rad, rad_exp))
def test_user_calibration(self):
"""Test user-defined calibration modes."""
# This is for radiance correction
self.fh.user_calibration = {'B13': {'slope': 0.95,
'offset': -0.1}}
self.fh.band_name = 'B13'
rad = self.fh.calibrate(data=self.counts, calibration='radiance').compute()
rad_exp = np.array([[16.10526316, 12.21052632],
[8.31578947, -3.36842105]])
self.assertTrue(np.allclose(rad, rad_exp))
# This is for DN calibration
self.fh.user_calibration = {'B13': {'slope': -0.0032,
'offset': 15.20},
'type': 'DN'}
self.fh.band_name = 'B13'
rad = self.fh.calibrate(data=self.counts, calibration='radiance').compute()
rad_exp = np.array([[15.2, 12.],
[8.8, -0.8]])
self.assertTrue(np.allclose(rad, rad_exp))