Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-32438

Add documentation strings to Mask plane definitions

    XMLWordPrintable

    Details

    • Story Points:
      2
    • Epic Link:
    • Sprint:
      AP S23-4 (March)
    • Team:
      Alert Production
    • Urgent?:
      No

      Description

      We need a way to be able to include documentation strings for mask planes in lsst.afw.image.Mask objects, and we probably need a way to define and persist a mask-plane-schema (for lack of a better word) without actually constructing a Mask, just as we define and persist Catalog schemas.

      This will require some C++ work down in afw; it should be possible to do this in a backwards-compatible way, but I suspect it will highlight some existing methods and patterns that we may want to deprecate (some for confusion-avoidance, some to help ensure mask plane definitions are consistent across data IDs).

        Attachments

          Issue Links

          blocks

          Improvement - An improvement or enhancement to an existing feature or task. DM-2297 Associate documentation with new Mask planes

          • To Do
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-38117 Explore renaming SAT->SATURATED and INTRP/INTERP->INTERPOLATED

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-38120 Add VIGNETTED bit mask

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7389 Create a public function to reset to the default mask planes

          • To Do

            Activity

            There are no comments yet on this issue.

              People

              Assignee:
              Parejkoj John Parejko
              Reporter:
              jbosch Jim Bosch
              Watchers:
              Gregory Dubois-Felsmann, Jim Bosch, John Parejko
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.