lsst.ip.isr g7aa544c432+6b540e6ada
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.straylight.StrayLightTask Class Reference
Inheritance diagram for lsst.ip.isr.straylight.StrayLightTask:

Public Member Functions

def readIsrData (self, dataRef, rawExposure)
 
def check (self, exposure)
 
def run (self, exposure, strayLightData)
 
def checkFilter (self, exposure)
 

Static Public Attributes

 ConfigClass = StrayLightConfig
 

Detailed Description

Remove stray light from instruments.

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

Definition at line 45 of file straylight.py.

Member Function Documentation

◆ check()

def 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 82 of file straylight.py.

◆ checkFilter()

def 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 105 of file straylight.py.

◆ readIsrData()

def lsst.ip.isr.straylight.StrayLightTask.readIsrData (   self,
  dataRef,
  rawExposure 
)
Read and return calibration products relevant for correcting
stray light in the given exposure.

Parameters
----------
dataRef : `daf.persistence.butlerSubset.ButlerDataRef`
    Butler reference of the detector data to be processed
rawExposure : `afw.image.Exposure`
    The raw exposure that will later be corrected with the
    retrieved calibration data; should not be modified in this
    method.

Returns
-------
straylightData : `object`, optional
    An opaque object that should be passed as the second argument to
    the `run` method.  If `None`, no stray light correction will be
    performed for the given image.  Any other object (e.g. `True`)
    may be used to signal that stray light correction should be
    performed even if there is nothing to read.

Notes
-----
This method will be called only when `IsrTask` is run by the Gen2
Middleware (i.e. CmdLineTask).

Definition at line 53 of file straylight.py.

◆ run()

def 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 92 of file straylight.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 50 of file straylight.py.


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