lsst.cp.pipe  21.0.0-22-gd45243f+75349ef5b2
Public Member Functions | Static Public Attributes | List of all members
lsst.cp.pipe.defects.FindDefectsTask Class Reference
Inheritance diagram for lsst.cp.pipe.defects.FindDefectsTask:

Public Member Functions

def __init__ (self, **kwargs)
 
def runDataRef (self, dataRefList)
 

Static Public Attributes

 ConfigClass = FindDefectsTaskConfig
 
 RunnerClass = DataRefListRunner
 

Detailed Description

Task for finding defects in sensors.

The task has two modes of operation, defect finding in raws and in
master calibrations, which work as follows.

Master calib defect finding
----------------------------

A single visit number is supplied, for which the corresponding flat & dark
will be used. This is because, at present at least, there is no way to pass
a calibration exposure ID from the command line to a command line task.

The task retrieves the corresponding dark and flat exposures for the
supplied visit. If a flat is available the task will (be able to) look
for both bright and dark defects. If only a dark is found then only bright
defects will be sought.

All pixels above/below the specified nSigma which lie with the specified
borders for flats/darks are identified as defects.

Raw visit defect finding
------------------------

A list of exposure IDs are supplied for defect finding. The task will
detect bright pixels in the dark frames, if supplied, and bright & dark
pixels in the flats, if supplied, i.e. if you only supply darks you will
only be given bright defects. This is done automatically from the imageType
of the exposure, so the input exposure list can be a mix.

As with the master calib detection, all pixels above/below the specified
nSigma which lie with the specified borders for flats/darks are identified
as defects. Then, a post-processing step is done to merge these detections,
with pixels appearing in a fraction [0..1] of the images are kept as defects
and those appearing below that occurrence-threshold are discarded.

Definition at line 740 of file defects.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.cp.pipe.defects.FindDefectsTask.__init__ (   self,
**  kwargs 
)

Definition at line 781 of file defects.py.

Member Function Documentation

◆ runDataRef()

def lsst.cp.pipe.defects.FindDefectsTask.runDataRef (   self,
  dataRefList 
)
Run the defect finding task.

Find the defects, as described in the main task docstring, from a
dataRef and a list of visit(s).

Parameters
----------
dataRefList : `list` [`lsst.daf.persistence.ButlerDataRef`]
    dataRefs for the data to be checked for defects.

Returns
-------
result : `lsst.pipe.base.Struct`
    Result struct with Components:

    - ``defects`` : `lsst.ip.isr.Defect`
      The defects found by the task.
    - ``exitStatus`` : `int`
      The exit code.

Definition at line 787 of file defects.py.

Member Data Documentation

◆ ConfigClass

lsst.cp.pipe.defects.FindDefectsTask.ConfigClass = FindDefectsTaskConfig
static

Definition at line 776 of file defects.py.

◆ RunnerClass

lsst.cp.pipe.defects.FindDefectsTask.RunnerClass = DataRefListRunner
static

Definition at line 779 of file defects.py.


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