lsst.pipe.tasks  21.0.0-18-gc7b2edac+261703b25d
Classes | Functions
lsst.pipe.tasks.maskStreaks Namespace Reference

Classes

class  Line
 
class  LineCollection
 
class  LineProfile
 
class  MaskStreaksConfig
 
class  MaskStreaksTask
 

Functions

def setDetectionMask (maskedImage, forceSlowBin=False, binning=None, detectedPlane="DETECTED", badMaskPlanes=("NO_DATA", "INTRP", "BAD", "SAT", "EDGE"), detectionThreshold=5)
 

Function Documentation

◆ setDetectionMask()

def lsst.pipe.tasks.maskStreaks.setDetectionMask (   maskedImage,
  forceSlowBin = False,
  binning = None,
  detectedPlane = "DETECTED",
  badMaskPlanes = ("NO_DATA", "INTRP", "BAD", "SAT", "EDGE"),
  detectionThreshold = 5 
)
Make detection mask and set the mask plane

Creat a binary image from a masked image by setting all data with signal-to-
noise below some threshold to zero, and all data above the threshold to one.
If the binning parameter has been set, this procedure will be preceded by a
weighted binning of the data in order to smooth the result, after which the
result is scaled back to the original dimensions. Set the detection mask
plane with this binary image.

Parameters
----------
maskedImage : `lsst.afw.image.maskedImage`
    Image to be (optionally) binned and converted
forceSlowBin : bool (optional)
    Force usage of slower binning method to check that the two methods
    give the same result.
binning : int (optional)
    Number of pixels by which to bin image
detectedPlane : str (optional)
    Name of mask with pixels that were detected above threshold in image
badMaskPlanes : set (optional)
    Names of masks with pixels that are rejected
detectionThreshold : float (optional)
    Boundary in signal-to-noise between non-detections and detections for
    making a binary image from the original input image

Definition at line 39 of file maskStreaks.py.