Add bad pixel flags to extra.calibration #172
Merged
Conversation
This file contains 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
1 task
philsmt
reviewed
May 7, 2024
docs/calibration.md
Outdated
| The calibration pipeline produces masks along with corrected data, in keys | ||
| called `image.mask` or `data.mask` depending on the detector. Zeros in the mask | ||
| represent good pixels, while any other value indicates one or more reasons to | ||
| consider the corresponding data dubious: |
There was a problem hiding this comment.
I would prefer as neutral wording as possible, given some bits simply mean to inform about a peculiarity like NON_STANDARD_SIZE. Maybe conspicuous? (just grabbing that from a dictionary)
There was a problem hiding this comment.
Good point, I've had a go at rewording this.
Are you happy with the subheading remaining 'Bad pixel values' if we give more nuance in the description, or do you think that needs to change too?
There was a problem hiding this comment.
I suspect that term is just too established to change now 🤷
|
That should help, thanks. LGTM. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The definitions are copied from pycalibration.