LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.detection.SourceDetectionConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.detection.SourceDetectionConfig:
lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 minPixels
 
 isotropicGrow
 
 combinedGrow
 
 nSigmaToGrow
 
 returnOriginalFootprints
 
 thresholdValue
 
 includeThresholdMultiplier
 
 thresholdType
 
 thresholdPolarity
 
 adjustBackground
 
 reEstimateBackground
 
 background
 
 tempLocalBackground
 
 doTempLocalBackground
 
 tempWideBackground
 
 doTempWideBackground
 
 nPeaksMaxSimple
 
 nSigmaForKernel
 
 statsMask
 

Detailed Description

Configuration parameters for the SourceDetectionTask

Definition at line 43 of file detection.py.

Member Function Documentation

◆ setDefaults()

def lsst.meas.algorithms.detection.SourceDetectionConfig.setDefaults (   self)

Reimplemented in lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig.

Definition at line 147 of file detection.py.

147  def setDefaults(self):
148  self.tempLocalBackground.binSize = 64
149  self.tempLocalBackground.algorithm = "AKIMA_SPLINE"
150  self.tempLocalBackground.useApprox = False
151  # Background subtraction to remove a large-scale background (e.g., scattered light); restored later.
152  # Want to keep it from exceeding the deblender size limit of 1 Mpix, so half that is reasonable.
153  self.tempWideBackground.binSize = 512
154  self.tempWideBackground.algorithm = "AKIMA_SPLINE"
155  self.tempWideBackground.useApprox = False
156  # Ensure we can remove even bright scattered light that is DETECTED
157  for maskPlane in ("DETECTED", "DETECTED_NEGATIVE"):
158  if maskPlane in self.tempWideBackground.ignoredPixelMask:
159  self.tempWideBackground.ignoredPixelMask.remove(maskPlane)
160 
161 

Member Data Documentation

◆ adjustBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.adjustBackground
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Fiddle factor to add to the background; debugging only",
default=0.0,
)

Definition at line 93 of file detection.py.

◆ background

lsst.meas.algorithms.detection.SourceDetectionConfig.background
static
Initial value:
= pexConfig.ConfigurableField(
doc="Background re-estimation; ignored if reEstimateBackground false",
target=SubtractBackgroundTask,
)

Definition at line 103 of file detection.py.

◆ combinedGrow

lsst.meas.algorithms.detection.SourceDetectionConfig.combinedGrow
static
Initial value:
= pexConfig.Field(
doc="Grow all footprints at the same time? This allows disconnected footprints to merge.",
dtype=bool, default=True,
)

Definition at line 54 of file detection.py.

◆ doTempLocalBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.doTempLocalBackground
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Enable temporary local background subtraction? (see tempLocalBackground)",
default=True,
)

Definition at line 113 of file detection.py.

◆ doTempWideBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.doTempWideBackground
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do temporary wide (large-scale) background subtraction before footprint detection?",
default=False,
)

Definition at line 124 of file detection.py.

◆ includeThresholdMultiplier

lsst.meas.algorithms.detection.SourceDetectionConfig.includeThresholdMultiplier
static
Initial value:
= pexConfig.RangeField(
doc="Include threshold relative to thresholdValue",
dtype=float, default=1.0, min=0.0,
)

Definition at line 70 of file detection.py.

◆ isotropicGrow

lsst.meas.algorithms.detection.SourceDetectionConfig.isotropicGrow
static
Initial value:
= pexConfig.Field(
doc="Pixels should be grown as isotropically as possible (slower)",
dtype=bool, optional=False, default=False,
)

Definition at line 50 of file detection.py.

◆ minPixels

lsst.meas.algorithms.detection.SourceDetectionConfig.minPixels
static
Initial value:
= pexConfig.RangeField(
doc="detected sources with fewer than the specified number of pixels will be ignored",
dtype=int, optional=False, default=1, min=0,
)

Definition at line 46 of file detection.py.

◆ nPeaksMaxSimple

lsst.meas.algorithms.detection.SourceDetectionConfig.nPeaksMaxSimple
static
Initial value:
= pexConfig.Field(
dtype=int,
doc=("The maximum number of peaks in a Footprint before trying to "
"replace its peaks using the temporary local background"),
default=1,
)

Definition at line 129 of file detection.py.

◆ nSigmaForKernel

lsst.meas.algorithms.detection.SourceDetectionConfig.nSigmaForKernel
static
Initial value:
= pexConfig.Field(
dtype=float,
doc=("Multiple of PSF RMS size to use for convolution kernel bounding box size; "
"note that this is not a half-size. The size will be rounded up to the nearest odd integer"),
default=7.0,
)

Definition at line 135 of file detection.py.

◆ nSigmaToGrow

lsst.meas.algorithms.detection.SourceDetectionConfig.nSigmaToGrow
static
Initial value:
= pexConfig.Field(
doc="Grow detections by nSigmaToGrow * [PSF RMS width]; if 0 then do not grow",
dtype=float, default=2.4, # 2.4 pixels/sigma is roughly one pixel/FWHM
)

Definition at line 58 of file detection.py.

◆ reEstimateBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.reEstimateBackground
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Estimate the background again after final source detection?",
default=True, optional=False,
)

Definition at line 98 of file detection.py.

◆ returnOriginalFootprints

lsst.meas.algorithms.detection.SourceDetectionConfig.returnOriginalFootprints
static
Initial value:
= pexConfig.Field(
doc="Grow detections to set the image mask bits, but return the original (not-grown) footprints",
dtype=bool, optional=False, default=False,
)

Definition at line 62 of file detection.py.

◆ statsMask

lsst.meas.algorithms.detection.SourceDetectionConfig.statsMask
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="Mask planes to ignore when calculating statistics of image (for thresholdType=stdev)",
default=['BAD', 'SAT', 'EDGE', 'NO_DATA'],
)

Definition at line 141 of file detection.py.

◆ tempLocalBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.tempLocalBackground
static
Initial value:
= pexConfig.ConfigurableField(
doc=("A local (small-scale), temporary background estimation step run between "
"detecting above-threshold regions and detecting the peaks within "
"them; used to avoid detecting spuerious peaks in the wings."),
target=SubtractBackgroundTask,
)

Definition at line 107 of file detection.py.

◆ tempWideBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.tempWideBackground
static
Initial value:
= pexConfig.ConfigurableField(
doc=("A wide (large-scale) background estimation and removal before footprint and peak detection. "
"It is added back into the image after detection. The purpose is to suppress very large "
"footprints (e.g., from large artifacts) that the deblender may choke on."),
target=SubtractBackgroundTask,
)

Definition at line 118 of file detection.py.

◆ thresholdPolarity

lsst.meas.algorithms.detection.SourceDetectionConfig.thresholdPolarity
static
Initial value:
= pexConfig.ChoiceField(
doc="specifies whether to detect positive, or negative sources, or both",
dtype=str, optional=False, default="positive",
allowed={
"positive": "detect only positive sources",
"negative": "detect only negative sources",
"both": "detect both positive and negative sources",
},
)

Definition at line 84 of file detection.py.

◆ thresholdType

lsst.meas.algorithms.detection.SourceDetectionConfig.thresholdType
static
Initial value:
= pexConfig.ChoiceField(
doc="specifies the desired flavor of Threshold",
dtype=str, optional=False, default="stdev",
allowed={
"variance": "threshold applied to image variance",
"stdev": "threshold applied to image std deviation",
"value": "threshold applied to image value",
"pixel_stdev": "threshold applied to per-pixel std deviation",
},
)

Definition at line 74 of file detection.py.

◆ thresholdValue

lsst.meas.algorithms.detection.SourceDetectionConfig.thresholdValue
static
Initial value:
= pexConfig.RangeField(
doc="Threshold for footprints; exact meaning and units depend on thresholdType.",
dtype=float, optional=False, default=5.0, min=0.0,
)

Definition at line 66 of file detection.py.


The documentation for this class was generated from the following file: