lsst.meas.algorithms  14.0-9-g82279ae0+5
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.detection.SourceDetectionConfig Class Reference

Configuration parameters for the SourceDetectionTask. More...

Inheritance diagram for lsst.meas.algorithms.detection.SourceDetectionConfig:

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 minPixels
 
 isotropicGrow
 
 nSigmaToGrow
 
 returnOriginalFootprints
 
 thresholdValue
 
 includeThresholdMultiplier
 
 thresholdType
 
 thresholdPolarity
 
 adjustBackground
 
 reEstimateBackground
 
 background
 
 tempLocalBackground
 
 doTempLocalBackground
 
 nPeaksMaxSimple
 

Detailed Description

Configuration parameters for the SourceDetectionTask.

Definition at line 36 of file detection.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 113 of file detection.py.

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 82 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 92 of file detection.py.

◆ doTempLocalBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.doTempLocalBackground
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do temporary interpolated background subtraction before footprint detection?",
default=True,
)

Definition at line 101 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 59 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 43 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 39 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 106 of file detection.py.

◆ nSigmaToGrow

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

Definition at line 47 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 87 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 51 of file detection.py.

◆ tempLocalBackground

lsst.meas.algorithms.detection.SourceDetectionConfig.tempLocalBackground
static
Initial value:
= pexConfig.ConfigurableField(
doc=("A seperate background estimation and removal before footprint and peak detection. "
"It is added back into the image after detection."),
target=SubtractBackgroundTask,
)

Definition at line 96 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 73 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 63 of file detection.py.

◆ thresholdValue

lsst.meas.algorithms.detection.SourceDetectionConfig.thresholdValue
static
Initial value:
= pexConfig.RangeField(
doc="Threshold for footprints",
dtype=float, optional=False, default=5.0, min=0.0,
)

Definition at line 55 of file detection.py.


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