lsst.ip.isr ged8ae655b3+57bee9966f
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Attributes | List of all members
lsst.ip.isr.isrTaskLSST.IsrTaskLSST Class Reference
Inheritance diagram for lsst.ip.isr.isrTaskLSST.IsrTaskLSST:

Public Member Functions

 __init__ (self, **kwargs)
 
 runQuantum (self, butlerQC, inputRefs, outputRefs)
 
 validateInput (self, inputs)
 
 diffNonLinearCorrection (self, ccdExposure, dnlLUT, **kwargs)
 
 overscanCorrection (self, ccd, ccdExposure)
 
 getLinearizer (self, detector)
 
 gainNormalize (self, **kwargs)
 
 updateVariance (self, ampExposure, amp, ptcDataset=None)
 
 maskNegativeVariance (self, exposure)
 
 variancePlane (self, ccdExposure, ccd, overscans, ptc)
 
 maskDefect (self, exposure, defectBaseList)
 
 maskEdges (self, exposure, numEdgePixels=0, maskPlane="SUSPECT", level='DETECTOR')
 
 maskNan (self, exposure)
 
 countBadPixels (self, exposure)
 
 flatContext (self, exp, flat, dark=None)
 
 getBrighterFatterKernel (self, detector, bfKernel)
 
 applyBrighterFatterCorrection (self, ccdExposure, flat, dark, bfKernel, bfGains)
 
 darkCorrection (self, exposure, darkExposure, invert=False)
 
 doLinearize (self, detector)
 
 makeBinnedImages (self, exposure)
 
 run (self, *ccdExposure, dnlLUT=None, bias=None, deferredChargeCalib=None, linearizer=None, ptc=None, crosstalk=None, defects=None, bfKernel=None, bfGains=None, dark=None, flat=None, **kwargs)
 

Static Public Member Functions

 extractCalibDate (calib)
 

Static Public Attributes

 ConfigClass = IsrTaskLSSTConfig
 

Static Protected Attributes

str _DefaultName = "isr"
 

Detailed Description

Definition at line 456 of file isrTaskLSST.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.__init__ (   self,
**  kwargs 
)

Definition at line 460 of file isrTaskLSST.py.

Member Function Documentation

◆ applyBrighterFatterCorrection()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.applyBrighterFatterCorrection (   self,
  ccdExposure,
  flat,
  dark,
  bfKernel,
  bfGains 
)

Definition at line 780 of file isrTaskLSST.py.

◆ countBadPixels()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.countBadPixels (   self,
  exposure 
)
Notes
-----
Reset and interpolate bad pixels.

Large contiguous bad regions (which should have the BAD mask
bit set) should have their values set to the image median.
This group should include defects and bad amplifiers. As the
area covered by these defects are large, there's little
reason to expect that interpolation would provide a more
useful value.

Smaller defects can be safely interpolated after the larger
regions have had their pixel values reset.  This ensures
that the remaining defects adjacent to bad amplifiers (as an
example) do not attempt to interpolate extreme values.

Definition at line 709 of file isrTaskLSST.py.

◆ darkCorrection()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.darkCorrection (   self,
  exposure,
  darkExposure,
  invert = False 
)
Apply dark correction in place.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to process.
darkExposure : `lsst.afw.image.Exposure`
    Dark exposure of the same size as ``exposure``.
invert : `Bool`, optional
    If True, re-add the dark to an already corrected image.

Raises
------
RuntimeError
    Raised if either ``exposure`` or ``darkExposure`` do not
    have their dark time defined.

See Also
--------
lsst.ip.isr.isrFunctions.darkCorrection

Definition at line 840 of file isrTaskLSST.py.

◆ diffNonLinearCorrection()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.diffNonLinearCorrection (   self,
  ccdExposure,
  dnlLUT,
**  kwargs 
)

Definition at line 496 of file isrTaskLSST.py.

◆ doLinearize()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.doLinearize (   self,
  detector 
)
Check if linearization is needed for the detector cameraGeom.

Checks config.doLinearize and the linearity type of the first
amplifier.

Parameters
----------
detector : `lsst.afw.cameraGeom.Detector`
    Detector to get linearity type from.

Returns
-------
doLinearize : `Bool`
    If True, linearization should be performed.

Definition at line 907 of file isrTaskLSST.py.

◆ extractCalibDate()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.extractCalibDate (   calib)
static
Extract common calibration metadata values that will be written to
output header.

Parameters
----------
calib : `lsst.afw.image.Exposure` or `lsst.ip.isr.IsrCalib`
    Calibration to pull date information from.

Returns
-------
dateString : `str`
    Calibration creation date string to add to header.

Definition at line 883 of file isrTaskLSST.py.

◆ flatContext()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.flatContext (   self,
  exp,
  flat,
  dark = None 
)
Context manager that applies and removes flats and darks,
if the task is configured to apply them.

Parameters
----------
exp : `lsst.afw.image.Exposure`
    Exposure to process.
flat : `lsst.afw.image.Exposure`
    Flat exposure the same size as ``exp``.
dark : `lsst.afw.image.Exposure`, optional
    Dark exposure the same size as ``exp``.

Yields
------
exp : `lsst.afw.image.Exposure`
    The flat and dark corrected exposure.

Definition at line 732 of file isrTaskLSST.py.

◆ gainNormalize()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.gainNormalize (   self,
**  kwargs 
)

Definition at line 534 of file isrTaskLSST.py.

◆ getBrighterFatterKernel()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.getBrighterFatterKernel (   self,
  detector,
  bfKernel 
)

Definition at line 762 of file isrTaskLSST.py.

◆ getLinearizer()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.getLinearizer (   self,
  detector 
)

Definition at line 524 of file isrTaskLSST.py.

◆ makeBinnedImages()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.makeBinnedImages (   self,
  exposure 
)
Make visualizeVisit style binned exposures.

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

Returns
-------
bin1 : `lsst.afw.image.Exposure`
    Binned exposure using binFactor1.
bin2 : `lsst.afw.image.Exposure`
    Binned exposure using binFactor2.

Definition at line 926 of file isrTaskLSST.py.

◆ maskDefect()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.maskDefect (   self,
  exposure,
  defectBaseList 
)
Mask defects using mask plane "BAD", in place.

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

defectBaseList : defect-type
    List of defects to mask. Can be of type  `lsst.ip.isr.Defects`
    or `list` of `lsst.afw.image.DefectBase`.

Definition at line 629 of file isrTaskLSST.py.

◆ maskEdges()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.maskEdges (   self,
  exposure,
  numEdgePixels = 0,
  maskPlane = "SUSPECT",
  level = 'DETECTOR' 
)
Mask edge pixels with applicable mask plane.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to process.
numEdgePixels : `int`, optional
    Number of edge pixels to mask.
maskPlane : `str`, optional
    Mask plane name to use.
level : `str`, optional
    Level at which to mask edges.

Definition at line 649 of file isrTaskLSST.py.

◆ maskNan()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.maskNan (   self,
  exposure 
)
Mask NaNs using mask plane "UNMASKEDNAN", in place.

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

Notes
-----
We mask over all non-finite values (NaN, inf), including those
that are masked with other bits (because those may or may not be
interpolated over later, and we want to remove all NaN/infs).
Despite this behaviour, the "UNMASKEDNAN" mask plane is used to
preserve the historical name.

Definition at line 683 of file isrTaskLSST.py.

◆ maskNegativeVariance()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.maskNegativeVariance (   self,
  exposure 
)
Identify and mask pixels with negative variance values.

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

See Also
--------
lsst.ip.isr.isrFunctions.updateVariance

Definition at line 595 of file isrTaskLSST.py.

◆ overscanCorrection()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.overscanCorrection (   self,
  ccd,
  ccdExposure 
)

Definition at line 501 of file isrTaskLSST.py.

◆ run()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.run (   self,
ccdExposure,
  dnlLUT = None,
  bias = None,
  deferredChargeCalib = None,
  linearizer = None,
  ptc = None,
  crosstalk = None,
  defects = None,
  bfKernel = None,
  bfGains = None,
  dark = None,
  flat = None,
**  kwargs 
)

Definition at line 948 of file isrTaskLSST.py.

◆ runQuantum()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.runQuantum (   self,
  butlerQC,
  inputRefs,
  outputRefs 
)

Definition at line 469 of file isrTaskLSST.py.

◆ updateVariance()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.updateVariance (   self,
  ampExposure,
  amp,
  ptcDataset = None 
)
Set the variance plane using the gain and read noise.

Parameters
----------
ampExposure : `lsst.afw.image.Exposure`
    Exposure to process.
amp : `lsst.afw.cameraGeom.Amplifier` or `FakeAmp`
    Amplifier detector data.
ptcDataset : `lsst.ip.isr.PhotonTransferCurveDataset`, optional
    PTC dataset containing the gains and read noise.

Raises
------
RuntimeError
    Raised if ptcDataset is not provided.

See also
--------
lsst.ip.isr.isrFunctions.updateVariance

Definition at line 541 of file isrTaskLSST.py.

◆ validateInput()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.validateInput (   self,
  inputs 
)
This is a check that all the inputs required by the config
are available.

Definition at line 475 of file isrTaskLSST.py.

◆ variancePlane()

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.variancePlane (   self,
  ccdExposure,
  ccd,
  overscans,
  ptc 
)

Definition at line 612 of file isrTaskLSST.py.

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.isrTaskLSST.IsrTaskLSST._DefaultName = "isr"
staticprotected

Definition at line 458 of file isrTaskLSST.py.

◆ ConfigClass

lsst.ip.isr.isrTaskLSST.IsrTaskLSST.ConfigClass = IsrTaskLSSTConfig
static

Definition at line 457 of file isrTaskLSST.py.


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