def test_same_grid(self):
"""
Test the case when both datasets already have the same geospatial definition
"""
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])}).chunk(chunks={'lat': 2, 'lon': 4})
rm = RecordingMonitor()
ds_same = coregister(ds_fine, ds_fine, monitor=rm)
# Make sure it returned the input as opposed to going through with
# coregistration
self.assertEqual([], rm.records)
assert_almost_equal(ds_same['first'].values, ds_fine['first'].values)
# Test that a subset is performed, but no coregistration done
lat_slice = slice(-70, 70)
lon_slice = slice(-40, 40)
ds_subset = ds_fine.sel(lat=lat_slice, lon=lon_slice)
ds_coreg = coregister(ds_subset, ds_fine, monitor=rm)
self.assertEqual([], rm.records)
assert_almost_equal(ds_coreg['first'].values, ds_subset['first'].values)
def test_2D(self):
"""
Test a case where a 2D lat/lon dataset is resampled or used for
resampling
"""
# Master dataset is 2D
ds_fine = xr.Dataset({
'first': (['lat', 'lon'], np.eye(4, 8)),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8)}).chunk()
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])}).chunk(chunks={'lat': 3, 'lon': 3})
ds_coarse_resampled = coregister(ds_fine, ds_coarse)
slice_exp = np.array([[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0., 0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]])
exp_arr = np.zeros([2, 4, 8])
exp_arr[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'], exp_arr),
'second': (['time', 'lat', 'lon'], exp_arr),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
assert_almost_equal(ds_coarse_resampled['first'].values, expected['first'].values)
# replica dataset contains a 2D variable
ds_coarse = xr.Dataset({
'first': (['lat', 'lon'], np.eye(3, 6)),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])}).chunk(chunks={'lat': 3, 'lon': 3})
ds_coarse_resampled = coregister(ds_fine, ds_coarse)
assert_almost_equal(ds_coarse_resampled['first'].values, slice_exp)
def test_subset(self):
"""
Test coregistration being run on a subset
"""
ds_fine = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
})
ds_coarse = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
})
lat_slice = slice(-70, 70)
lon_slice = slice(-40, 40)
ds_coarse = ds_coarse.sel(lat=lat_slice, lon=lon_slice)
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
ds_coarse_resampled = coregister(ds_fine, ds_coarse)
assert_array_equal([-67.5, -22.5, 22.5, 67.5],
ds_coarse_resampled.lat.values)
assert_array_equal([-22.5, 22.5], ds_coarse_resampled.lon.values)
# Check if the geospatial attributes have been correctly set
self.assertEqual(ds_coarse_resampled.lat.values[0] - 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lat_min'])
self.assertEqual(ds_coarse_resampled.lat.values[-1] + 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lat_max'])
self.assertEqual(ds_coarse_resampled.lon.values[0] - 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lon_min'])
self.assertEqual(ds_coarse_resampled.lon.values[-1] + 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lon_max'])
self.assertEqual(
45.0, ds_coarse_resampled.attrs['geospatial_lat_resolution'])
self.assertEqual(
45.0, ds_coarse_resampled.attrs['geospatial_lon_resolution'])
def test_same_grid(self):
"""
Test the case when both datasets already have the same geospatial definition
"""
ds_fine = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 2,
'lon': 4
})
rm = RecordingMonitor()
ds_same = coregister(ds_fine, ds_fine, monitor=rm)
# Make sure it returned the input as opposed to going through with
# coregistration
self.assertEqual([], rm.records)
assert_almost_equal(ds_same['first'].values, ds_fine['first'].values)
# Test that a subset is performed, but no coregistration done
lat_slice = slice(-70, 70)
lon_slice = slice(-40, 40)
ds_subset = ds_fine.sel(lat=lat_slice, lon=lon_slice)
ds_coreg = coregister(ds_subset, ds_fine, monitor=rm)
self.assertEqual([], rm.records)
assert_almost_equal(ds_coreg['first'].values,
ds_subset['first'].values)
def test_subset(self):
"""
Test coregistration being run on a subset
"""
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])})
lat_slice = slice(-70, 70)
lon_slice = slice(-40, 40)
ds_coarse = ds_coarse.sel(lat=lat_slice, lon=lon_slice)
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
ds_coarse_resampled = coregister(ds_fine, ds_coarse)
assert_array_equal([-67.5, -22.5, 22.5, 67.5], ds_coarse_resampled.lat.values)
assert_array_equal([-22.5, 22.5],
ds_coarse_resampled.lon.values)
# Check if the geospatial attributes have been correctly set
self.assertEqual(ds_coarse_resampled.lat.values[0] - 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lat_min'])
self.assertEqual(ds_coarse_resampled.lat.values[-1] + 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lat_max'])
self.assertEqual(ds_coarse_resampled.lon.values[0] - 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lon_min'])
self.assertEqual(ds_coarse_resampled.lon.values[-1] + 45 * 0.5,
ds_coarse_resampled.attrs['geospatial_lon_max'])
self.assertEqual(45.0,
ds_coarse_resampled.attrs['geospatial_lat_resolution'])
self.assertEqual(45.0,
ds_coarse_resampled.attrs['geospatial_lon_resolution'])
def test_2D(self):
"""
Test a case where a 2D lat/lon dataset is resampled or used for
resampling
"""
# Master dataset is 2D
ds_fine = xr.Dataset({
'first': (['lat', 'lon'], np.eye(4, 8)),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8)
}).chunk()
ds_coarse = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 3,
'lon': 3
})
ds_coarse_resampled = coregister(ds_fine, ds_coarse)
slice_exp = np.array(
[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0., 0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]])
exp_arr = np.zeros([2, 4, 8])
exp_arr[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'], exp_arr),
'second': (['time', 'lat', 'lon'], exp_arr),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])
})
assert_almost_equal(ds_coarse_resampled['first'].values,
expected['first'].values)
# Slave dataset contains a 2D variable
ds_coarse = xr.Dataset({
'first': (['lat', 'lon'], np.eye(3, 6)),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 3,
'lon': 3
})
ds_coarse_resampled = coregister(ds_fine, ds_coarse)
assert_almost_equal(ds_coarse_resampled['first'].values, slice_exp)
def test_recursive(self):
"""
Test coregistration with more dimensions than lat/lon/time
"""
slice_fine = np.eye(4, 8)
slice_coarse = np.eye(3, 6)
ndarr_fine = np.zeros([2, 2, 2, 4, 8])
ndarr_coarse = np.zeros([2, 2, 2, 3, 6])
ndarr_fine[:] = slice_fine
ndarr_coarse[:] = slice_coarse
ds_fine = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine),
'second': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 2,
'lon': 4
})
ds_coarse = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_coarse),
'second': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_coarse),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2]),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2])
}).chunk(chunks={
'lat': 3,
'lon': 3
})
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
rm = RecordingMonitor()
ds_coarse_resampled = coregister(ds_fine, ds_coarse, monitor=rm)
self.assertEqual(
[('start', 'coregister dataset', 2),
('progress', 0.0, 'coregister dataarray', 0),
('progress', 0.0, 'coregister dataarray: resample slice', 0),
('progress', 0.03125, None, 2), ('progress', 0.03125, None, 3),
('progress', 0.03125, None, 5), ('progress', 0.03125, None, 6),
('progress', 0.0, 'coregister dataarray: resample slice', 6),
('progress', 0.0, 'coregister dataarray: resample slice', 6),
('progress', 0.03125, None, 8), ('progress', 0.03125, None, 9),
('progress', 0.03125, None, 11), ('progress', 0.03125, None, 13),
('progress', 0.0, 'coregister dataarray: resample slice', 13),
('progress', 0.0, 'coregister dataarray: resample slice', 13),
('progress', 0.03125, None, 14), ('progress', 0.03125, None, 16),
('progress', 0.03125, None, 17), ('progress', 0.03125, None, 19),
('progress', 0.0, 'coregister dataarray: resample slice', 19),
('progress', 0.0, 'coregister dataarray: resample slice', 19),
('progress', 0.03125, None, 20), ('progress', 0.03125, None, 22),
('progress', 0.03125, None, 23), ('progress', 0.03125, None, 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.03125, None, 27), ('progress', 0.03125, None, 28),
('progress', 0.03125, None, 30), ('progress', 0.03125, None, 31),
('progress', 0.0, 'coregister dataarray: resample slice', 31),
('progress', 0.0, 'coregister dataarray: resample slice', 31),
('progress', 0.03125, None, 33), ('progress', 0.03125, None, 34),
('progress', 0.03125, None, 36), ('progress', 0.03125, None, 38),
('progress', 0.0, 'coregister dataarray: resample slice', 38),
('progress', 0.0, 'coregister dataarray: resample slice', 38),
('progress', 0.03125, None, 39), ('progress', 0.03125, None, 41),
('progress', 0.03125, None, 42), ('progress', 0.03125, None, 44),
('progress', 0.0, 'coregister dataarray: resample slice', 44),
('progress', 0.0, 'coregister dataarray: resample slice', 44),
('progress', 0.03125, None, 45), ('progress', 0.03125, None, 47),
('progress', 0.03125, None, 48), ('progress', 0.03125, None, 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.03125, None, 52), ('progress', 0.03125, None, 53),
('progress', 0.03125, None, 55), ('progress', 0.03125, None, 56),
('progress', 0.0, 'coregister dataarray: resample slice', 56),
('progress', 0.0, 'coregister dataarray: resample slice', 56),
('progress', 0.03125, None, 58), ('progress', 0.03125, None, 59),
('progress', 0.03125, None, 61), ('progress', 0.03125, None, 63),
('progress', 0.0, 'coregister dataarray: resample slice', 63),
('progress', 0.0, 'coregister dataarray: resample slice', 63),
('progress', 0.03125, None, 64), ('progress', 0.03125, None, 66),
('progress', 0.03125, None, 67), ('progress', 0.03125, None, 69),
('progress', 0.0, 'coregister dataarray: resample slice', 69),
('progress', 0.0, 'coregister dataarray: resample slice', 69),
('progress', 0.03125, None, 70), ('progress', 0.03125, None, 72),
('progress', 0.03125, None, 73), ('progress', 0.03125, None, 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.03125, None, 77), ('progress', 0.03125, None, 78),
('progress', 0.03125, None, 80), ('progress', 0.03125, None, 81),
('progress', 0.0, 'coregister dataarray: resample slice', 81),
('progress', 0.0, 'coregister dataarray: resample slice', 81),
('progress', 0.03125, None, 83), ('progress', 0.03125, None, 84),
('progress', 0.03125, None, 86), ('progress', 0.03125, None, 88),
('progress', 0.0, 'coregister dataarray: resample slice', 88),
('progress', 0.0, 'coregister dataarray: resample slice', 88),
('progress', 0.03125, None, 89), ('progress', 0.03125, None, 91),
('progress', 0.03125, None, 92), ('progress', 0.03125, None, 94),
('progress', 0.0, 'coregister dataarray: resample slice', 94),
('progress', 0.0, 'coregister dataarray: resample slice', 94),
('progress', 0.03125, None, 95), ('progress', 0.03125, None, 97),
('progress', 0.03125, None, 98), ('progress', 0.03125, None, 100),
('progress', 0.0, 'coregister dataarray: resample slice', 100),
('progress', 0.0, 'coregister dataarray', 100),
('done', )], rm.records)
slice_exp = np.array(
[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0., 0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]])
ndarr_fine_exp = np.zeros([2, 2, 2, 4, 8])
ndarr_fine_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_fine_exp),
'second': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_fine_exp),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_coarse_resampled['first'].values,
expected['first'].values)
# Test that the fine dataset has been resampled (aggregated)
# onto the grid of the coarse dataset.
ds_fine_resampled = coregister(ds_coarse, ds_fine)
slice_exp = np.array([[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]])
ndarr_coarse_exp = np.zeros([2, 2, 2, 3, 6])
ndarr_coarse_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_coarse_exp),
'second': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_coarse_exp),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_fine_resampled['first'].values,
expected['first'].values)
def test_error(self):
"""
Test error conditions
"""
# Test unexpected global bounds
ds_fine = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'lat':
np.linspace(67.5, 135, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
})
ds_coarse = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('(67.5, 135.0)', str(err.exception))
# Test non-equidistant dataset
ds_fine = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'lat': [-67.5, -20, 20, 67.5],
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
})
ds_coarse = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('not equidistant', str(err.exception))
# Test non-pixel registered dataset
ds_fine = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
})
ds_coarse_err = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'second': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'lat':
np.linspace(-90, 90, 5),
'lon':
np.linspace(-162, 162, 10),
'time':
np.array([1, 2])
})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse_err)
self.assertIn('not pixel-registered', str(err.exception))
ds_coarse_err = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'second': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'lat':
np.linspace(-72, 72, 5),
'lon':
np.linspace(-180, 180, 10),
'time':
np.array([1, 2])
})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse_err)
self.assertIn('not pixel-registered', str(err.exception))
# Test unexpected dimensionality
ds_fine = xr.Dataset({
'first': (['lat', 'longertude'], np.eye(4, 8)),
'second': (['lat', 'longertude'], np.eye(4, 8)),
'lat': np.linspace(-67.5, 67.5, 4),
'longertude': np.linspace(-157.5, 157.5, 8)
})
ds_coarse = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('longertude', str(err.exception))
ds_fine = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
})
ds_coarse = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'second': (['time', 'lon'], np.eye(2, 6)),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('select_var', str(err.exception))
def test_nominal(self):
"""
Test nominal execution
"""
ds_fine = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(4, 8)])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 2,
'lon': 4
})
ds_coarse = xr.Dataset({
'first': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 3,
'lon': 3
})
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
rm = RecordingMonitor()
ds_coarse_resampled = coregister(ds_fine, ds_coarse, monitor=rm)
self.assertEqual(
[('start', 'coregister dataset', 2),
('progress', 0.0, 'coregister dataarray', 0),
('progress', 0.0, 'coregister dataarray: resample slice', 0),
('progress', 0.125, None, 6), ('progress', 0.125, None, 13),
('progress', 0.125, None, 19), ('progress', 0.125, None, 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.125, None, 31), ('progress', 0.125, None, 38),
('progress', 0.125, None, 44), ('progress', 0.125, None, 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.125, None, 56), ('progress', 0.125, None, 63),
('progress', 0.125, None, 69), ('progress', 0.125, None, 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.125, None, 81), ('progress', 0.125, None, 88),
('progress', 0.125, None, 94), ('progress', 0.125, None, 100),
('progress', 0.0, 'coregister dataarray: resample slice', 100),
('progress', 0.0, 'coregister dataarray', 100),
('done', )], rm.records)
expected = xr.Dataset({
'first':
(['time', 'lat', 'lon'],
np.array(
[[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[
0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0.,
0., 0.
], [0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0.,
0.]],
[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[
0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0.,
0., 0.
], [0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0.,
0.]]])),
'second':
(['time', 'lat', 'lon'],
np.array(
[[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[
0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0.,
0., 0.
], [0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0.,
0.]],
[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[
0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0.,
0., 0.
], [0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0.,
0.]]])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_coarse_resampled['first'].values,
expected['first'].values)
# Test that the fine dataset has been resampled (aggregated)
# onto the grid of the coarse dataset.
ds_fine_resampled = coregister(ds_coarse, ds_fine)
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'],
np.array([[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]],
[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]]])),
'second': (['time', 'lat', 'lon'],
np.array([[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]],
[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]]])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_fine_resampled['first'].values,
expected['first'].values)
def test_int_array(self):
"""
Test coregistration on integer arrays
"""
ds_fine = xr.Dataset({
'first':
(['time', 'lat',
'lon'], np.array([np.eye(4, 8), np.eye(4, 8)], dtype='int32')),
'second': (['time', 'lat',
'lon'], np.array([np.eye(4, 8),
np.eye(
4,
8,
)])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 2,
'lon': 4
})
ds_coarse = xr.Dataset({
'first':
(['time', 'lat',
'lon'], np.array([np.eye(3, 6), np.eye(3, 6)], dtype='int32')),
'second': (['time', 'lat',
'lon'], np.array([np.eye(3, 6),
np.eye(3, 6)])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 3,
'lon': 3
})
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
ds_coarse_resampled = coregister(ds_fine,
ds_coarse,
method_us='nearest')
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'],
np.array([[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]],
[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]]])),
'second': (['time', 'lat', 'lon'],
np.array([[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]],
[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]]])),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_coarse_resampled['first'].values,
expected['first'].values)
# Test that the fine dataset has been resampled (aggregated)
# onto the grid of the coarse dataset.
ds_fine_resampled = coregister(ds_coarse, ds_fine, method_ds='mode')
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'],
np.array([[[1, 0, 0, 0, 0, 0], [0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]],
[[1, 0, 0, 0, 0, 0], [0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]]])),
'second': (['time', 'lat', 'lon'],
np.array([[[1, 0, 0, 0, 0, 0], [0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]],
[[1, 0, 0, 0, 0, 0], [0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]]])),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_fine_resampled['first'].values,
expected['first'].values)
def test_recursive(self):
"""
Test coregistration with more dimensions than lat/lon/time
"""
slice_fine = np.eye(4, 8)
slice_coarse = np.eye(3, 6)
ndarr_fine = np.zeros([2, 2, 2, 4, 8])
ndarr_coarse = np.zeros([2, 2, 2, 3, 6])
ndarr_fine_l1 = np.zeros([2, 2, 4, 8])
ndarr_coarse_l1 = np.zeros([2, 2, 3, 6])
ndarr_fine_l2 = np.zeros([2, 2, 4, 8])
ndarr_coarse_l2 = np.zeros([2, 2, 3, 6])
ndarr_fine[:] = slice_fine
ndarr_coarse[:] = slice_coarse
ndarr_fine_l1[:] = slice_fine
ndarr_coarse_l1[:] = slice_coarse
ndarr_fine_l2[:] = slice_fine
ndarr_coarse_l2[:] = slice_coarse
ds_fine = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine),
'second': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 2,
'lon': 4
})
ds_coarse = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_coarse),
'second': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_coarse),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2]),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2])
}).chunk(chunks={
'lat': 3,
'lon': 3
})
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
rm = RecordingMonitor()
ds_coarse_resampled = coregister(ds_fine, ds_coarse, monitor=rm)
self.assertGreaterEqual(len(rm.records), 3)
self.assertIn('start', rm.records[0])
self.assertIn('done', rm.records[-1])
self.assertIn('progress', rm.records[1])
slice_exp = np.array(
[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0., 0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]])
ndarr_fine_exp = np.zeros([2, 2, 2, 4, 8])
ndarr_fine_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_fine_exp),
'second': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_fine_exp),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_coarse_resampled['first'].values,
expected['first'].values)
# Test that the fine dataset has been resampled (aggregated)
# onto the grid of the coarse dataset.
ds_fine_resampled = coregister(ds_coarse, ds_fine)
slice_exp = np.array([[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]])
ndarr_coarse_exp = np.zeros([2, 2, 2, 3, 6])
ndarr_coarse_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_coarse_exp),
'second': (['time', 'layer', 'layer2', 'lat',
'lon'], ndarr_coarse_exp),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_fine_resampled['first'].values,
expected['first'].values)
# Test that coregistering with data arrays with less than all possible
# dimensions works
ds_fine = xr.Dataset({
'first': (['time', 'layer', 'lat', 'lon'], ndarr_fine_l1),
'second': (['time', 'layer2', 'lat', 'lon'], ndarr_fine_l2),
'lat':
np.linspace(-67.5, 67.5, 4),
'lon':
np.linspace(-157.5, 157.5, 8),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
}).chunk(chunks={
'lat': 2,
'lon': 4
})
ds_coarse = xr.Dataset({
'first': (['time', 'layer', 'lat', 'lon'], ndarr_coarse_l1),
'second': (['time', 'layer2', 'lat', 'lon'], ndarr_coarse_l2),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'time':
np.array([1, 2]),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2])
}).chunk(chunks={
'lat': 3,
'lon': 3
})
ds_fine_resampled = coregister(ds_coarse, ds_fine)
ndarr_coarse_exp = np.zeros([2, 2, 3, 6])
ndarr_coarse_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'lat', 'lon'], ndarr_coarse_exp),
'second': (['time', 'layer2', 'lat', 'lon'], ndarr_coarse_exp),
'lat':
np.linspace(-60, 60, 3),
'lon':
np.linspace(-150, 150, 6),
'layer':
np.array([1, 2]),
'layer2':
np.array([1, 2]),
'time':
np.array([1, 2])
})
assert_almost_equal(ds_fine_resampled['first'].values,
expected['first'].values)
def test_int_array(self):
"""
Test coregistration on integer arrays
"""
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)], dtype='int32')),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8,)])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])}).chunk(chunks={'lat': 2, 'lon': 4})
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)], dtype='int32')),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])}).chunk(chunks={'lat': 3, 'lon': 3})
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
ds_coarse_resampled = coregister(ds_fine, ds_coarse, method_us='nearest')
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]],
[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]]])),
'second': (['time', 'lat', 'lon'], np.array([[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]],
[[1, 1, 0, 0, 0, 0, 0, 0],
[1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0, 0]]])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
assert_almost_equal(ds_coarse_resampled['first'].values, expected['first'].values)
# Test that the fine dataset has been resampled (aggregated)
# onto the grid of the coarse dataset.
ds_fine_resampled = coregister(ds_coarse, ds_fine, method_ds='mode')
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([[[1, 0, 0, 0, 0, 0],
[0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]],
[[1, 0, 0, 0, 0, 0],
[0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]]])),
'second': (['time', 'lat', 'lon'], np.array([[[1, 0, 0, 0, 0, 0],
[0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]],
[[1, 0, 0, 0, 0, 0],
[0, 1, 0, 0, 0, 0],
[0, 0, 1, 0, 0, 0]]])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])})
assert_almost_equal(ds_fine_resampled['first'].values, expected['first'].values)
def test_recursive(self):
"""
Test coregistration with more dimensions than lat/lon/time
"""
slice_fine = np.eye(4, 8)
slice_coarse = np.eye(3, 6)
ndarr_fine = np.zeros([2, 2, 2, 4, 8])
ndarr_coarse = np.zeros([2, 2, 2, 3, 6])
ndarr_fine_l1 = np.zeros([2, 2, 4, 8])
ndarr_coarse_l1 = np.zeros([2, 2, 3, 6])
ndarr_fine_l2 = np.zeros([2, 2, 4, 8])
ndarr_coarse_l2 = np.zeros([2, 2, 3, 6])
ndarr_fine[:] = slice_fine
ndarr_coarse[:] = slice_coarse
ndarr_fine_l1[:] = slice_fine
ndarr_coarse_l1[:] = slice_coarse
ndarr_fine_l2[:] = slice_fine
ndarr_coarse_l2[:] = slice_coarse
ds_fine = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine),
'second': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'layer': np.array([1, 2]),
'layer2': np.array([1, 2]),
'time': np.array([1, 2])}).chunk(chunks={'lat': 2, 'lon': 4})
ds_coarse = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_coarse),
'second': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_coarse),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2]),
'layer': np.array([1, 2]),
'layer2': np.array([1, 2])}).chunk(chunks={'lat': 3, 'lon': 3})
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
rm = RecordingMonitor()
ds_coarse_resampled = coregister(ds_fine, ds_coarse, monitor=rm)
self.assertEqual([('start', 'coregister dataset', 2),
('progress', 0.0, 'coregister dataarray', 0),
('progress', 0.0, 'coregister dataarray: resample slice', 0),
('progress', 0.03125, None, 2),
('progress', 0.03125, None, 3),
('progress', 0.03125, None, 5),
('progress', 0.03125, None, 6),
('progress', 0.0, 'coregister dataarray: resample slice', 6),
('progress', 0.0, 'coregister dataarray: resample slice', 6),
('progress', 0.03125, None, 8),
('progress', 0.03125, None, 9),
('progress', 0.03125, None, 11),
('progress', 0.03125, None, 13),
('progress', 0.0, 'coregister dataarray: resample slice', 13),
('progress', 0.0, 'coregister dataarray: resample slice', 13),
('progress', 0.03125, None, 14),
('progress', 0.03125, None, 16),
('progress', 0.03125, None, 17),
('progress', 0.03125, None, 19),
('progress', 0.0, 'coregister dataarray: resample slice', 19),
('progress', 0.0, 'coregister dataarray: resample slice', 19),
('progress', 0.03125, None, 20),
('progress', 0.03125, None, 22),
('progress', 0.03125, None, 23),
('progress', 0.03125, None, 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.03125, None, 27),
('progress', 0.03125, None, 28),
('progress', 0.03125, None, 30),
('progress', 0.03125, None, 31),
('progress', 0.0, 'coregister dataarray: resample slice', 31),
('progress', 0.0, 'coregister dataarray: resample slice', 31),
('progress', 0.03125, None, 33),
('progress', 0.03125, None, 34),
('progress', 0.03125, None, 36),
('progress', 0.03125, None, 38),
('progress', 0.0, 'coregister dataarray: resample slice', 38),
('progress', 0.0, 'coregister dataarray: resample slice', 38),
('progress', 0.03125, None, 39),
('progress', 0.03125, None, 41),
('progress', 0.03125, None, 42),
('progress', 0.03125, None, 44),
('progress', 0.0, 'coregister dataarray: resample slice', 44),
('progress', 0.0, 'coregister dataarray: resample slice', 44),
('progress', 0.03125, None, 45),
('progress', 0.03125, None, 47),
('progress', 0.03125, None, 48),
('progress', 0.03125, None, 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.03125, None, 52),
('progress', 0.03125, None, 53),
('progress', 0.03125, None, 55),
('progress', 0.03125, None, 56),
('progress', 0.0, 'coregister dataarray: resample slice', 56),
('progress', 0.0, 'coregister dataarray: resample slice', 56),
('progress', 0.03125, None, 58),
('progress', 0.03125, None, 59),
('progress', 0.03125, None, 61),
('progress', 0.03125, None, 63),
('progress', 0.0, 'coregister dataarray: resample slice', 63),
('progress', 0.0, 'coregister dataarray: resample slice', 63),
('progress', 0.03125, None, 64),
('progress', 0.03125, None, 66),
('progress', 0.03125, None, 67),
('progress', 0.03125, None, 69),
('progress', 0.0, 'coregister dataarray: resample slice', 69),
('progress', 0.0, 'coregister dataarray: resample slice', 69),
('progress', 0.03125, None, 70),
('progress', 0.03125, None, 72),
('progress', 0.03125, None, 73),
('progress', 0.03125, None, 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.03125, None, 77),
('progress', 0.03125, None, 78),
('progress', 0.03125, None, 80),
('progress', 0.03125, None, 81),
('progress', 0.0, 'coregister dataarray: resample slice', 81),
('progress', 0.0, 'coregister dataarray: resample slice', 81),
('progress', 0.03125, None, 83),
('progress', 0.03125, None, 84),
('progress', 0.03125, None, 86),
('progress', 0.03125, None, 88),
('progress', 0.0, 'coregister dataarray: resample slice', 88),
('progress', 0.0, 'coregister dataarray: resample slice', 88),
('progress', 0.03125, None, 89),
('progress', 0.03125, None, 91),
('progress', 0.03125, None, 92),
('progress', 0.03125, None, 94),
('progress', 0.0, 'coregister dataarray: resample slice', 94),
('progress', 0.0, 'coregister dataarray: resample slice', 94),
('progress', 0.03125, None, 95),
('progress', 0.03125, None, 97),
('progress', 0.03125, None, 98),
('progress', 0.03125, None, 100),
('progress', 0.0, 'coregister dataarray: resample slice', 100),
('progress', 0.0, 'coregister dataarray', 100),
('done',)], rm.records)
slice_exp = np.array([[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0., 0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]])
ndarr_fine_exp = np.zeros([2, 2, 2, 4, 8])
ndarr_fine_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine_exp),
'second': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_fine_exp),
'layer': np.array([1, 2]),
'layer2': np.array([1, 2]),
'time': np.array([1, 2])})
assert_almost_equal(ds_coarse_resampled['first'].values, expected['first'].values)
# Test that the fine dataset has been resampled (aggregated)
# onto the grid of the coarse dataset.
ds_fine_resampled = coregister(ds_coarse, ds_fine)
slice_exp = np.array([[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]])
ndarr_coarse_exp = np.zeros([2, 2, 2, 3, 6])
ndarr_coarse_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_coarse_exp),
'second': (['time', 'layer', 'layer2', 'lat', 'lon'], ndarr_coarse_exp),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'layer': np.array([1, 2]),
'layer2': np.array([1, 2]),
'time': np.array([1, 2])})
assert_almost_equal(ds_fine_resampled['first'].values, expected['first'].values)
# Test that coregistering with data arrays with less than all possible
# dimensions works
ds_fine = xr.Dataset({
'first': (['time', 'layer', 'lat', 'lon'], ndarr_fine_l1),
'second': (['time', 'layer2', 'lat', 'lon'], ndarr_fine_l2),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'layer': np.array([1, 2]),
'layer2': np.array([1, 2]),
'time': np.array([1, 2])}).chunk(chunks={'lat': 2, 'lon': 4})
ds_coarse = xr.Dataset({
'first': (['time', 'layer', 'lat', 'lon'], ndarr_coarse_l1),
'second': (['time', 'layer2', 'lat', 'lon'], ndarr_coarse_l2),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2]),
'layer': np.array([1, 2]),
'layer2': np.array([1, 2])}).chunk(chunks={'lat': 3, 'lon': 3})
ds_fine_resampled = coregister(ds_coarse, ds_fine)
ndarr_coarse_exp = np.zeros([2, 2, 3, 6])
ndarr_coarse_exp[:] = slice_exp
expected = xr.Dataset({
'first': (['time', 'layer', 'lat', 'lon'], ndarr_coarse_exp),
'second': (['time', 'layer2', 'lat', 'lon'], ndarr_coarse_exp),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'layer': np.array([1, 2]),
'layer2': np.array([1, 2]),
'time': np.array([1, 2])})
assert_almost_equal(ds_fine_resampled['first'].values, expected['first'].values)
def test_nominal(self):
"""
Test nominal execution
"""
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])}).chunk(chunks={'lat': 2, 'lon': 4})
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])}).chunk(chunks={'lat': 3, 'lon': 3})
# Test that the coarse dataset has been resampled onto the grid
# of the finer dataset.
rm = RecordingMonitor()
ds_coarse_resampled = coregister(ds_fine, ds_coarse, monitor=rm)
self.assertEqual([('start', 'coregister dataset', 2),
('progress', 0.0, 'coregister dataarray', 0),
('progress', 0.0, 'coregister dataarray: resample slice', 0),
('progress', 0.125, None, 6),
('progress', 0.125, None, 13),
('progress', 0.125, None, 19),
('progress', 0.125, None, 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.0, 'coregister dataarray: resample slice', 25),
('progress', 0.125, None, 31),
('progress', 0.125, None, 38),
('progress', 0.125, None, 44),
('progress', 0.125, None, 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray', 50),
('progress', 0.0, 'coregister dataarray: resample slice', 50),
('progress', 0.125, None, 56),
('progress', 0.125, None, 63),
('progress', 0.125, None, 69),
('progress', 0.125, None, 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.0, 'coregister dataarray: resample slice', 75),
('progress', 0.125, None, 81),
('progress', 0.125, None, 88),
('progress', 0.125, None, 94),
('progress', 0.125, None, 100),
('progress', 0.0, 'coregister dataarray: resample slice', 100),
('progress', 0.0, 'coregister dataarray', 100),
('done',)], rm.records)
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0.,
0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]],
[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0.,
0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]]])),
'second': (['time', 'lat', 'lon'], np.array([[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0.,
0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]],
[[1., 0.28571429, 0., 0., 0., 0., 0., 0.],
[0.33333333, 0.57142857, 0.38095238, 0., 0., 0., 0., 0.],
[0., 0.47619048, 0.52380952, 0.28571429, 0.04761905, 0., 0.,
0.],
[0., 0., 0.42857143, 0.85714286, 0.14285714, 0., 0., 0.]]])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
assert_almost_equal(ds_coarse_resampled['first'].values, expected['first'].values)
# Test that the fine dataset has been resampled (aggregated)
# onto the grid of the coarse dataset.
ds_fine_resampled = coregister(ds_coarse, ds_fine)
expected = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]],
[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]]])),
'second': (['time', 'lat', 'lon'], np.array([[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]],
[[0.625, 0.125, 0., 0., 0., 0.],
[0.125, 0.5, 0.125, 0., 0., 0.],
[0., 0.125, 0.625, 0., 0., 0.]]])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])})
assert_almost_equal(ds_fine_resampled['first'].values, expected['first'].values)
def test_error(self):
"""
Test error conditions
"""
# Test unexpected global bounds
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'lat': np.linspace(67.5, 135, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('(67.5, 135.0)', str(err.exception))
# Test non-equidistant dataset
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'lat': [-67.5, -20, 20, 67.5],
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('not equidistant', str(err.exception))
# Test non-pixel registered dataset
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
ds_coarse_err = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'second': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'lat': np.linspace(-90, 90, 5),
'lon': np.linspace(-162, 162, 10),
'time': np.array([1, 2])})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse_err)
self.assertIn('not pixel-registered', str(err.exception))
ds_coarse_err = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'second': (['time', 'lat', 'lon'], np.zeros([2, 5, 10])),
'lat': np.linspace(-72, 72, 5),
'lon': np.linspace(-180, 180, 10),
'time': np.array([1, 2])})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse_err)
self.assertIn('not pixel-registered', str(err.exception))
# Test unexpected dimensionality
ds_fine = xr.Dataset({
'first': (['lat', 'longertude'], np.eye(4, 8)),
'second': (['lat', 'longertude'], np.eye(4, 8)),
'lat': np.linspace(-67.5, 67.5, 4),
'longertude': np.linspace(-157.5, 157.5, 8)})
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('longertude', str(err.exception))
ds_fine = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'second': (['time', 'lat', 'lon'], np.array([np.eye(4, 8), np.eye(4, 8)])),
'lat': np.linspace(-67.5, 67.5, 4),
'lon': np.linspace(-157.5, 157.5, 8),
'time': np.array([1, 2])})
ds_coarse = xr.Dataset({
'first': (['time', 'lat', 'lon'], np.array([np.eye(3, 6), np.eye(3, 6)])),
'second': (['time', 'lon'], np.eye(2, 6)),
'lat': np.linspace(-60, 60, 3),
'lon': np.linspace(-150, 150, 6),
'time': np.array([1, 2])})
with self.assertRaises(ValueError) as err:
coregister(ds_fine, ds_coarse)
self.assertIn('select_var', str(err.exception))