Inheritance diagram for lsst.ip.isr.straylight.StrayLightTask:

Public Member Functions
	check (self, exposure)

	run (self, exposure, strayLightData)

	checkFilter (self, exposure)

Static Public Attributes
	ConfigClass = StrayLightConfig

Static Protected Attributes
str	_DefaultName = "isrStrayLight"

Detailed Description

Remove stray light from instruments.

This is a dummy task to be retargeted with an camera-specific version.

Definition at line 48 of file straylight.py.

Member Function Documentation

◆ check()

lsst.ip.isr.straylight.StrayLightTask.check	(		self,
			exposure )

Check if stray light correction should be run.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to correct.

Definition at line 56 of file straylight.py.

    def check(self, exposure):
        """Check if stray light correction should be run.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure to correct.
        """
        return False
 

◆ checkFilter()

lsst.ip.isr.straylight.StrayLightTask.checkFilter	(		self,
			exposure )

Check whether we should fringe-subtract the science exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to check the filter of.

Returns
-------
needsFringe : `bool`
    If True, then the exposure has a filter listed in the
    configuration, and should have the fringe applied.

Definition at line 79 of file straylight.py.

    def checkFilter(self, exposure):
        """Check whether we should fringe-subtract the science exposure.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure to check the filter of.
 
        Returns
        -------
        needsFringe : `bool`
            If True, then the exposure has a filter listed in the
            configuration, and should have the fringe applied.
        """
        return checkFilter(exposure, self.config.filters, log=self.log)
 
 

◆ run()

lsst.ip.isr.straylight.StrayLightTask.run	(	self,
		exposure,
		strayLightData )

Correct stray light.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
   Exposure to correct.
strayLightData : `object`, optional
    An opaque object that contains any calibration data used to
    correct for stray light.

Definition at line 66 of file straylight.py.

    def run(self, exposure, strayLightData):
        """Correct stray light.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
           Exposure to correct.
        strayLightData : `object`, optional
            An opaque object that contains any calibration data used to
            correct for stray light.
        """
        raise NotImplementedError("Must be implemented by subclasses.")
 

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.straylight.StrayLightTask._DefaultName = "isrStrayLight"

staticprotected

Definition at line 54 of file straylight.py.

◆ ConfigClass

lsst.ip.isr.straylight.StrayLightTask.ConfigClass = StrayLightConfig

static

Definition at line 53 of file straylight.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+7bcba2e4e8/python/lsst/ip/isr/straylight.py

Public Member Functions

Static Public Attributes

Static Protected Attributes