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

Fix setting of calib_psf_candidate flag to match docstring description

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: pipe_tasks
    • Labels:
      None
    • Story Points:
      3
    • Epic Link:
    • Sprint:
      DRP F18-4
    • Team:
      Data Release Production

      Description

      The docstring for calib_psf_candidate reads:

                  self.candidateKey = schema.addField(
                      "calib_psf_candidate", type="Flag",
                      doc=("Flag set if the source was a candidate for PSF determination, "
                           "as determined by the star selector.")
                  )
      

      However, if the reserve fraction is set to a non-zero value, an object that was selected as a PSF candidate by the star selector but then flagged as reserved will have the calib_psf_candidate flag set to False. This is inconsistent with the docstring (and erroneously implies the object was not deemed a suitable candidate). Please update the setting of the flag to reflect its docstring description.

        Attachments

          Issue Links

            Activity

            lauren Lauren MacArthur created issue -
            lauren Lauren MacArthur made changes -
            Field Original Value New Value
            Sprint DRP F18-4 [ 774 ]
            lauren Lauren MacArthur made changes -
            Risk Score 0
            lauren Lauren MacArthur made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            lauren Lauren MacArthur made changes -
            Description The docstring for {{calib_psfCandidate}} reads:
            {code}
                        self.candidateKey = schema.addField(
                            "calib_psfCandidate", type="Flag",
                            doc=("Flag set if the source was a candidate for PSF determination, "
                                 "as determined by the star selector.")
                        )
            {code}

            However, if the reserve fraction is set to a non-zero value, an object that was selected as a PSF candidate by the star selector but then flagged as reserved will have the {{calib_psfCandidate}} flag set to *False*. This is inconsistent with the docstring (and erroneously implies the object was not deemed a suitable candidate). Please update the setting of the flag to reflect its docstring description.
            The docstring for {{calib_psf_candidate}} reads:
            {code} self.candidateKey = schema.addField(
                            "calib_psf_candidate", type="Flag",
                            doc=("Flag set if the source was a candidate for PSF determination, "
                                 "as determined by the star selector.")
                        )
            {code}
            However, if the reserve fraction is set to a non-zero value, an object that was selected as a PSF candidate by the star selector but then flagged as reserved will have the {{calib_psf_candidate}} flag set to *False*. This is inconsistent with the docstring (and erroneously implies the object was not deemed a suitable candidate). Please update the setting of the flag to reflect its docstring description.
            lauren Lauren MacArthur made changes -
            Reviewers Robert Lupton [ rhl ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            lauren Lauren MacArthur made changes -
            Summary Fix setting of calib_psfCandidate flag to match docstring description Fix setting of calib_psf_candidate flag to match docstring description
            lauren Lauren MacArthur made changes -
            Watchers Lauren MacArthur, Robert Lupton [ Lauren MacArthur, Robert Lupton ] Bob Armstrong, Lauren MacArthur, Robert Lupton [ Bob Armstrong, Lauren MacArthur, Robert Lupton ]
            lauren Lauren MacArthur made changes -
            Link This issue blocks DM-15649 [ DM-15649 ]
            lauren Lauren MacArthur made changes -
            Reviewers Robert Lupton [ rhl ] Bob Armstrong [ rearmstr ]
            rearmstr Bob Armstrong made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            lauren Lauren MacArthur made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            yusra Yusra AlSayyad made changes -
            Story Points 1 3
            yusra Yusra AlSayyad made changes -
            Epic Link DM-14402 [ 79665 ]

              People

              Assignee:
              lauren Lauren MacArthur
              Reporter:
              lauren Lauren MacArthur
              Reviewers:
              Bob Armstrong
              Watchers:
              Bob Armstrong, Lauren MacArthur, Robert Lupton
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.