DM-43083: Add optional streak masking in detectAndMeasure

[cmsaunders]

No description provided.

[isullivan]

A few important but easy suggested changes. I would like to also have a unit test that runs streak masking, ideally with and without a simulated streak added to the image like you have in meas_algorithms. You can keep the detailed tests of the algorithm in that package, but I would like a minimal test to check that it at least runs.

Something in test_detectAndMeasure.py like the following would work:

    def test_mask_streaks(self):
        """Run detection on a difference image containing a streak.
        """
        # Set up the simulated images
        noiseLevel = 1.
        staticSeed = 1
        fluxLevel = 500
        kwargs = {"seed": staticSeed, "psfSize": 2.4, "fluxLevel": fluxLevel}
        science, sources = makeTestImage(noiseLevel=noiseLevel, noiseSeed=6, **kwargs)
        matchedTemplate, _ = makeTestImage(noiseLevel=noiseLevel/4, noiseSeed=7, **kwargs)

        # Configure the detection Task
        detectionTask = self._setup_detection(doMerge=False, doMaskStreaks=True)
 
        difference = science.clone()
        difference.maskedImage -= matchedTemplate.maskedImage
        difference.image.array[20:23, 40:200] += 50

        output = detectionTask.run(science, matchedTemplate, difference)
        outMask = output.subtractedMeasuredExposure.mask.array
        streakMask = output.subtractedMeasuredExposure.mask.getPlaneBitMask("STREAK")
        streakMaskSet = (outMask & streakMask) > 0
        self.assertTrue(np.all(streakMaskSet[20:23, 40:200]))

[isullivan]

Add {fakesType} to the name.

[isullivan]

I find output ambiguous here, since it could be a verb or a noun. Could you rename this to something like doWriteStreakInfo?

[isullivan]

Note that this returns a pipeBase.Struct of a dict

[isullivan]

We don't need to calculate streakInfo if it won't be written. I would suggest wrapping these lines in if self.config.outputStreakInfo: and return an empty pipeBase.Struct otherwise.

[cmsaunders]

I've implemented this so that if self.config.writeStreakInfo=False, it returns
streakInfo = {'rho': np.array([]), 'theta': np.array([]), 'sigma': np.array([])}
I'm not sure if you meant a totally empty pipeBase.Struct, but I did it this way so that the docs are consistent.

[cmsaunders]

Thanks for the comments @isullivan. Your suggested test worked pretty much out of the box, so I just added an extra run of the detection task before adding the fake streak, in order to check that nothing was set in the streak mask.

[isullivan]

Looks good! Thank you for the new unit test.