def collapsed(cube: Cube, *args: Any, **kwargs: Any) -> Cube:
"""Collapses the cube with given arguments.
The cell methods of the output cube will match the cell methods
from the input cube. Any cell methods generated by the iris
collapsed method will not be retained.
Args:
cube:
A Cube to be collapsed.
Returns:
A collapsed cube where the cell methods match the input cube.
"""
original_methods = cube.cell_methods
new_cube = cube.collapsed(*args, **kwargs)
new_cube.cell_methods = original_methods
# demote escalated datatypes as required
if new_cube.dtype in FLOAT_TYPES:
new_cube.data = new_cube.data.astype(FLOAT_DTYPE)
collapsed_coords = args[0] if isinstance(args[0], list) else [args[0]]
for coord in collapsed_coords:
if new_cube.coord(coord).points.dtype in FLOAT_TYPES:
new_cube.coord(coord).points = new_cube.coord(coord).points.astype(
FLOAT_DTYPE)
if new_cube.coord(coord).bounds is not None:
new_cube.coord(coord).bounds = new_cube.coord(
coord).bounds.astype(FLOAT_DTYPE)
return new_cube
class Test_collapsed__warning(tests.IrisTest):
def setUp(self):
self.cube = Cube([[1, 2], [1, 2]])
lat = DimCoord([1, 2], standard_name='latitude')
lon = DimCoord([1, 2], standard_name='longitude')
grid_lat = AuxCoord([1, 2], standard_name='grid_latitude')
grid_lon = AuxCoord([1, 2], standard_name='grid_longitude')
wibble = AuxCoord([1, 2], long_name='wibble')
self.cube.add_dim_coord(lat, 0)
self.cube.add_dim_coord(lon, 1)
self.cube.add_aux_coord(grid_lat, 0)
self.cube.add_aux_coord(grid_lon, 1)
self.cube.add_aux_coord(wibble, 1)
def _aggregator(self, uses_weighting):
# Returns a mock aggregator with a mocked method (uses_weighting)
# which returns the given True/False condition.
aggregator = mock.Mock(spec=WeightedAggregator)
aggregator.cell_method = None
aggregator.uses_weighting = mock.Mock(return_value=uses_weighting)
return aggregator
def _assert_warn_collapse_without_weight(self, coords, warn):
# Ensure that warning is raised.
msg = "Collapsing spatial coordinate {!r} without weighting"
for coord in coords:
self.assertIn(mock.call(msg.format(coord)), warn.call_args_list)
def _assert_nowarn_collapse_without_weight(self, coords, warn):
# Ensure that warning is not rised.
msg = "Collapsing spatial coordinate {!r} without weighting"
for coord in coords:
self.assertNotIn(mock.call(msg.format(coord)), warn.call_args_list)
def test_lat_lon_noweighted_aggregator(self):
# Collapse latitude coordinate with unweighted aggregator.
aggregator = mock.Mock(spec=Aggregator)
aggregator.cell_method = None
coords = ['latitude', 'longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator, somekeyword='bla')
self._assert_nowarn_collapse_without_weight(coords, warn)
def test_lat_lon_weighted_aggregator(self):
# Collapse latitude coordinate with weighted aggregator without
# providing weights.
aggregator = self._aggregator(False)
coords = ['latitude', 'longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator)
coords = filter(lambda coord: 'latitude' in coord, coords)
self._assert_warn_collapse_without_weight(coords, warn)
def test_lat_lon_weighted_aggregator_with_weights(self):
# Collapse latitude coordinate with a weighted aggregators and
# providing suitable weights.
weights = np.array([[0.1, 0.5], [0.3, 0.2]])
aggregator = self._aggregator(True)
coords = ['latitude', 'longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator, weights=weights)
self._assert_nowarn_collapse_without_weight(coords, warn)
def test_lat_lon_weighted_aggregator_alt(self):
# Collapse grid_latitude coordinate with weighted aggregator without
# providing weights. Tests coordinate matching logic.
aggregator = self._aggregator(False)
coords = ['grid_latitude', 'grid_longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator)
coords = filter(lambda coord: 'latitude' in coord, coords)
self._assert_warn_collapse_without_weight(coords, warn)
def test_no_lat_weighted_aggregator_mixed(self):
# Collapse grid_latitude and an unmatched coordinate (not lat/lon)
# with weighted aggregator without providing weights.
# Tests coordinate matching logic.
aggregator = self._aggregator(False)
coords = ['wibble']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator)
self._assert_nowarn_collapse_without_weight(coords, warn)
class Test_collapsed__warning(tests.IrisTest):
def setUp(self):
self.cube = Cube([[1, 2], [1, 2]])
lat = DimCoord([1, 2], standard_name='latitude')
lon = DimCoord([1, 2], standard_name='longitude')
grid_lat = AuxCoord([1, 2], standard_name='grid_latitude')
grid_lon = AuxCoord([1, 2], standard_name='grid_longitude')
wibble = AuxCoord([1, 2], long_name='wibble')
self.cube.add_dim_coord(lat, 0)
self.cube.add_dim_coord(lon, 1)
self.cube.add_aux_coord(grid_lat, 0)
self.cube.add_aux_coord(grid_lon, 1)
self.cube.add_aux_coord(wibble, 1)
def _aggregator(self, uses_weighting):
# Returns a mock aggregator with a mocked method (uses_weighting)
# which returns the given True/False condition.
aggregator = mock.Mock(spec=WeightedAggregator, lazy_func=None)
aggregator.cell_method = None
aggregator.uses_weighting = mock.Mock(return_value=uses_weighting)
return aggregator
def _assert_warn_collapse_without_weight(self, coords, warn):
# Ensure that warning is raised.
msg = "Collapsing spatial coordinate {!r} without weighting"
for coord in coords:
self.assertIn(mock.call(msg.format(coord)), warn.call_args_list)
def _assert_nowarn_collapse_without_weight(self, coords, warn):
# Ensure that warning is not rised.
msg = "Collapsing spatial coordinate {!r} without weighting"
for coord in coords:
self.assertNotIn(mock.call(msg.format(coord)), warn.call_args_list)
def test_lat_lon_noweighted_aggregator(self):
# Collapse latitude coordinate with unweighted aggregator.
aggregator = mock.Mock(spec=Aggregator, lazy_func=None)
aggregator.cell_method = None
coords = ['latitude', 'longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator, somekeyword='bla')
self._assert_nowarn_collapse_without_weight(coords, warn)
def test_lat_lon_weighted_aggregator(self):
# Collapse latitude coordinate with weighted aggregator without
# providing weights.
aggregator = self._aggregator(False)
coords = ['latitude', 'longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator)
coords = filter(lambda coord: 'latitude' in coord, coords)
self._assert_warn_collapse_without_weight(coords, warn)
def test_lat_lon_weighted_aggregator_with_weights(self):
# Collapse latitude coordinate with a weighted aggregators and
# providing suitable weights.
weights = np.array([[0.1, 0.5], [0.3, 0.2]])
aggregator = self._aggregator(True)
coords = ['latitude', 'longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator, weights=weights)
self._assert_nowarn_collapse_without_weight(coords, warn)
def test_lat_lon_weighted_aggregator_alt(self):
# Collapse grid_latitude coordinate with weighted aggregator without
# providing weights. Tests coordinate matching logic.
aggregator = self._aggregator(False)
coords = ['grid_latitude', 'grid_longitude']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator)
coords = filter(lambda coord: 'latitude' in coord, coords)
self._assert_warn_collapse_without_weight(coords, warn)
def test_no_lat_weighted_aggregator_mixed(self):
# Collapse grid_latitude and an unmatched coordinate (not lat/lon)
# with weighted aggregator without providing weights.
# Tests coordinate matching logic.
aggregator = self._aggregator(False)
coords = ['wibble']
with mock.patch('warnings.warn') as warn:
self.cube.collapsed(coords, aggregator)
self._assert_nowarn_collapse_without_weight(coords, warn)