Refactor shape masking #6129
Open
Refactor shape masking #6129
+2,008
−681
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
From @SciTools/peloton : discussed what we are seeing here and in #6126. |
|
Discussion with @acchamber notes:
|
|
What are @SciTools/peloton (@pp-mo) thoughts about adding This would facilitate better handling of shapes to rasters (which is essentially the problem we're solving) with the added bonus that we could also mask to other shape types, like lines, to extract a trajectory from a Cube, for example. |
I was planning on going to the AVD surgery this week to discuss some changes and/or make the case for rasterio |
|
Thanks for your patience everyone. It's sometimes a struggle to balance everything and we just haven't had an opportunity to discuss this. Coming to the Surgery (UK Met Office) is an ideal next step. |
|
@pp-mo, @trexfeathers and @stephenworsley have discussed this at the Surgery and agree in principle that we could consider adding rasterio as an optional dependency. |
for more information, see https://pre-commit.ci
|
From @SciTools/peloton: would @hsteptoe and @acchamber appreciate any more input from core devs at this point? |
I just need to find more time, which is in short supply as we get near the end of FY... |
|
This is now ready for some initial (alpha?) testing 🎉. @acchamber are you available to try out the new features? (Updates to docs etc. will follow if this is successful) Tests are incomplete are should not be review yet. This is a fairly substantial re-write. New/improved features include:
There are some breaking changes, principally moving away from having a My informal tests so far show working behaviour for iris test data from |
trexfeathers
requested changes
Oct 15, 2025
trexfeathers
requested changes
Oct 15, 2025
Comment on lines
+35
to
+36
| # to "OFF" in the environment. Having PROJ_NETWORK = "ON" | ||
| # can lead to some coordinate transformations resulting in Inf values. |
There was a problem hiding this comment.
What a pointless feature! I'd be interested to know why.
There was a problem hiding this comment.
Just to be safe, please could we turn this off at the beginning of create_shape_mask(), then reactivate at the end? I don't know if other users might be relying on it so don't want to a make a permanent change.
There was a problem hiding this comment.
We will of course need to 'reactivate' whatever mode was active before we started. I.e. if the user had previously turned it off, then we should keep it off.
I haven't looked at your changes yet but I wanted to record my thoughts before I forgot.
There was a problem hiding this comment.
Yes good point, will update...
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
…bugfix-shape-masking
for more information, see https://pre-commit.ci
…bugfix-shape-masking
…bugfix-shape-masking
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #6129 +/- ##
==========================================
+ Coverage 90.29% 90.32% +0.02%
==========================================
Files 91 91
Lines 24659 24699 +40
Branches 4619 4627 +8
==========================================
+ Hits 22267 22310 +43
+ Misses 1620 1613 -7
- Partials 772 776 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
⏱️ Performance Benchmark Report: b6002b8Performance shiftsFull benchmark resultsGenerated by GHA run |
trexfeathers
requested changes
Oct 24, 2025
Comment on lines
+17
to
+18
| wgs84 = CRS.from_epsg(4326) # WGS84 coordinate system | ||
| osgb = CRS.from_epsg(27700) # OSGB coordinate system |
There was a problem hiding this comment.
Get these into a fixture (as mentioned in integration/test_mask_cube_from_shape.py)
Comment on lines
+40
to
+48
| Polygon( | ||
| [ | ||
| (686600.5247600826, 18834.835866007765), | ||
| (622998.2965261642, 1130592.5248690117), | ||
| (-45450.06302316813, 1150844.967615187), | ||
| (-172954.59474739246, 41898.60193228102), | ||
| (686600.5247600826, 18834.835866007765), | ||
| ] | ||
| ), |
There was a problem hiding this comment.
Mark this as Known Good Output to protect our future developers from confusion!
| masked_cube = mask_cube_from_shape( | ||
| mock_cube, shape, shape_crs=CRS.from_epsg(4326), in_place=True | ||
| ) | ||
| assert masked_cube is None |
There was a problem hiding this comment.
Should also assert that the change has taken effect on mock_cube.
There was a problem hiding this comment.
I know you've achieved test coverage elsewhere but it's important to have some coverage at this level - we're free to make any changes to _shapefiles so long as the top layer behaviour remains the same; coverage at the top level helps ensure that.
There was a problem hiding this comment.
See my comments on unit/util/test_mask_cube_from_shape.py
⏱️ Performance Benchmark Report: 014dfd9Performance shiftsFull benchmark resultsGenerated by GHA run |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🚀 Pull Request
Description
Fixes #6126 by exposing the shape geometry to the user. Adds to docs and docstrings to make it clearer how to use this.
Consult Iris pull request check list
Add any of the below labels to trigger actions on this PR: