lsst.meas.algorithms.detection.SourceDetectionConfig Class Reference

Configuration parameters for the SourceDetectionTask. More...

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

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

Detailed Description

Configuration parameters for the SourceDetectionTask.

Definition at line 110 of file detection.py.

Member Data Documentation

tuple 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 156 of file detection.py.

tuple lsst.meas.algorithms.detection.SourceDetectionConfig.background

static

Initial value:

= pexConfig.ConfigField(
        dtype=BackgroundConfig,
        doc="Background re-estimation configuration"
    )

Definition at line 166 of file detection.py.

tuple 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 133 of file detection.py.

tuple 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 117 of file detection.py.

tuple 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 113 of file detection.py.

tuple 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 121 of file detection.py.

tuple 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 161 of file detection.py.

tuple 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=True    # TODO: set default to False once we have a deblender; ticket #2138
    )

Definition at line 125 of file detection.py.

tuple 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 147 of file detection.py.

tuple 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 137 of file detection.py.

tuple 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 129 of file detection.py.

---

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

• /home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/python/lsst/meas/algorithms/detection.py