Skip to content

Removal of a cube's cell measure by name (#3081) #3295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 27, 2019
Merged

Removal of a cube's cell measure by name (#3081) #3295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbb02ac
Removal of a cube's cell measure by name (#3081)
alastair-gemmell Mar 8, 2019
6eb90cb
review actions
alastair-gemmell Sep 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...s/src/whatsnew/contributions_2.3.0/newfeature_2019-Mar-08_remove_cell_measure_by_name.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* :meth:`iris.cube.Cube.remove_cell_measure` now also allows removal of a cell
measure by its name (previously only accepted a CellMeasure object).
27 changes: 22 additions & 5 deletions lib/iris/cube.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) British Crown Copyright 2010 - 2018, Met Office
# (C) British Crown Copyright 2010 - 2019, Met Office
#
# This file is part of Iris.
#
Expand Down Expand Up @@ -1123,13 +1123,30 @@ def remove_cell_measure(self, cell_measure):

Args:

* cell_measure (CellMeasure)
The CellMeasure to remove from the cube.
* cell_measure (string or cell_measure)
The (name of the) cell measure to remove from the cube. As either

See also
:meth:`Cube.add_cell_measure()<iris.cube.Cube.add_cell_measure>`
(a) a :attr:`standard_name`, :attr:`long_name`, or
:attr:`var_name`. Defaults to value of `default`
(which itself defaults to `unknown`) as defined in
:class:`iris._cube_coord_common.CFVariableMixin`.
Copy link
Member

@bjlittle bjlittle Sep 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alastair-gemmell A lovely piece of clarification, which explains that cell_measure can be an actual CellMeasure instance or an appropriate string name 😄


(b) a cell_measure instance with metadata equal to that of
the desired cell_measures.

.. note::

If the argument given does not represent a valid cell_measure on
the cube, an :class:`iris.exceptions.CellMeasureNotFoundError`
is raised.

.. seealso::

:meth:`Cube.add_cell_measure()<iris.cube.Cube.add_cell_measure>`

"""
cell_measure = self.cell_measure(cell_measure)

self._cell_measures_and_dims = [[cell_measure_, dim] for cell_measure_,
dim in self._cell_measures_and_dims
if cell_measure_ is not cell_measure]
Expand Down
11 changes: 10 additions & 1 deletion lib/iris/tests/unit/cube/test_Cube.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) British Crown Copyright 2013 - 2018, Met Office
# (C) British Crown Copyright 2013 - 2019, Met Office
#
# This file is part of Iris.
#
Expand Down Expand Up @@ -1648,6 +1648,15 @@ def test_remove_cell_measure(self):
self.assertEqual(self.cube._cell_measures_and_dims,
[[self.b_cell_measure, (0, 1)]])

def test_remove_cell_measure_by_name(self):
self.cube.remove_cell_measure('area')
self.assertEqual(self.cube._cell_measures_and_dims,
[[self.b_cell_measure, (0, 1)]])

def test_fail_remove_cell_measure_by_name(self):
with self.assertRaises(CellMeasureNotFoundError):
self.cube.remove_cell_measure('notarea')


class Test__getitem_CellMeasure(tests.IrisTest):
def setUp(self):
Expand Down