lsst.meas.algorithms gf82c78fb6f+5b4928dc2e
Loading...
Searching...
No Matches
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

pexConfig minPixels
 
pexConfig isotropicGrow
 
pexConfig combinedGrow
 
pexConfig nSigmaToGrow
 
pexConfig returnOriginalFootprints
 
pexConfig thresholdValue
 
pexConfig includeThresholdMultiplier
 
pexConfig thresholdType
 
pexConfig thresholdPolarity
 
pexConfig adjustBackground
 
pexConfig reEstimateBackground
 
pexConfig background
 
pexConfig tempLocalBackground
 
pexConfig doTempLocalBackground
 
pexConfig tempWideBackground
 
pexConfig doTempWideBackground
 
pexConfig nPeaksMaxSimple
 
pexConfig nSigmaForKernel
 
pexConfig 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.

Member Data Documentation

◆ adjustBackground

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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

pexConfig 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: