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

Implement RFC-498: homogenize naming of calibration flags

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: pipe_tasks
    • Labels:
      None
    • Templates:
    • Story Points:
      6
    • Sprint:
      DRP F18-2, DRP F18-3
    • Team:
      Data Release Production

      Description

      We currently have the following set of names for the calib_* flags that get propagated to source catalogs:

      • calib_detected
      • calib_psfCandidate
      • calib_psfUsed
      • calib_psf_reserved (changed from calib_psfReserved on DM-12207 in this commit)
      • calib_astrometryUsed
      • calib_photometry_used (changed from calib_photometryUsed on DM-12207, in this commit)
      • calib_photometry_reserved (changed from calib_photometryReserved on DM-12207 in this commit)

      I.e. there is a mixture of underscore and camelCase for the third (final) "descriptor", making it difficult to remember which standard to use when trying to select on a given flag.  These should all be homogenized and, given the recent changes in this direction noted above, I believe the preferred choice is the underscore standard.

      A change in the flag names will affect any current user scripts that select on these flags.  To prevent scripts from breaking, it may be desirable to set a (temporary?) alias (although this was not done along with the DM-12207 changes and there was no uproar that I'm aware of).

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                lauren Lauren MacArthur
                Reporter:
                lauren Lauren MacArthur
                Reviewers:
                John Parejko
                Watchers:
                Jim Bosch, John Parejko, John Swinbank, Lauren MacArthur, Paul Price, Yusra AlSayyad
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel