lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig:
Public Member Functions | |
| setDefaults (self) | |
| validate (self) | |
Detailed Description
Configuration for DynamicDetectionTask
Definition at line 89 of file dynamicDetection.py.
Member Function Documentation
◆ setDefaults()
| lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig.setDefaults | ( | self | ) |
Reimplemented from lsst.meas.algorithms.detection.SourceDetectionConfig.
Definition at line 166 of file dynamicDetection.py.
◆ validate()
| lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig.validate | ( | self | ) |
Definition at line 173 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 123 of file detection.py.
◆ allowMaskErode
|
static |
Initial value:
= Field(dtype=bool, default=True,
doc="Crowded/large fill-factor fields make it difficult to find "
"suitable locations to lay down sky objects. To allow for best effort "
"sky source placement, if True, this allows for a slight erosion of "
"the detection masks.")
Definition at line 151 of file dynamicDetection.py.
◆ background
|
staticinherited |
Initial value:
= pexConfig.ConfigurableField(
doc="Background re-estimation; ignored if reEstimateBackground false",
target=SubtractBackgroundTask,
)
Definition at line 140 of file detection.py.
◆ bisectFactor
|
static |
Initial value:
= Field(dtype=float, default=1.2,
doc="Factor by which to increase thresholds in brightMaskFractionMax loop.")
Definition at line 149 of file dynamicDetection.py.
◆ brightDetectionIterMax
|
static |
Initial value:
= Field(dtype=int, default=10,
doc="Maximum number of iterations in the initial bright detection "
"pass.")
Definition at line 127 of file dynamicDetection.py.
◆ brightGrowFactor
|
static |
Initial value:
= Field(dtype=int, default=40,
doc="Factor by which to grow the footprints of sources detected in the "
"\"bright\" detections stage (want this to be large to mask wings of "
"bright sources).")
Definition at line 139 of file dynamicDetection.py.
◆ brightMaskFractionMax
|
static |
Initial value:
= Field(dtype=float, default=0.95,
doc="Maximum allowed fraction of masked pixes from the \"bright\" "
"detection stage (to mask regions unsuitable for sky sourcess). "
"If this fraction is exeeded, the detection threshold for this stage "
"will be increased by bisectFactor until the fraction of masked "
"pixels drops below this threshold.")
Definition at line 143 of file dynamicDetection.py.
◆ brightMultiplier
|
static |
Initial value:
= Field(dtype=float, default=2000.0,
doc="Multiplier to apply to the prelimThresholdFactor for the "
"\"bright\" detections stage (want this to be large to only "
"detect the brightest sources).")
Definition at line 130 of file dynamicDetection.py.
◆ brightNegFactor
|
static |
Initial value:
= Field(dtype=float, default=2.2,
doc="Factor by which to multiply the threshold for the negative polatiry "
"detections for the \"bright\" detections stage (this needs to be fairly "
"low given the nature of the negative polarity detections in the very "
"large positive polarity threshold).")
Definition at line 134 of file dynamicDetection.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 81 of file detection.py.
◆ doApplyFlatBackgroundRatio
|
staticinherited |
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.
◆ 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 110 of file dynamicDetection.py.
◆ doBrightPrelimDetection
|
static |
Initial value:
= Field(dtype=bool, default=True,
doc="Do initial bright detection pass where footprints are grown "
"by brightGrowFactor?")
Definition at line 124 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 150 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 161 of file detection.py.
◆ doThresholdScaling
|
static |
Initial value:
= Field(dtype=bool, default=True,
doc="Scale the threshold level to get empirically measured S/N requested?")
Definition at line 102 of file dynamicDetection.py.
◆ excludeMaskPlanes
|
staticinherited |
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
|
staticinherited |
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
|
staticinherited |
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.
◆ maxBackgroundTweak
|
static |
Initial value:
= Field(dtype=float, default=100.0, optional=True,
doc="Maximum background tweak allowed (i.e. it will be set to this "
"if the computed value is greater than it). Set to None for no limit.")
Definition at line 115 of file dynamicDetection.py.
◆ maxPeakToFootRatio
|
static |
Initial value:
= Field(dtype=float, default=150.0,
doc="Maximum ratio of peak per footprint in the detection mask. "
"This is to help prevent single contiguous footprints that nothing "
"can be done with (i.e. deblending will be skipped). If the current "
"detection plane does not satisfy this constraint, the detection "
"threshold is increased iteratively until it is. This behaviour is "
"intended to be an effective no-op for most \"typical\" scenes/standard "
"quality observations, but can avoid total meltdown in, e.g. very "
"crowded regions.")
Definition at line 156 of file dynamicDetection.py.
◆ maxThresholdScaleFactor
|
static |
Initial value:
= Field(dtype=float, default=10.0, optional=True,
doc="Maximum threshold scaling allowed (i.e. it will be set to this "
"if the computed value is greater than it). Set to None for no limit.")
Definition at line 107 of file dynamicDetection.py.
◆ minBackgroundTweak
|
static |
Initial value:
= Field(dtype=float, default=-100.0, optional=True,
doc="Mininum background tweak allowed (i.e. it will be set to this "
"if the computed value is smaller than it). Set to None for no limit.")
Definition at line 112 of file dynamicDetection.py.
◆ minFractionSources
|
static |
Initial value:
= Field(dtype=float, default=0.02,
doc="Minimum fraction of the requested number of sky sources for dynamic "
"detection to be considered a success. If the number of good sky sources "
"identified falls below this threshold, an InsufficientSourcesError error "
"is raised so that this dataId is no longer considered in downstream "
"processing.")
Definition at line 118 of file dynamicDetection.py.
◆ minGoodPixelFraction
|
static |
Initial value:
= Field(dtype=float, default=0.005,
doc="Minimum fraction of 'good' pixels required to be deemed "
"worthwhile for an attempt at further processing.")
Definition at line 99 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 73 of file detection.py.
◆ minThresholdScaleFactor
|
static |
Initial value:
= Field(dtype=float, default=0.1, optional=True,
doc="Mininum threshold scaling allowed (i.e. it will be set to this "
"if the computed value is smaller than it). Set to None for no limit.")
Definition at line 104 of file dynamicDetection.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 166 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 172 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 85 of file detection.py.
◆ prelimNegMultiplier
|
static |
Initial value:
= Field(dtype=float, default=2.5,
doc="Multiplier for the negative (relative to positive) polarity "
"detections threshold to use for first pass (to find sky objects).")
Definition at line 95 of file dynamicDetection.py.
◆ prelimThresholdFactor
|
static |
Initial value:
= Field(dtype=float, default=0.5,
doc="Factor by which to multiply the main detection threshold "
"(thresholdValue) to use for first pass (to find sky objects).")
Definition at line 92 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 128 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 89 of file detection.py.
◆ skyObjects
|
static |
Definition at line 98 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 178 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 144 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 155 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 114 of file detection.py.
◆ thresholdType
|
staticinherited |
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
|
staticinherited |
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/dynamicDetection.py
Generated on for lsst.meas.algorithms by
1.17.0