feat: allow masking from the data itself#274
Closed
floriankrb wants to merge 2 commits into
Closed
Conversation
github-project-automation
Bot
moved this from To be triaged
to For merging
in Anemoi-dev
Contributor
aaron-hopkinson
left a comment
aaron-hopkinson
left a comment
There was a problem hiding this comment.
Technically this should work, but it's not really intended for a SingleFieldFilter to rely on multiple variables at "forward" time, nor is it really expected that implementations of this class would provide their own implementations of forward. So, it might be better to convert this back to a regular Filter (which itself isn't ideal)... Either keeping this as is, or converting to a Filter both feel a bit messy to me – so I guess it depends how desperate we really are for this feature.
Member
|
This PR has been superceded by PR #276 |
aaron-hopkinson
added a commit
that referenced
this pull request
Apr 20, 2026
…ask (#277) ## Description Alternative implementation of #276, builds on #274 but converts the filter back to a `Filter` rather than `SingleFieldFilter` (but keeps alignment to minimise the diff) ## Allow masking from a field in the pipeline The `apply_mask` filter currently requires an external file (`path`) to provide the mask. This makes it awkward when the mask (e.g. `lsm`) is already available as a field in the same pipeline — you need to save it to a separate file first, then reference it. This PR adds a `mask_param` option as an alternative to `path`. When `mask_param` is set, by default, the mask field is consumed (not returned), but it is possible to force it to be returned with (`return_mask: true`). All existing `mask_value`/`threshold`/`rename`/`param` options work exactly the same way. ### Usage ```yaml input: pipe: - mars: param: - sd - lsm - apply_mask: mask_param: lsm # Use lsm for masking mask_value: 0 # Set to NaN where lsm == 0 (sea points) ``` ***As a contributor to the Anemoi framework, please ensure that your changes include unit tests, updates to any affected dependencies and documentation, and have been tested in a parallel setting (i.e., with multiple GPUs). As a reviewer, you are also responsible for verifying these aspects and requesting changes if they are not adequately addressed. For guidelines about those please refer to https://anemoi.readthedocs.io/en/latest/*** By opening this pull request, I affirm that all authors agree to the [Contributor License Agreement.](https://github.com/ecmwf/codex/blob/main/Legal/contributor_license_agreement.md) --------- Co-authored-by: Florian Pinault <Florian.Pinault@ecmwf.int> Co-authored-by: Mariana Clare <31656450+mc4117@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Allow masking from a field in the pipeline
The
apply_maskfilter currently requires an external file (path) to provide the mask. This makes it awkward when the mask (e.g.lsm) is already available as a field in the same pipeline — you need to save it to a separate file first, then reference it.This PR adds a
mask_paramoption as an alternative topath. Whenmask_paramis set, the filter extracts the named field from the pipeline data, uses it as the mask, and removes it from the output. All existingmask_value/threshold/rename/paramoptions work exactly the same way.Usage
As a contributor to the Anemoi framework, please ensure that your changes include unit tests, updates to any affected dependencies and documentation, and have been tested in a parallel setting (i.e., with multiple GPUs). As a reviewer, you are also responsible for verifying these aspects and requesting changes if they are not adequately addressed. For guidelines about those please refer to https://anemoi.readthedocs.io/en/latest/
By opening this pull request, I affirm that all authors agree to the Contributor License Agreement.