lsst.ip.diffim.psfMatch.DetectionConfig Class Reference

Configuration for detecting sources on images for building a PSF-matching kernel. More...

Inheritance diagram for lsst.ip.diffim.psfMatch.DetectionConfig:

Static Public Attributes
tuple	detThreshold
tuple	detThresholdType
tuple	detOnTemplate
tuple	badMaskPlanes
tuple	fpNpixMin
tuple	fpNpixMax
tuple	fpGrowKernelScaling
tuple	fpGrowPix
tuple	scaleByFwhm

Detailed Description

Configuration for detecting sources on images for building a PSF-matching kernel.

Configuration for turning detected lsst.afw.detection.FootPrints into an acceptable (unmasked, high signal-to-noise, not too large or not too small) list of lsst.ip.diffim.KernelSources that are used to build the Psf-matching kernel

Definition at line 35 of file psfMatch.py.

Member Data Documentation

tuple lsst.ip.diffim.psfMatch.DetectionConfig.badMaskPlanes

static

Initial value:

= pexConfig.ListField(
        dtype = str,
        doc = """Mask planes that lead to an invalid detection.         Options: NO_DATA EDGE SAT BAD CR INTRP""",
        default = ("NO_DATA", "EDGE", "SAT")
    )

Definition at line 65 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.detOnTemplate

static

Initial value:

= pexConfig.Field(
        dtype = bool,
        doc = """If true run detection on the template (image to convolve);         if false run detection on the science image""",
        default = True
    )

Definition at line 59 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.detThreshold

static

Initial value:

= pexConfig.Field(
        dtype = float,
        doc = "Value of footprint detection threshold",
        default = 10.0,
        check = lambda x : x >= 3.0
    )

Definition at line 42 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.detThresholdType

static

Initial value:

= pexConfig.ChoiceField(
        dtype = str,
        doc = "Type of detection threshold",
        default = "pixel_stdev",
        allowed = {
           "value"       : "Use counts as the detection threshold type",
           "stdev"       : "Use standard deviation of image plane",
           "variance"    : "Use variance of image plane",
           "pixel_stdev" : "Use stdev derived from variance plane"
        }
    )

Definition at line 48 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.fpGrowKernelScaling

static

Initial value:

= pexConfig.Field(
        dtype = float,
        doc = """If config.scaleByFwhm, grow the footprint based on         the final kernelSize.  Each footprint will be         2*fpGrowKernelScaling*kernelSize x         2*fpGrowKernelScaling*kernelSize.  With the value         of 1.0, the remaining pixels in each KernelCandiate         after convolution by the basis functions will be         eqaul to the kernel size iteslf.""",
        default = 1.0,
        check = lambda x : x >= 1.0
    )

Definition at line 84 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.fpGrowPix

static

Initial value:

= pexConfig.Field(
        dtype = int,
        doc = """Growing radius (in pixels) for each raw detection         footprint.  The smaller the faster; however the         kernel sum does not converge if the stamp is too         small; and the kernel is not constrained at all if         the stamp is the size of the kernel.  The grown stamp         is 2 * fpGrowPix pixels larger in each dimension.         This is overridden by fpGrowKernelScaling if scaleByFwhm""",
        default = 30,
        check = lambda x : x >= 10
    )

Definition at line 96 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.fpNpixMax

static

Initial value:

= pexConfig.Field(
        dtype = int,
        doc = """Maximum number of pixels in an acceptable Footprint;         too big and the subsequent convolutions become unwieldy""",
        default = 500,
        check = lambda x : x <= 500
    )

Definition at line 77 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.fpNpixMin

static

Initial value:

= pexConfig.Field(
        dtype = int,
        doc = "Minimum number of pixels in an acceptable Footprint",
        default = 5,
        check = lambda x : x >= 5
    )

Definition at line 71 of file psfMatch.py.

tuple lsst.ip.diffim.psfMatch.DetectionConfig.scaleByFwhm

static

Initial value:

= pexConfig.Field(
        dtype = bool,
        doc = "Scale fpGrowPix by input Fwhm?",
        default = True,
    )

Definition at line 108 of file psfMatch.py.

---

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

• /home/lsstsw/stack/Linux64/ip_diffim/11.0+1/python/lsst/ip/diffim/psfMatch.py