lsst.pipe.tasks.snapCombine.SnapCombineConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.snapCombine.SnapCombineConfig:

Public Member Functions
def	setDefaults (self)
def	validate (self)

Static Public Attributes
	doRepair
	repairPsfFwhm
	doDiffIm
	doPsfMatch
	doMeasurement
	badMaskPlanes
	averageKeys
	sumKeys
	repair = pexConfig.ConfigurableField(target=RepairTask, doc="")
	diffim = pexConfig.ConfigurableField(target=SnapPsfMatchTask, doc="")
	detection = pexConfig.ConfigurableField(target=SourceDetectionTask, doc="")
	initialPsf = pexConfig.ConfigField(dtype=InitialPsfConfig, doc="")
	measurement = pexConfig.ConfigurableField(target=SingleFrameMeasurementTask, doc="")

Detailed Description

Definition at line 69 of file snapCombine.py.

Member Function Documentation

setDefaults()

def lsst.pipe.tasks.snapCombine.SnapCombineConfig.setDefaults

(

self

)

Definition at line 121 of file snapCombine.py.

    def setDefaults(self):
        self.detection.thresholdPolarity = "both"
 

validate()

def lsst.pipe.tasks.snapCombine.SnapCombineConfig.validate

(

self

)

Definition at line 124 of file snapCombine.py.

    def validate(self):
        if self.detection.thresholdPolarity != "both":
            raise ValueError("detection.thresholdPolarity must be 'both' for SnapCombineTask")
 

Member Data Documentation

averageKeys

lsst.pipe.tasks.snapCombine.SnapCombineConfig.averageKeys

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        doc="List of float metadata keys to average when combining snaps, e.g. float positions and dates; "
        "non-float data must be handled by overriding the fixMetadata method",
        optional=True,
 
    )

Definition at line 101 of file snapCombine.py.

badMaskPlanes

lsst.pipe.tasks.snapCombine.SnapCombineConfig.badMaskPlanes

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        doc="Mask planes that, if set, the associated pixels are not included in the combined exposure; "
        "DETECTED excludes cosmic rays",
        default=("DETECTED",),
    )

Definition at line 95 of file snapCombine.py.

detection

lsst.pipe.tasks.snapCombine.SnapCombineConfig.detection = pexConfig.ConfigurableField(target=SourceDetectionTask, doc="")

static

Definition at line 117 of file snapCombine.py.

diffim

lsst.pipe.tasks.snapCombine.SnapCombineConfig.diffim = pexConfig.ConfigurableField(target=SnapPsfMatchTask, doc="")

static

Definition at line 116 of file snapCombine.py.

doDiffIm

lsst.pipe.tasks.snapCombine.SnapCombineConfig.doDiffIm

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Perform difference imaging before combining",
        default=False,
    )

Definition at line 80 of file snapCombine.py.

doMeasurement

lsst.pipe.tasks.snapCombine.SnapCombineConfig.doMeasurement

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Measure difference sources (ignored if doDiffIm false)",
        default=True,
    )

Definition at line 90 of file snapCombine.py.

doPsfMatch

lsst.pipe.tasks.snapCombine.SnapCombineConfig.doPsfMatch

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Perform PSF matching for difference imaging (ignored if doDiffIm false)",
        default=True,
    )

Definition at line 85 of file snapCombine.py.

doRepair

lsst.pipe.tasks.snapCombine.SnapCombineConfig.doRepair

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Repair images (CR reject and interpolate) before combining",
        default=True,
    )

Definition at line 70 of file snapCombine.py.

initialPsf

lsst.pipe.tasks.snapCombine.SnapCombineConfig.initialPsf = pexConfig.ConfigField(dtype=InitialPsfConfig, doc="")

static

Definition at line 118 of file snapCombine.py.

measurement

lsst.pipe.tasks.snapCombine.SnapCombineConfig.measurement = pexConfig.ConfigurableField(target=SingleFrameMeasurementTask, doc="")

static

Definition at line 119 of file snapCombine.py.

repair

lsst.pipe.tasks.snapCombine.SnapCombineConfig.repair = pexConfig.ConfigurableField(target=RepairTask, doc="")

static

Definition at line 115 of file snapCombine.py.

repairPsfFwhm

lsst.pipe.tasks.snapCombine.SnapCombineConfig.repairPsfFwhm

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Psf FWHM (pixels) used to detect CRs",
        default=2.5,
    )

Definition at line 75 of file snapCombine.py.

sumKeys

lsst.pipe.tasks.snapCombine.SnapCombineConfig.sumKeys

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        doc="List of float or int metadata keys to sum when combining snaps, e.g. exposure time; "
        "non-float, non-int data must be handled by overriding the fixMetadata method",
        optional=True,
    )

Definition at line 108 of file snapCombine.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/snapCombine.py