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

Cleanup docstrings in detection.py

    XMLWordPrintable

    Details

      Description

      As part of our weekly brown bag discussion, we did a deep dive into SourceDetectionTask and noticed a number of confusing or misleading docstrings. Here are the notes I took during the brown bag. I'll try to translate these into cleanups shortly, so I don't forget:

      DetectionConfig: threshold, thresholdValue
      DetectionTask:
      detectFootprints: doSmooth & sigma
      convolveImage: under what circumstances would you not want `doSmooth==True`?
      Better document relationship between reEstimateBackground and thresholdParity? - `applyThreshold` has a fun pair of `if`s, which might then be removed in `clearUnwantedResults`

      remove `makeSourceCatalog = run

        Attachments

          Activity

          Hide
          Parejkoj John Parejko added a comment -

          Ian Sullivan: do you mind reviewing this small doc cleanup?

          I think I got everything except the "relationship between reEstimateBackground and thresholdParity" (because I didn't know what to say about it) and "remove `makeSourceCatalog = run`" (because it turns out there's a lot of uses of `detection.makeSourceCatalog()` across a variety of packages. Which we should definitely clean up, but it might be worth waiting for gen3 butler to do that?).

          Show
          Parejkoj John Parejko added a comment - Ian Sullivan : do you mind reviewing this small doc cleanup? I think I got everything except the "relationship between reEstimateBackground and thresholdParity" (because I didn't know what to say about it) and "remove `makeSourceCatalog = run`" (because it turns out there's a lot of uses of `detection.makeSourceCatalog()` across a variety of packages. Which we should definitely clean up, but it might be worth waiting for gen3 butler to do that?).
          Hide
          sullivan Ian Sullivan added a comment -

          These changes look fine, and are a good start.

          Show
          sullivan Ian Sullivan added a comment - These changes look fine, and are a good start.
          Hide
          Parejkoj John Parejko added a comment -

          Thanks for the quick review!

          Show
          Parejkoj John Parejko added a comment - Thanks for the quick review!

            People

            Assignee:
            Parejkoj John Parejko
            Reporter:
            Parejkoj John Parejko
            Reviewers:
            Ian Sullivan
            Watchers:
            Ian Sullivan, John Parejko, John Swinbank, Meredith Rawls, Yusra AlSayyad
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: