Skip to content

Replace mask_obscuration with pixel_mask(s) - #256

Merged
roryclaydon1994 merged 2 commits into
developfrom
255-change-mask_obscuration-to-pixel_mask
Sep 18, 2026
Merged

roryclaydon1994 merged 2 commits into
developfrom
255-change-mask_obscuration-to-pixel_mask

Conversation

@jeipollack

Copy link
Copy Markdown
Contributor

Summary

Small refactor to rename mask_obscuration to pixel_mask.

Closes #255

What’s changed

  • Renamed module mask_obscuration.py to pixel_masks.py
  • Renamed class MaskObscurationMetric to PixelMaskMetric
  • Changed the mask_obscuration identifier to pixel_mask in metric and rejection policy configuration
  • Changed loop variable metric_rejection_policy to rejection_policy in validate_rejection_policy_metrics()
  • Updated all example YAML files and YAML fixture files
  • Updated associated tests

How to test / verify

  • Searched the repository to check for remaining mask_obscuration references
  • Reviewed the changed files
  • Confirmed CI tests pass

Scope

Indicate the type of PR:

  • Feature
  • Bug fix
  • Hotfix
  • Documentation / process change
  • Internal / refactor
  • Release

Optionally, note if this PR is part of a larger milestone or set of related PRs.

Changelog

Did this PR introduce user-visible changes?
If yes, a Scriv changelog fragment must be added and committed.

  • Changelog fragment added (if applicable)

Reviewer Checklist

Reviewers should confirm the following before approving and merging:

  • The PR targets the correct base branch (develop, or main for release PRs)
  • The PR is assigned to the developer
  • Appropriate labels are applied
  • The PR is included in relevant projects and/or milestones
  • Description clearly explains what has changed
  • Issue references included, if applicable
  • Code and documentation adhere to current standards (ruff)
  • Documentation updates included, if relevant
  • CI tests are passing
  • All reviewer comments have been addressed

Next Steps / Notes

For now, rejection policies use the quality metric name as their identifier. This keeps the current one-to-one metric/policy configuration model simple. In the future, a rejection policy may require multiple metrics, in which case the configuration model may need to be extended.

Jennifer Pollack added 2 commits September 16, 2026 17:21
- Replace metric_rejection_policy with rejection_policy for clarity
- Clean up formatting and spacing in error messages

@roryclaydon1994 roryclaydon1994 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review feedback

Looks like this is just a name change? Some attributes were added to the metric heading, but as these aren't used yet, I haven't tried to review this.

@jeipollack

Copy link
Copy Markdown
Contributor Author

Review feedback

Looks like this is just a name change? Some attributes were added to the metric heading, but as these aren't used yet, I haven't tried to review this.

Hi @roryclaydon1994 , yes, that's correct. These changes were motivated from current feature work on defining pixel mask quality metrics. Because renaming touched so many files I thought it best to open a PR to enable a speedy and simple review.

@roryclaydon1994
roryclaydon1994 merged commit 3f180c8 into develop Sep 18, 2026
2 checks passed
@roryclaydon1994
roryclaydon1994 deleted the 255-change-mask_obscuration-to-pixel_mask branch September 18, 2026 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

2 participants