lsst.cp.pipe.cpFringeTask.CpFringeTask Class Reference

Inheritance diagram for lsst.cp.pipe.cpFringeTask.CpFringeTask:

Public Member Functions
def	__init__ (self, **kwargs)
def	run (self, inputExp)

Static Public Attributes
	ConfigClass = CpFringeTaskConfig

Detailed Description

Combine pre-processed fringe frames into a proposed master calibration.

Definition at line 73 of file cpFringeTask.py.

Constructor & Destructor Documentation

__init__()

def lsst.cp.pipe.cpFringeTask.CpFringeTask.__init__	(		self,
		**	kwargs
	)

Definition at line 80 of file cpFringeTask.py.

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.makeSubtask("stats")
        self.makeSubtask("subtractBackground")
        self.makeSubtask("detection")
 

Member Function Documentation

run()

def lsst.cp.pipe.cpFringeTask.CpFringeTask.run	(		self,
			inputExp
	)

Preprocess input exposures prior to FRINGE combination.

This task scales and renormalizes the input frame based on the
image background, and then masks all pixels above the
detection threshold.

Parameters
----------
inputExp : `lsst.afw.image.Exposure`
    Pre-processed fringe frame data to combine.

Returns
-------
outputExp : `lsst.afw.image.Exposure`
    Fringe pre-processed frame.

Definition at line 86 of file cpFringeTask.py.

    def run(self, inputExp):
        """Preprocess input exposures prior to FRINGE combination.
 
        This task scales and renormalizes the input frame based on the
        image background, and then masks all pixels above the
        detection threshold.
 
        Parameters
        ----------
        inputExp : `lsst.afw.image.Exposure`
            Pre-processed fringe frame data to combine.
 
        Returns
        -------
        outputExp : `lsst.afw.image.Exposure`
            Fringe pre-processed frame.
 
        """
        bg = self.stats.run(inputExp)
        self.subtractBackground.run(inputExp)
        mi = inputExp.getMaskedImage()
        mi /= bg
 
        fpSets = self.detection.detectFootprints(inputExp, sigma=self.config.detectSigma)
        mask = mi.getMask()
        detected = 1 << mask.addMaskPlane("DETECTED")
        for fpSet in (fpSets.positive, fpSets.negative):
            if fpSet is not None:
                afwDet.setMaskFromFootprintList(mask, fpSet.getFootprints(), detected)
 
        return pipeBase.Struct(
            outputExp=inputExp,
        )

Member Data Documentation

ConfigClass

lsst.cp.pipe.cpFringeTask.CpFringeTask.ConfigClass = CpFringeTaskConfig

static

Definition at line 77 of file cpFringeTask.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.6.0/Linux64/cp_pipe/22.0.1-18-gb17765a+2264247a6b/python/lsst/cp/pipe/cpFringeTask.py