Details
-
Type:
Improvement
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: afw
-
Labels:None
-
Team:SQuaRE
Description
It's possible to add and remove mask planes dynamically, and their bit values get correctly written to FITS headers if that's how you choose to persist the Masks. Unfortunately, the only way to guess what they mean is to scrutinise the name.
Please add the ability to associate a doc string with each mask plane, which should be persisted along with the data, and made available in sensible ways in the Mask API.
This is similar in spirit to the request to document the flags generated by measurement algorithms. As such, I'm assigning it to team SQuaRE and linking it to
DM-6887& DM-6655 in the hope that Jonathan Sick & colleagues will give us a steer about how best to approach it. Ultimately, though, I expect afw-side implementation and actually writing the docs may be a Pipelines deliverable.