lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.interpImage.InterpImageTask Class Reference
Inheritance diagram for lsst.pipe.tasks.interpImage.InterpImageTask:

Public Member Functions

def run (self, image, planeName=None, fwhmPixels=None, defects=None)
 Interpolate in place over pixels in a maskedImage marked as bad. More...
 

Static Public Attributes

 ConfigClass = InterpImageConfig
 

Detailed Description

Interpolate over bad image pixels

Definition at line 74 of file interpImage.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.interpImage.InterpImageTask.run (   self,
  image,
  planeName = None,
  fwhmPixels = None,
  defects = None 
)

Interpolate in place over pixels in a maskedImage marked as bad.

Pixels to be interpolated are set by either a mask planeName provided by the caller OR a defects list of type measAlg.DefectListT. If both are provided an exception is raised.

Note that the interpolation code in meas_algorithms currently doesn't use the input PSF (though it's a required argument), so it's not important to set the input PSF parameters exactly. This PSF is set here as the psf attached to the "image" (i.e if the image passed in is an Exposure). Otherwise, a psf model is created using measAlg.GaussianPsfFactory with the value of fwhmPixels (the value passed in by the caller, or the default defaultFwhm set in measAlg.GaussianPsfFactory if None).

Parameters
[in,out]imageMaskedImage OR Exposure to be interpolated
[in]planeNamename of mask plane over which to interpolate If None, must provide a defects list.
[in]fwhmPixelsFWHM of core star (pixels) If None the default is used, where the default is set to the exposure psf if available
[in]defectsList of defects of type measAlg.DefectListT over which to interpolate.

Definition at line 114 of file interpImage.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.interpImage.InterpImageTask.ConfigClass = InterpImageConfig
static

Definition at line 77 of file interpImage.py.


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