class TestGacReader(unittest.TestCase):
"""Test the common GAC Reader."""
longMessage = True
@mock.patch.multiple('pygac.gac_reader.GACReader',
__abstractmethods__=set())
@mock.patch('pygac.gac_reader.gtp.gac_lat_lon_interpolator')
def setUp(self, interpolator, *mocks):
"""Set up the tests."""
self.interpolator = interpolator
self.reader = GACReader()
# python 2 compatibility
if sys.version_info.major < 3:
self.assertRaisesRegex = self.assertRaisesRegexp
def test_filename(self):
"""Test the setter of the filename property."""
# test path with .gz extension
filename = 'NSS.GHRR.TN.D80001.S0332.E0526.B0627173.WI'
filepath = '/path/to/' + filename + '.gz'
self.reader.filename = filepath
self.assertEqual(self.reader.filename, filename)
@unittest.skipIf(sys.version_info.major < 3, "Skipped in python2!")
def test__read_scanlines(self):
"""Test the scanline extraction."""
self.reader.scanline_type = np.dtype([('a', 'S2'), ('b', '<i4')])
# request more scan lines than available
with self.assertWarnsRegex(RuntimeWarning,
"Unexpected number of scanlines!"):
buffer = (b'a\x00\x01\x00\x00\x00'
b'b\x00\x02\x00\x00\x00'
b'c\x00\x03\x00\x00\x00')
count = 4
self.reader._read_scanlines(buffer, count)
# check the output
first_line = self.reader.scans[0]
self.assertEqual(first_line['a'], b'a')
self.assertEqual(first_line['b'], 1)
def test__validate_header(self):
"""Test the header validation."""
# wrong name pattern
with self.assertRaisesRegex(ReaderError,
'Data set name .* does not match!'):
head = {'data_set_name': b'abc.txt'}
self.reader._validate_header(head)
# Unicode errors are now caught with the same exception.
with self.assertRaisesRegex(ReaderError,
'Data set name .* does not match!'):
head = {'data_set_name': b'\xea\xf8'}
self.reader._validate_header(head)
def test__correct_data_set_name(self):
"""Test the data_set_name correction in file header."""
val_filename = 'NSS.GHRR.TN.D80001.S0332.E0526.B0627173.WI'
val_filepath = 'path/to/' + val_filename
val_head = {
'data_set_name': b'NSS.GHRR.TN.D80001.S0332.E0526.B0627173.WI'
}
inv_filename = 'InvalidFileName'
inv_filepath = 'path/to/' + inv_filename
inv_head = {'data_set_name': b'InvalidDataSetName'}
# Note: always pass a copy to _correct_data_set_name, because
# the input header is modified in place.
# enter a valid data_set_name and filepath
head = self.reader._correct_data_set_name(val_head.copy(),
val_filepath)
# enter an invalid data_set_name, but valid filepath
head = self.reader._correct_data_set_name(inv_head.copy(),
val_filepath)
self.assertEqual(head['data_set_name'], val_filename.encode())
# enter an invalid data_set_name, and invalid filepath
with self.assertRaisesRegex(ReaderError,
'Cannot determine data_set_name!'):
head = self.reader._correct_data_set_name(inv_head.copy(),
inv_filepath)
# enter a valid data_set_name, and an invalid filepath
# should be fine, because the data_set_name is the pefered source
head = self.reader._correct_data_set_name(val_head.copy(),
inv_filepath)
self.assertEqual(head['data_set_name'], val_head['data_set_name'])
@mock.patch('pygac.reader.Reader.get_calibrated_channels')
def test__get_calibrated_channels_uniform_shape(self, get_channels):
"""Test the uniform shape as required by gac_io.save_gac."""
# check if it raises the assertion error
channels = np.arange(2 * 2 * 5, dtype=float).reshape((2, 2, 5))
get_channels.return_value = channels
with self.assertRaises(AssertionError):
self.reader._get_calibrated_channels_uniform_shape()
def test_to_datetime64(self):
"""Test conversion from (year, jday, msec) to datetime64."""
t0 = GACReader.to_datetime64(year=np.array(1970),
jday=np.array(1),
msec=np.array(0))
self.assertEqual(t0.astype('i8'),
0,
msg='Conversion (year, jday, msec) to datetime64 '
'is not correct')
def test_to_datetime(self):
"""Test conversion from datetime64 to datetime."""
dt = datetime.datetime(2019, 10, 1, 12, 15, 18, 12345)
dt64 = np.datetime64(dt)
self.assertEqual(self.reader.to_datetime(dt64), dt)
def test_lineno2msec(self):
"""Test scanline timestamp estimation."""
self.assertEqual(self.reader.lineno2msec(12345), 6172000)
@mock.patch('pygac.reader.Reader.update_meta_data')
@mock.patch('pygac.gac_reader.GACReader._get_lonlat')
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
@mock.patch('pygac.gac_reader.GACReader._adjust_clock_drift')
def test_get_lonlat(self, adjust_clockdrift, get_corrupt_mask, get_lonlat,
update_meta_data):
"""Test common lon/lat computation."""
lon_i = np.array([np.nan, 1, 2, 3, -180.1, 180.1])
lat_i = np.array([1, 2, 3, np.nan, -90.1, 90.1])
get_lonlat.return_value = lon_i, lat_i
self.interpolator.return_value = lon_i, lat_i
get_corrupt_mask.return_value = np.array([0, 0, 1, 0, 0, 0],
dtype=bool)
lons_exp = np.array([np.nan, 1, np.nan, 3., np.nan, np.nan])
lats_exp = np.array([1, 2, np.nan, np.nan, np.nan, np.nan])
# Default
lons, lats = self.reader.get_lonlat()
get_lonlat.assert_called()
update_meta_data.assert_called()
adjust_clockdrift.assert_called()
numpy.testing.assert_array_equal(lons, lons_exp)
numpy.testing.assert_array_equal(lats, lats_exp)
# Interpolation disabled
self.interpolator.reset_mock()
adjust_clockdrift.reset_mock()
self.reader.interpolate_coords = False
self.reader.adjust_clock_drift = True
self.reader.lons = self.reader.lats = None
self.reader.get_lonlat()
numpy.testing.assert_array_equal(lons, lons_exp)
numpy.testing.assert_array_equal(lats, lats_exp)
self.interpolator.assert_not_called()
adjust_clockdrift.assert_called()
# Clock drift adjustment disabled
self.interpolator.reset_mock()
adjust_clockdrift.reset_mock()
self.reader.interpolate_coords = True
self.reader.adjust_clock_drift = False
self.reader.lons = self.reader.lats = None
self.reader.get_lonlat()
numpy.testing.assert_array_equal(lons, lons_exp)
numpy.testing.assert_array_equal(lats, lats_exp)
self.interpolator.assert_called()
adjust_clockdrift.assert_not_called()
# Test caching
methods = [
get_lonlat, self.interpolator, adjust_clockdrift, get_corrupt_mask
]
for method in methods:
method.reset_mock()
self.reader.get_lonlat()
for method in methods:
method.asser_not_called()
@mock.patch('pygac.reader.Reader.update_meta_data')
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
@mock.patch('pygac.gac_reader.GACReader._adjust_clock_drift')
@mock.patch('pygac.gac_reader.GACReader._get_lonlat')
def test_interpolate(self, _get_lonlat, _adjust_clock_drift,
_get_corrupt_mask, update_meta_data):
"""Test interpolate method in get_lonlat."""
self.lons = None
self.lats = None
lr_lons = 90 * np.random.rand(17, 51)
lr_lats = 90 * np.random.rand(17, 51)
_get_lonlat.return_value = lr_lons, lr_lats
self.interpolate_coors = True
self.interpolator.reset_mock()
self.interpolator.return_value = (90 * np.random.rand(17, 409),
90 * np.random.rand(17, 409))
lons, lats = self.reader.get_lonlat()
self.assertEqual(lons.shape[1], 409)
self.interpolator.assert_called_once_with(lr_lons, lr_lats)
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
def test_get_corrupt_mask(self, get_corrupt_mask):
"""Test common computation of corrupt scanline mask."""
get_corrupt_mask.return_value = [1, 2, 3]
self.assertEqual(self.reader.mask, [1, 2, 3])
# Test caching
get_corrupt_mask.reset_mock()
self.reader.mask
get_corrupt_mask.assert_not_called()
def test_midnight_scanline(self):
"""Test midnight scanline computation."""
# Define test cases...
# ... midnight scanline exists
utcs1 = np.array([-3, -2, -1, 0, 1, 2, 3]).astype('datetime64[ms]')
scanline1 = 2
# ... midnight scanline does not exist
utcs2 = np.array([1, 2, 3]).astype('datetime64[ms]')
scanline2 = None
for utcs, scanline in zip((utcs1, utcs2), (scanline1, scanline2)):
self.reader.utcs = utcs
self.assertEqual(self.reader.get_midnight_scanline(),
scanline,
msg='Incorrect midnight scanline')
def test_miss_lines(self):
"""Test detection of missing scanlines."""
lines = [2, 4, 5, 6, 10, 11, 12]
miss_lines_ref = [1, 3, 7, 8, 9]
self.reader.scans = np.zeros(len(lines),
dtype=[('scan_line_number', 'i2')])
self.reader.scans['scan_line_number'] = lines
miss_lines = self.reader.get_miss_lines()
self.assertTrue((miss_lines == miss_lines_ref).all(),
msg='Missing scanlines not detected correctly')
self.assertEqual(miss_lines.dtype, int)
def test_tle2datetime64(self, *mocks):
"""Test conversion from TLE timestamps to datetime64."""
dates = np.array([70365.1234, 18001.25])
dates64_exp = [
np.datetime64(datetime.datetime(1970, 12, 31, 2, 57, 41, 760000),
'[ms]'),
np.datetime64(datetime.datetime(2018, 1, 1, 6, 0), '[ms]')
]
dates64 = GACReader.tle2datetime64(dates)
self.assertTrue(np.all(dates64 == dates64_exp))
@mock.patch('pygac.gac_reader.GACReader.get_times')
@mock.patch('pygac.gac_reader.GACReader.get_tle_file')
@mock.patch('pygac.gac_reader.GACReader.read_tle_file')
def test_get_tle_lines(self, read_tle_file, *mocks):
"""Test identification of closest TLE lines."""
tle_data = [
'1 38771U 12049A 18363.63219793 -.00000013 00000-0 14176-4 0 9991\r\n',
'2 38771 98.7297 60.1350 0002062 95.9284 25.0713 14.21477560325906\r\n',
'1 38771U 12049A 18364.62426010 -.00000015 00000-0 13136-4 0 9990\r\n', # 2018-12-30 14:58
'2 38771 98.7295 61.1159 0002062 94.5796 60.2561 14.21477636326047\r\n',
'1 38771U 12049A 18364.94649306 -.00000018 00000-0 12040-4 0 9996\r\n', # 2018-12-30 22:42
'2 38771 98.7295 61.4345 0002060 94.1226 268.7521 14.21477633326092\r\n',
'1 38771U 12049A 18365.81382142 -.00000015 00000-0 13273-4 0 9991\r\n',
'2 38771 98.7294 62.2921 0002057 92.7653 26.0030 14.21477711326215\r\n'
]
expected = {
datetime.datetime(2018, 12, 20, 12, 0): None,
datetime.datetime(2018, 12, 28, 12, 0): 0,
datetime.datetime(2018, 12, 30, 16, 0): 2,
datetime.datetime(2018, 12, 30, 20, 0): 4,
datetime.datetime(2019, 1, 1, 12, 0): 6,
datetime.datetime(2019, 1, 8, 12, 0): None
}
read_tle_file.return_value = tle_data
for time, tle_idx in expected.items():
self.reader.utcs = np.array([time], dtype='datetime64[ms]')
self.reader.tle_lines = None
if tle_idx is None:
self.assertRaises(IndexError, self.reader.get_tle_lines)
else:
tle1, tle2 = self.reader.get_tle_lines()
self.assertEqual(tle1, tle_data[tle_idx])
self.assertEqual(tle2, tle_data[tle_idx + 1])
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
def test_get_angles(self, get_corrupt_mask):
"""Test get_angles function of the reader."""
# Line: 1, 649, 6198 and 12658 from Tiros-N file (1980-01-03 11:47)
lon_i = np.array([69.41555, 152.10587, 164.3131, 67.23855,
np.nan])[:, np.newaxis]
lat_i = np.array([71.6283, 85.24265, -62.076958, 82.72296,
np.nan])[:, np.newaxis]
get_corrupt_mask.return_value = np.isnan(lon_i)
self.reader.lons = lon_i
self.reader.lats = lat_i
self.reader.tle_lines = [
'1 11060U 78096A 80003.54792075 .00000937 00000-0 52481-3 0 2588\r\n', # noqa
'2 11060 98.9783 332.1605 0012789 88.8047 271.4583 14.11682873 63073\r\n'
] # noqa
self.reader.utcs = np.array([
315748035469, 315748359969, 315751135469, 315754371969,
315754371969
]).astype('datetime64[ms]')
self.reader.spacecrafts_orbital = {25: 'tiros n'}
self.reader.spacecraft_id = 25
expected_sat_azi = np.array([-76.90, 11.08, 145.33, -50.01,
np.nan])[:, np.newaxis]
expected_sun_azi = np.array([-120.36, -31.94, -173.51, -93.67,
np.nan])[:, np.newaxis]
expected_sat_zenith = np.array([69.05, 69.04, 69.55, 69.07,
np.nan])[:, np.newaxis]
expected_sun_zenith = np.array([104.30, 116.94, 94.86, 112.60,
np.nan])[:, np.newaxis]
expected_rel_azi = np.array([43.45, 43.01, 41.16, 43.65,
np.nan])[:, np.newaxis]
retv = self.reader.get_angles()
(sat_azi, sat_zenith, sun_azi, sun_zenith, rel_azi) = retv
np.testing.assert_allclose(sat_azi, expected_sat_azi, atol=0.01)
np.testing.assert_allclose(sun_azi, expected_sun_azi, atol=0.01)
np.testing.assert_allclose(sat_zenith, expected_sat_zenith, atol=0.01)
np.testing.assert_allclose(sun_zenith, expected_sun_zenith, atol=0.01)
np.testing.assert_allclose(rel_azi, expected_rel_azi, atol=0.01)
def test_get_tle_file(self):
"""Test get_tle_file."""
self.reader.tle_dir = '/tle/dir'
self.reader.tle_name = 'tle_%(satname)s.txt'
self.reader.spacecraft_name = 'ISS'
tle_file = self.reader.get_tle_file()
self.assertEqual(tle_file, '/tle/dir/tle_ISS.txt')
@mock.patch('pygac.gac_reader.GACReader.get_tsm_pixels')
def test_mask_tsm_pixels(self, get_tsm_pixels):
"""Test masking of pixels affected by the scan motor issue."""
get_tsm_pixels.return_value = ([0, 1], [0, 1])
channels = np.array([[[1., 2., 3.], [1., 2., 3.]],
[[1., 2., 3.],
[1., 2., 3.]]]) # (lines, pixels, channels)
masked_exp = np.array([[[np.nan, np.nan, np.nan], [1., 2., 3.]],
[[1., 2., 3.], [np.nan, np.nan, np.nan]]])
self.reader.mask_tsm_pixels(channels) # masks in-place
numpy.testing.assert_array_equal(channels, masked_exp)
def _get_scanline_numbers(self):
"""Create artificial scanline numbers with some corruptions.
Returns:
Corrupted and corrected scanline numbers.
"""
along_track = 12000
scans = np.zeros(12000, dtype=[("scan_line_number", ">u2")])
scans["scan_line_number"] = np.arange(1, along_track + 1)
# ... with 500 missing scanlines at scanline 8000
scans["scan_line_number"][8000:] += 500
corrected = scans["scan_line_number"].copy()
# ... and some spikes here and there
scans["scan_line_number"][3000] += 1E4
scans["scan_line_number"][9000] -= 1E4
corrected = np.delete(corrected, [3000, 9000])
return scans, corrected
def test_correct_scan_line_numbers(self):
"""Test scanline number correction."""
scans, expected = self._get_scanline_numbers()
self.reader.scans = scans
self.reader.correct_scan_line_numbers()
numpy.testing.assert_array_equal(self.reader.scans['scan_line_number'],
expected)
@mock.patch('pygac.gac_reader.GACReader.get_header_timestamp')
def test_correct_times_thresh(self, get_header_timestamp):
"""Test correction of scanline timestamps."""
header_time = datetime.datetime(2016, 8, 16, 16, 7, 36)
# Create artificial timestamps
_, scan_line_numbers = self._get_scanline_numbers()
t0 = np.array([header_time], dtype="datetime64[ms]").astype("i8")[0]
shift = 1000
msecs = t0 + shift + scan_line_numbers / GACReader.scan_freq
utcs_expected = msecs.copy().astype(">M8[ms]")
# Add some corruptions
msecs[3000:] += 1800 * 1000
msecs[1000] += 24 * 3600 * 1000
msecs[2000] -= 24 * 3600 * 1000
# Mock reader
get_header_timestamp.return_value = header_time
self.reader.utcs = msecs.astype(">M8[ms]")
self.reader.scans = np.array(scan_line_numbers,
dtype=[("scan_line_number", ">u2")])
# Test correction
self.reader.correct_times_thresh()
numpy.testing.assert_array_equal(self.reader.utcs, utcs_expected)
def test_calculate_sun_earth_distance_correction(self):
"""Test the calculate sun earth distance correction method."""
self.reader.utcs = np.array([
315748035469, 315748359969, 315751135469, 315754371969,
315754371969
]).astype('datetime64[ms]')
corr = self.reader.get_sun_earth_distance_correction()
numpy.testing.assert_almost_equal(corr, 0.96660494, decimal=7)
@mock.patch('pygac.reader.Reader.get_sun_earth_distance_correction')
@mock.patch('pygac.reader.Reader.get_midnight_scanline')
@mock.patch('pygac.reader.Reader.get_miss_lines')
@mock.patch('pygac.reader.Reader.calibration',
new_callable=mock.PropertyMock)
def test_update_metadata(self, calibration, get_miss_lines,
get_midnight_scanline,
get_sun_earth_distance_correction):
get_miss_lines.return_value = 'miss_lines'
get_midnight_scanline.return_value = 'midn_line'
get_sun_earth_distance_correction.return_value = 'factor'
self.reader.head = {'foo': 'bar'}
calibration.return_value = mock.MagicMock(version='version')
self.reader.update_meta_data()
mda_exp = {
'midnight_scanline': 'midn_line',
'missing_scanlines': 'miss_lines',
'sun_earth_distance_correction_factor': 'factor',
'gac_header': {
'foo': 'bar'
},
'calib_coeffs_version': 'version'
}
self.assertDictEqual(self.reader.meta_data, mda_exp)
class TestGacReader(unittest.TestCase):
"""Test the common GAC Reader."""
longMessage = True
@mock.patch.multiple('pygac.gac_reader.GACReader',
__abstractmethods__=set())
@mock.patch('pygac.gac_reader.gtp.gac_lat_lon_interpolator')
def setUp(self, interpolator, *mocks):
"""Set up the tests."""
self.interpolator = interpolator
self.reader = GACReader()
# python 2 compatibility
if sys.version_info.major < 3:
self.assertRaisesRegex = self.assertRaisesRegexp
def test_filename(self):
"""Test the setter of the filename property."""
# test path with .gz extension
filename = 'NSS.GHRR.TN.D80001.S0332.E0526.B0627173.WI'
filepath = '/path/to/' + filename + '.gz'
self.reader.filename = filepath
self.assertEqual(self.reader.filename, filename)
self.reader.filename = None
self.assertIsNone(self.reader.filename)
self.reader.filename = TestPath(filepath)
self.assertEqual(self.reader.filename, filename)
@unittest.skipIf(sys.version_info.major < 3, "Skipped in python2!")
def test__read_scanlines(self):
"""Test the scanline extraction."""
self.reader.scanline_type = np.dtype([('a', 'S2'), ('b', '<i4')])
# request more scan lines than available
with self.assertWarnsRegex(RuntimeWarning,
"Unexpected number of scanlines!"):
buffer = (b'a\x00\x01\x00\x00\x00'
b'b\x00\x02\x00\x00\x00'
b'c\x00\x03\x00\x00\x00')
count = 4
self.reader._read_scanlines(buffer, count)
# check the output
first_line = self.reader.scans[0]
self.assertEqual(first_line['a'], b'a')
self.assertEqual(first_line['b'], 1)
def test__validate_header(self):
"""Test the header validation."""
# wrong name pattern
with self.assertRaisesRegex(ReaderError,
'Data set name .* does not match!'):
head = {'data_set_name': b'abc.txt'}
self.reader._validate_header(head)
# Unicode errors are now caught with the same exception.
with self.assertRaisesRegex(ReaderError,
'Data set name .* does not match!'):
head = {'data_set_name': b'\xea\xf8'}
self.reader._validate_header(head)
def test__correct_data_set_name(self):
"""Test the data_set_name correction in file header."""
val_filename = 'NSS.GHRR.TN.D80001.S0332.E0526.B0627173.WI'
val_filepath = 'path/to/' + val_filename
val_head = {
'data_set_name': b'NSS.GHRR.TN.D80001.S0332.E0526.B0627173.WI'
}
inv_filename = 'InvalidFileName'
inv_filepath = 'path/to/' + inv_filename
inv_head = {'data_set_name': b'InvalidDataSetName'}
# Note: always pass a copy to _correct_data_set_name, because
# the input header is modified in place.
# enter a valid data_set_name and filepath
head = self.reader._correct_data_set_name(val_head.copy(),
val_filepath)
# enter an invalid data_set_name, but valid filepath
head = self.reader._correct_data_set_name(inv_head.copy(),
val_filepath)
self.assertEqual(head['data_set_name'], val_filename.encode())
# enter an invalid data_set_name, and invalid filepath
with self.assertRaisesRegex(ReaderError,
'Cannot determine data_set_name!'):
head = self.reader._correct_data_set_name(inv_head.copy(),
inv_filepath)
# enter a valid data_set_name, and an invalid filepath
# should be fine, because the data_set_name is the pefered source
head = self.reader._correct_data_set_name(val_head.copy(),
inv_filepath)
self.assertEqual(head['data_set_name'], val_head['data_set_name'])
# enter a valid data_set_name, and an FSFile/pathlib object as filepath
fs_filepath = TestPath(val_filepath)
head = self.reader._correct_data_set_name(val_head.copy(), fs_filepath)
self.assertEqual(head['data_set_name'], val_filename.encode())
@mock.patch('pygac.reader.Reader.get_calibrated_channels')
def test__get_calibrated_channels_uniform_shape(self, get_channels):
"""Test the uniform shape as required by gac_io.save_gac."""
# check if it raises the assertion error
channels = np.arange(2 * 2 * 5, dtype=float).reshape((2, 2, 5))
get_channels.return_value = channels
with self.assertRaises(AssertionError):
self.reader._get_calibrated_channels_uniform_shape()
def test_get_calibrated_channels(self):
reader = FakeGACReader()
res = reader.get_calibrated_channels()
expected = np.full(
(
FakeGACReader.along_track,
FakeGACReader.across_track,
5 # number of channels
),
np.nan)
expected[:, 1, 0] = 8.84714652
expected[:, 2, 1] = 10.23511303
np.testing.assert_allclose(res, expected)
def test_to_datetime64(self):
"""Test conversion from (year, jday, msec) to datetime64."""
t0 = GACReader.to_datetime64(year=np.array(1970),
jday=np.array(1),
msec=np.array(0))
self.assertEqual(t0.astype('i8'),
0,
msg='Conversion (year, jday, msec) to datetime64 '
'is not correct')
def test_to_datetime(self):
"""Test conversion from datetime64 to datetime."""
dt = datetime.datetime(2019, 10, 1, 12, 15, 18, 12345)
dt64 = np.datetime64(dt)
self.assertEqual(self.reader.to_datetime(dt64), dt)
def test_lineno2msec(self):
"""Test scanline timestamp estimation."""
self.assertEqual(self.reader.lineno2msec(12345), 6172000)
@mock.patch('pygac.reader.Reader.update_meta_data')
@mock.patch('pygac.gac_reader.GACReader._get_lonlat')
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
@mock.patch('pygac.gac_reader.GACReader._adjust_clock_drift')
def test_get_lonlat(self, adjust_clockdrift, get_corrupt_mask, get_lonlat,
update_meta_data):
"""Test common lon/lat computation."""
lon_i = np.array([np.nan, 1, 2, 3, -180.1, 180.1])
lat_i = np.array([1, 2, 3, np.nan, -90.1, 90.1])
get_lonlat.return_value = lon_i, lat_i
self.interpolator.return_value = lon_i, lat_i
get_corrupt_mask.return_value = np.array([0, 0, 1, 0, 0, 0],
dtype=bool)
lons_exp = np.array([np.nan, 1, np.nan, 3., np.nan, np.nan])
lats_exp = np.array([1, 2, np.nan, np.nan, np.nan, np.nan])
# Default
lons, lats = self.reader.get_lonlat()
get_lonlat.assert_called()
update_meta_data.assert_called()
adjust_clockdrift.assert_called()
numpy.testing.assert_array_equal(lons, lons_exp)
numpy.testing.assert_array_equal(lats, lats_exp)
# Interpolation disabled
self.interpolator.reset_mock()
adjust_clockdrift.reset_mock()
self.reader.interpolate_coords = False
self.reader.adjust_clock_drift = True
self.reader.lons = self.reader.lats = None
self.reader.get_lonlat()
numpy.testing.assert_array_equal(lons, lons_exp)
numpy.testing.assert_array_equal(lats, lats_exp)
self.interpolator.assert_not_called()
adjust_clockdrift.assert_called()
# Clock drift adjustment disabled
self.interpolator.reset_mock()
adjust_clockdrift.reset_mock()
self.reader.interpolate_coords = True
self.reader.adjust_clock_drift = False
self.reader.lons = self.reader.lats = None
self.reader.get_lonlat()
numpy.testing.assert_array_equal(lons, lons_exp)
numpy.testing.assert_array_equal(lats, lats_exp)
self.interpolator.assert_called()
adjust_clockdrift.assert_not_called()
# Test caching
methods = [
get_lonlat, self.interpolator, adjust_clockdrift, get_corrupt_mask
]
for method in methods:
method.reset_mock()
self.reader.get_lonlat()
for method in methods:
method.asser_not_called()
@mock.patch('pygac.reader.Reader.update_meta_data')
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
@mock.patch('pygac.gac_reader.GACReader._adjust_clock_drift')
@mock.patch('pygac.gac_reader.GACReader._get_lonlat')
def test_interpolate(self, _get_lonlat, _adjust_clock_drift,
_get_corrupt_mask, update_meta_data):
"""Test interpolate method in get_lonlat."""
self.lons = None
self.lats = None
lr_lons = 90 * np.random.rand(17, 51)
lr_lats = 90 * np.random.rand(17, 51)
_get_lonlat.return_value = lr_lons, lr_lats
self.interpolate_coors = True
self.interpolator.reset_mock()
self.interpolator.return_value = (90 * np.random.rand(17, 409),
90 * np.random.rand(17, 409))
lons, lats = self.reader.get_lonlat()
self.assertEqual(lons.shape[1], 409)
self.interpolator.assert_called_once_with(lr_lons, lr_lats)
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
def test_get_corrupt_mask(self, get_corrupt_mask):
"""Test common computation of corrupt scanline mask."""
get_corrupt_mask.return_value = [1, 2, 3]
self.assertEqual(self.reader.mask, [1, 2, 3])
# Test caching
get_corrupt_mask.reset_mock()
self.reader.mask
get_corrupt_mask.assert_not_called()
def test_midnight_scanline(self):
"""Test midnight scanline computation."""
# Define test cases...
# ... midnight scanline exists
utcs1 = np.array([-3, -2, -1, 0, 1, 2, 3]).astype('datetime64[ms]')
scanline1 = 2
# ... midnight scanline does not exist
utcs2 = np.array([1, 2, 3]).astype('datetime64[ms]')
scanline2 = None
for utcs, scanline in zip((utcs1, utcs2), (scanline1, scanline2)):
self.reader.utcs = utcs
self.assertEqual(self.reader.get_midnight_scanline(),
scanline,
msg='Incorrect midnight scanline')
def test_miss_lines(self):
"""Test detection of missing scanlines."""
lines = [2, 4, 5, 6, 10, 11, 12]
miss_lines_ref = [1, 3, 7, 8, 9]
self.reader.scans = np.zeros(len(lines),
dtype=[('scan_line_number', 'i2')])
self.reader.scans['scan_line_number'] = lines
miss_lines = self.reader.get_miss_lines()
self.assertTrue((miss_lines == miss_lines_ref).all(),
msg='Missing scanlines not detected correctly')
self.assertEqual(miss_lines.dtype, int)
def test_tle2datetime64(self, *mocks):
"""Test conversion from TLE timestamps to datetime64."""
dates = np.array([70365.1234, 18001.25])
dates64_exp = [
np.datetime64(datetime.datetime(1970, 12, 31, 2, 57, 41, 760000),
'[ms]'),
np.datetime64(datetime.datetime(2018, 1, 1, 6, 0), '[ms]')
]
dates64 = GACReader.tle2datetime64(dates)
self.assertTrue(np.all(dates64 == dates64_exp))
@mock.patch('pygac.gac_reader.GACReader.get_times')
@mock.patch('pygac.gac_reader.GACReader.get_tle_file')
@mock.patch('pygac.gac_reader.GACReader.read_tle_file')
def test_get_tle_lines(self, read_tle_file, *mocks):
"""Test identification of closest TLE lines."""
tle_data = [
'1 38771U 12049A 18363.63219793 -.00000013 00000-0 14176-4 0 9991\r\n',
'2 38771 98.7297 60.1350 0002062 95.9284 25.0713 14.21477560325906\r\n',
'1 38771U 12049A 18364.62426010 -.00000015 00000-0 13136-4 0 9990\r\n', # 2018-12-30 14:58
'2 38771 98.7295 61.1159 0002062 94.5796 60.2561 14.21477636326047\r\n',
'1 38771U 12049A 18364.94649306 -.00000018 00000-0 12040-4 0 9996\r\n', # 2018-12-30 22:42
'2 38771 98.7295 61.4345 0002060 94.1226 268.7521 14.21477633326092\r\n',
'1 38771U 12049A 18365.81382142 -.00000015 00000-0 13273-4 0 9991\r\n',
'2 38771 98.7294 62.2921 0002057 92.7653 26.0030 14.21477711326215\r\n'
]
expected = {
datetime.datetime(2018, 12, 20, 12, 0): None,
datetime.datetime(2018, 12, 28, 12, 0): 0,
datetime.datetime(2018, 12, 30, 16, 0): 2,
datetime.datetime(2018, 12, 30, 20, 0): 4,
datetime.datetime(2019, 1, 1, 12, 0): 6,
datetime.datetime(2019, 1, 8, 12, 0): None
}
read_tle_file.return_value = tle_data
for time, tle_idx in expected.items():
self.reader.utcs = np.array([time], dtype='datetime64[ms]')
self.reader.tle_lines = None
if tle_idx is None:
self.assertRaises(NoTLEData, self.reader.get_tle_lines)
else:
tle1, tle2 = self.reader.get_tle_lines()
self.assertEqual(tle1, tle_data[tle_idx])
self.assertEqual(tle2, tle_data[tle_idx + 1])
@mock.patch('pygac.reader.Reader.get_tle_lines')
def test_get_sat_angles_without_tle_at_nadir(self, get_tle_lines):
"""Test that the get satellite angles without tle at nadir."""
get_tle_lines.side_effect = NoTLEData('No TLE data available')
rng = np.random.RandomState(125)
self.reader.lons = rng.rand(100, 409) * 90
self.reader.lats = rng.rand(100, 409) * 90
self.reader.utcs = np.array([
numpy.datetime64(datetime.datetime(1980, 1, 3, 11, 47, 15, 469000))
for date in range(100)
])
sat_azi, sat_elev = self.reader.get_sat_angles()
self.assertEqual(np.sum(np.isnan(sat_elev)), 0)
np.testing.assert_allclose(sat_elev[:, 204], 90., atol=0.01)
@mock.patch('pygac.reader.Reader.get_tle_lines')
def test_get_sat_angles_without_tle(self, get_tle_lines):
"""Test the get satellite angles without tle."""
get_tle_lines.side_effect = NoTLEData('No TLE data available')
# Test data correspond to columns 0:2, 201:208 and 407:409. Extracted like this:
# self.lons[0:5, [0, 1, 201, 202, 203, 204, 205, 206, 207, -2, -1]]
self.reader.lons = np.array(
[[
69.41555135, 68.76815744, 28.04133742, 27.94671757,
27.85220562, 27.7578125, 27.66354783, 27.5694182, 27.47542957,
2.66416611, 2.39739436
],
[
69.41409536, 68.76979616, 28.00228658, 27.9076628, 27.8131467,
27.71875, 27.62448295, 27.53035209, 27.43636312, 2.61727408,
2.35049275
],
[
69.42987929, 68.78543423, 27.96407251, 27.86936406,
27.77457923, 27.6796875, 27.58467527, 27.48959853,
27.39453053, 2.5704025, 2.30362323
],
[
69.44430772, 68.80064104, 27.91910034, 27.82340242,
27.72794715, 27.6328125, 27.53805662, 27.44366144,
27.34959008, 2.53088093, 2.26729486
],
[
69.47408815, 68.8259859, 27.87666513, 27.78224611,
27.68795045, 27.59375, 27.49962326, 27.40557682, 27.31162435,
2.48359319, 2.21976689
]])
self.reader.lats = np.array(
[[
71.62830288, 71.67081539, 69.90976034, 69.89297223,
69.87616536, 69.859375, 69.84262997, 69.82593315, 69.80928089,
61.61334632, 61.466097
],
[
71.65222644, 71.69455292, 69.9331981, 69.91640991,
69.89960295, 69.8828125, 69.86606741, 69.84937054,
69.83271828, 61.62903602, 61.48182119
],
[
71.68324681, 71.7256586, 69.96444365, 69.94765637,
69.93085095, 69.9140625, 69.89731955, 69.8806245, 69.86397337,
61.65247459, 61.50526043
],
[
71.71489701, 71.75715746, 69.98789144, 69.97110185,
69.9542928, 69.9375, 69.92075278, 69.90405431, 69.88740114,
61.66489162, 61.51597801
],
[
71.7390608, 71.78108857, 70.01126173, 69.99449392,
69.97770882, 69.9609375, 69.9442054, 69.92751555, 69.91086544,
61.67769951, 61.52802445
]])
self.reader.utcs = np.array([
numpy.datetime64(datetime.datetime(1980, 1, 3, 11, 47, 15,
469000)),
numpy.datetime64(datetime.datetime(1980, 1, 3, 11, 47, 15,
969000)),
numpy.datetime64(datetime.datetime(1980, 1, 3, 11, 47, 16,
469000)),
numpy.datetime64(datetime.datetime(1980, 1, 3, 11, 47, 16,
969000)),
numpy.datetime64(datetime.datetime(1980, 1, 3, 11, 47, 17, 469000))
])
expected_sat_azi_0 = np.array([
283.09872924, 283.12775589, 283.13951497, 283.14786413,
283.19638805
])
expected_sat_azi_201 = np.array([
272.85051989, 273.79847634, 272.04794616, 273.01363377,
274.00055397
])
expected_sat_azi_408 = np.array(
[39.77021472, 39.71516966, 39.68104134, 39.60503726, 39.5403431])
expected_sat_elev_0 = np.array(
[20.94889204, 20.96041284, 20.96368521, 20.96826309, 20.95849212])
expected_sat_elev_204 = np.array(
[89.24533884, 89.22663677, 89.25079817, 89.24938043, 89.23004118])
sat_azi, sat_elev = self.reader.get_sat_angles()
np.testing.assert_allclose(sat_azi[:, 0], expected_sat_azi_0, atol=1.0)
np.testing.assert_allclose(sat_azi[:, 2],
expected_sat_azi_201,
atol=35.0) # Azi bad close to center!
np.testing.assert_allclose(sat_azi[:, -1],
expected_sat_azi_408,
atol=1.0)
np.testing.assert_allclose(sat_elev[:, 0],
expected_sat_elev_0,
atol=1.0)
np.testing.assert_allclose(sat_elev[:, 5],
expected_sat_elev_204,
atol=1.0)
@mock.patch('pygac.gac_reader.GACReader._get_corrupt_mask')
def test_get_angles(self, get_corrupt_mask):
"""Test get_angles function of the reader."""
# Line: 1, 649, 6198 and 12658 from Tiros-N file (1980-01-03 11:47)
lon_i = np.array([69.41555, 152.10587, 164.3131, 67.23855,
np.nan])[:, np.newaxis]
lat_i = np.array([71.6283, 85.24265, -62.076958, 82.72296,
np.nan])[:, np.newaxis]
get_corrupt_mask.return_value = np.isnan(lon_i)
self.reader.lons = lon_i
self.reader.lats = lat_i
self.reader.tle_lines = [
'1 11060U 78096A 80003.54792075 .00000937 00000-0 52481-3 0 2588\r\n', # noqa
'2 11060 98.9783 332.1605 0012789 88.8047 271.4583 14.11682873 63073\r\n'
] # noqa
self.reader.utcs = np.array([
315748035469, 315748359969, 315751135469, 315754371969,
315754371969
]).astype('datetime64[ms]')
self.reader.spacecrafts_orbital = {25: 'tiros n'}
self.reader.spacecraft_id = 25
expected_sat_azi = np.array([-76.90, 11.08, 145.33, -50.01,
np.nan])[:, np.newaxis]
expected_sun_azi = np.array([-120.36, -31.94, -173.51, -93.67,
np.nan])[:, np.newaxis]
expected_sat_zenith = np.array([69.05, 69.04, 69.55, 69.07,
np.nan])[:, np.newaxis]
expected_sun_zenith = np.array([104.30, 116.94, 94.86, 112.60,
np.nan])[:, np.newaxis]
expected_rel_azi = np.array([43.45, 43.01, 41.16, 43.65,
np.nan])[:, np.newaxis]
retv = self.reader.get_angles()
(sat_azi, sat_zenith, sun_azi, sun_zenith, rel_azi) = retv
np.testing.assert_allclose(sat_azi, expected_sat_azi, atol=0.01)
np.testing.assert_allclose(sun_azi, expected_sun_azi, atol=0.01)
np.testing.assert_allclose(sat_zenith, expected_sat_zenith, atol=0.01)
np.testing.assert_allclose(sun_zenith, expected_sun_zenith, atol=0.01)
np.testing.assert_allclose(rel_azi, expected_rel_azi, atol=0.01)
def test_get_tle_file(self):
"""Test get_tle_file."""
self.reader.tle_dir = '/tle/dir'
self.reader.tle_name = 'tle_%(satname)s.txt'
self.reader.spacecraft_name = 'ISS'
tle_file = self.reader.get_tle_file()
self.assertEqual(tle_file, '/tle/dir/tle_ISS.txt')
@mock.patch('pygac.gac_reader.GACReader.get_tsm_pixels')
def test_mask_tsm_pixels(self, get_tsm_pixels):
"""Test masking of pixels affected by the scan motor issue."""
get_tsm_pixels.return_value = ([0, 1], [0, 1])
channels = np.array([[[1., 2., 3.], [1., 2., 3.]],
[[1., 2., 3.],
[1., 2., 3.]]]) # (lines, pixels, channels)
masked_exp = np.array([[[np.nan, np.nan, np.nan], [1., 2., 3.]],
[[1., 2., 3.], [np.nan, np.nan, np.nan]]])
self.reader.mask_tsm_pixels(channels) # masks in-place
numpy.testing.assert_array_equal(channels, masked_exp)
def _get_scanline_numbers(self):
"""Create artificial scanline numbers with some corruptions.
Returns:
Corrupted and corrected scanline numbers.
"""
along_track = 12000
scans = np.zeros(12000, dtype=[("scan_line_number", ">u2")])
scans["scan_line_number"] = np.arange(1, along_track + 1)
# ... with 500 missing scanlines at scanline 8000
scans["scan_line_number"][8000:] += 500
corrected = scans["scan_line_number"].copy()
# ... and some spikes here and there
scans["scan_line_number"][3000] += 1E4
scans["scan_line_number"][9000] -= 1E4
corrected = np.delete(corrected, [3000, 9000])
return scans, corrected
def test_correct_scan_line_numbers(self):
"""Test scanline number correction."""
scans, expected = self._get_scanline_numbers()
self.reader.scans = scans
self.reader.correct_scan_line_numbers()
numpy.testing.assert_array_equal(self.reader.scans['scan_line_number'],
expected)
@mock.patch('pygac.gac_reader.GACReader.get_header_timestamp')
def test_correct_times_thresh(self, get_header_timestamp):
"""Test correction of scanline timestamps."""
header_time = datetime.datetime(2016, 8, 16, 16, 7, 36)
# Create artificial timestamps
_, scan_line_numbers = self._get_scanline_numbers()
t0 = np.array([header_time], dtype="datetime64[ms]").astype("i8")[0]
shift = 1000
msecs = t0 + shift + scan_line_numbers / GACReader.scan_freq
utcs_expected = msecs.copy().astype(">M8[ms]")
# Add some corruptions
msecs[3000:] += 1800 * 1000
msecs[1000] += 24 * 3600 * 1000
msecs[2000] -= 24 * 3600 * 1000
# Mock reader
get_header_timestamp.return_value = header_time
self.reader.utcs = msecs.astype(">M8[ms]")
self.reader.scans = np.array(scan_line_numbers,
dtype=[("scan_line_number", ">u2")])
# Test correction
self.reader.correct_times_thresh()
numpy.testing.assert_array_equal(self.reader.utcs, utcs_expected)
def test_calculate_sun_earth_distance_correction(self):
"""Test the calculate sun earth distance correction method."""
self.reader.utcs = np.array([
315748035469, 315748359969, 315751135469, 315754371969,
315754371969
]).astype('datetime64[ms]')
corr = self.reader.get_sun_earth_distance_correction()
numpy.testing.assert_almost_equal(corr, 0.96660494, decimal=7)
@mock.patch('pygac.reader.Reader.get_sun_earth_distance_correction')
@mock.patch('pygac.reader.Reader.get_midnight_scanline')
@mock.patch('pygac.reader.Reader.get_miss_lines')
@mock.patch('pygac.reader.Reader.calibration',
new_callable=mock.PropertyMock)
def test_update_metadata(self, calibration, get_miss_lines,
get_midnight_scanline,
get_sun_earth_distance_correction):
get_miss_lines.return_value = 'miss_lines'
get_midnight_scanline.return_value = 'midn_line'
get_sun_earth_distance_correction.return_value = 'factor'
self.reader.head = {'foo': 'bar'}
calibration.return_value = mock.MagicMock(version='version')
self.reader.update_meta_data()
mda_exp = {
'midnight_scanline': 'midn_line',
'missing_scanlines': 'miss_lines',
'sun_earth_distance_correction_factor': 'factor',
'gac_header': {
'foo': 'bar'
},
'calib_coeffs_version': 'version'
}
self.assertDictEqual(self.reader.meta_data, mda_exp)