lsst.pipe.tasks g52b7b5de59+d0206f4c2c
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...
 
def transposeContext (self, maskedImage, defects)
 
def interpolateImage (self, maskedImage, psf, defectList, fallbackValue)
 

Static Public Attributes

 ConfigClass = InterpImageConfig
 

Detailed Description

Interpolate over bad image pixels

Definition at line 80 of file interpImage.py.

Member Function Documentation

◆ interpolateImage()

def lsst.pipe.tasks.interpImage.InterpImageTask.interpolateImage (   self,
  maskedImage,
  psf,
  defectList,
  fallbackValue 
)
Interpolate over defects in an image

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    Image on which to perform interpolation.
psf : `lsst.afw.detection.Psf`
    Point-spread function; currently unused.
defectList : `lsst.meas.algorithms.Defects`
    List of defects to interpolate over.
fallbackValue : `float`
    Value to set when interpolation fails.

Definition at line 229 of file interpImage.py.

◆ 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 `~lsst.meas.algorithms.Defects`
    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).

    @param[in,out] image       MaskedImage OR Exposure to be interpolated
    @param[in]     planeName   name of mask plane over which to interpolate
                               If None, must provide a defects list.
    @param[in]     fwhmPixels  FWHM of core star (pixels)
                               If None the default is used, where the default
                               is set to the exposure psf if available
    @param[in]     defects     List of defects of type ipIsr.Defects
                               over which to interpolate.

Definition at line 120 of file interpImage.py.

◆ transposeContext()

def lsst.pipe.tasks.interpImage.InterpImageTask.transposeContext (   self,
  maskedImage,
  defects 
)
Context manager to potentially transpose an image

This applies the ``transpose`` configuration setting.

Transposing the image allows us to interpolate along columns instead
of rows, which is useful when the saturation trails are typically
oriented along rows on the warped/coadded images, instead of along
columns as they typically are in raw CCD images.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    Image on which to perform interpolation.
defects : `lsst.meas.algorithms.Defects`
    List of defects to interpolate over.

Yields
------
useImage : `lsst.afw.image.MaskedImage`
    Image to use for interpolation; it may have been transposed.
useDefects : `lsst.meas.algorithms.Defects`
    List of defects to use for interpolation; they may have been
    transposed.

Definition at line 186 of file interpImage.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 83 of file interpImage.py.


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