lsst.meas.algorithms  13.0-20-g02a2147
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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
 

Static Public Attributes

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

Detailed Description

Configuration parameters for the SourceDetectionTask.

Definition at line 36 of file detection.py.

Member Function Documentation

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

Definition at line 113 of file detection.py.

Member Data Documentation

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.adjustBackground
static
Initial value:
1 = pexConfig.Field(
2  dtype=float,
3  doc="Fiddle factor to add to the background; debugging only",
4  default=0.0,
5  )

Definition at line 82 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.background
static
Initial value:
1 = pexConfig.ConfigurableField(
2  doc="Background re-estimation; ignored if reEstimateBackground false",
3  target=SubtractBackgroundTask,
4  )

Definition at line 92 of file detection.py.

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

Definition at line 101 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.includeThresholdMultiplier
static
Initial value:
1 = pexConfig.RangeField(
2  doc="Include threshold relative to thresholdValue",
3  dtype=float, default=1.0, min=0.0,
4  )

Definition at line 59 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.isotropicGrow
static
Initial value:
1 = pexConfig.Field(
2  doc="Pixels should be grown as isotropically as possible (slower)",
3  dtype=bool, optional=False, default=False,
4  )

Definition at line 43 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.minPixels
static
Initial value:
1 = pexConfig.RangeField(
2  doc="detected sources with fewer than the specified number of pixels will be ignored",
3  dtype=int, optional=False, default=1, min=0,
4  )

Definition at line 39 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.nPeaksMaxSimple
static
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc=("The maximum number of peaks in a Footprint before trying to "
4  "replace its peaks using the temporary local background"),
5  default=1,
6  )

Definition at line 106 of file detection.py.

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

Definition at line 47 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.reEstimateBackground
static
Initial value:
1 = pexConfig.Field(
2  dtype=bool,
3  doc="Estimate the background again after final source detection?",
4  default=True, optional=False,
5  )

Definition at line 87 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.returnOriginalFootprints
static
Initial value:
1 = pexConfig.Field(
2  doc="Grow detections to set the image mask bits, but return the original (not-grown) footprints",
3  dtype=bool, optional=False, default=False,
4  )

Definition at line 51 of file detection.py.

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

Definition at line 96 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.thresholdPolarity
static
Initial value:
1 = pexConfig.ChoiceField(
2  doc="specifies whether to detect positive, or negative sources, or both",
3  dtype=str, optional=False, default="positive",
4  allowed={
5  "positive": "detect only positive sources",
6  "negative": "detect only negative sources",
7  "both": "detect both positive and negative sources",
8  },
9  )

Definition at line 73 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.thresholdType
static
Initial value:
1 = pexConfig.ChoiceField(
2  doc="specifies the desired flavor of Threshold",
3  dtype=str, optional=False, default="stdev",
4  allowed={
5  "variance": "threshold applied to image variance",
6  "stdev": "threshold applied to image std deviation",
7  "value": "threshold applied to image value",
8  "pixel_stdev": "threshold applied to per-pixel std deviation",
9  },
10  )

Definition at line 63 of file detection.py.

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

Definition at line 55 of file detection.py.


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