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

Cleanup docstrings in detection.py

    Details

    • Templates:
    • Story Points:
      1
    • Sprint:
      AP S19-6
    • Team:
      Alert Production

      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

            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:

                Summary Panel