lsst.meas.algorithms.detection.SourceDetectionConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.detection.SourceDetectionConfig:
Public Member Functions | |
| setDefaults (self) | |
Detailed Description
Configuration parameters for the SourceDetectionTask
Definition at line 70 of file detection.py.
Member Function Documentation
◆ setDefaults()
| lsst.meas.algorithms.detection.SourceDetectionConfig.setDefaults | ( | self | ) |
Reimplemented in lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig.
Definition at line 189 of file detection.py.
Member Data Documentation
◆ adjustBackground
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Fiddle factor to add to the background; debugging only",
default=0.0,
)
Definition at line 123 of file detection.py.
◆ background
|
static |
Initial value:
= pexConfig.ConfigurableField(
doc="Background re-estimation; ignored if reEstimateBackground false",
target=SubtractBackgroundTask,
)
Definition at line 140 of file detection.py.
◆ 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 81 of file detection.py.
◆ doApplyFlatBackgroundRatio
|
static |
Initial value:
= pexConfig.Field(
doc="Convert from a photometrically flat image to one suitable for background subtraction? "
"Only used if reEstimateBackground is True."
"If True, then a backgroundToPhotometricRatio must be supplied to the task run method.",
dtype=bool,
default=False,
)
Definition at line 133 of file detection.py.
◆ doTempLocalBackground
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Enable temporary local background subtraction? (see tempLocalBackground)",
default=True,
)
Definition at line 150 of file detection.py.
◆ doTempWideBackground
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do temporary wide (large-scale) background subtraction before footprint detection?",
default=False,
)
Definition at line 161 of file detection.py.
◆ excludeMaskPlanes
|
static |
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=[],
doc="Mask planes to exclude when detecting sources."
)
Definition at line 183 of file detection.py.
◆ includeThresholdMultiplier
|
static |
Initial value:
= pexConfig.RangeField(
doc="Multiplier on thresholdValue for whether a source is included in the output catalog."
" For example, thresholdValue=5, includeThresholdMultiplier=10, thresholdType='pixel_stdev' "
"results in a catalog of sources at >50 sigma with the detection mask and footprints "
"including pixels >5 sigma.",
dtype=float, default=1.0, min=0.0,
)
Definition at line 97 of file detection.py.
◆ isotropicGrow
|
static |
Initial value:
= pexConfig.Field(
doc="Grow pixels as isotropically as possible? If False, use a Manhattan metric instead.",
dtype=bool, default=True,
)
Definition at line 77 of file detection.py.
◆ 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 73 of file detection.py.
◆ 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 166 of file detection.py.
◆ 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 172 of file detection.py.
◆ 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 85 of file detection.py.
◆ reEstimateBackground
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Estimate the background again after final source detection?",
default=True, optional=False,
)
Definition at line 128 of file detection.py.
◆ 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 89 of file detection.py.
◆ 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 178 of file detection.py.
◆ 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 144 of file detection.py.
◆ 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 155 of file detection.py.
◆ 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 114 of file detection.py.
◆ thresholdType
|
static |
Initial value:
= pexConfig.ChoiceField(
doc="Specifies the meaning of thresholdValue.",
dtype=str, optional=False, default="pixel_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 104 of file detection.py.
◆ thresholdValue
|
static |
Initial value:
= pexConfig.RangeField(
doc="Threshold for detecting footprints; exact meaning and units depend on thresholdType.",
dtype=float, optional=False, default=5.0, min=0.0,
)
Definition at line 93 of file detection.py.
The documentation for this class was generated from the following file:
- python/lsst/meas/algorithms/detection.py
Generated on for lsst.meas.algorithms by
1.17.0