Inheritance diagram for lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig:
Public Member Functions | |
| def | setDefaults (self) |
Detailed Description
Configuration for DynamicDetectionTask
Definition at line 20 of file dynamicDetection.py.
Member Function Documentation
◆ setDefaults()
| def lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig.setDefaults | ( | self | ) |
Reimplemented from lsst.meas.algorithms.detection.SourceDetectionConfig.
Definition at line 32 of file dynamicDetection.py.
Member Data Documentation
◆ adjustBackground
|
staticinherited |
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
|
staticinherited |
Initial value:
= pexConfig.ConfigurableField(
doc="Background re-estimation; ignored if reEstimateBackground false",
target=SubtractBackgroundTask,
)
Definition at line 103 of file detection.py.
◆ combinedGrow
|
staticinherited |
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.
◆ doBackgroundTweak
|
static |
Initial value:
= Field(dtype=bool, default=True,
doc="Tweak background level so median PSF flux of sky objects is zero?")
Definition at line 26 of file dynamicDetection.py.
◆ doTempLocalBackground
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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.
◆ minNumSources
|
static |
Initial value:
= Field(dtype=int, default=10,
doc="Minimum number of sky sources in statistical sample; "
"if below this number, we refuse to modify the threshold.")
Definition at line 28 of file dynamicDetection.py.
◆ minPixels
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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.
◆ prelimThresholdFactor
|
static |
Initial value:
= Field(dtype=float, default=0.5,
doc="Fraction of the threshold to use for first pass (to find sky objects)")
Definition at line 23 of file dynamicDetection.py.
◆ reEstimateBackground
|
staticinherited |
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
|
staticinherited |
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.
◆ skyObjects
|
static |
Definition at line 25 of file dynamicDetection.py.
◆ statsMask
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/dynamicDetection.py
