Public Member Functions
	__init__ (self, masked_image, defects=["SAT"], fwhm=5, bin_image=True, bin_spacing=10, threshold_dynamic_binning=1000, threshold_subdivide=20000, correlation_length_cut=5, log=None)

	run (self)

	interpolate_masked_sub_image (self, masked_sub_image)

Public Attributes
	log = log or logging.getLogger(__name__)

	bin_image = bin_image

	bin_spacing = bin_spacing

	threshold_subdivide = threshold_subdivide

	threshold_dynamic_binning = threshold_dynamic_binning

	masked_image = masked_image

list	defects = defects

	correlation_length = fwhm

	correlation_length_cut = correlation_length_cut

	interpBit = self.masked_image.mask.getPlaneBitMask("INTRP")

Protected Member Functions
	_good_pixel_binning (self, pixels)

Detailed Description

InterpolateOverDefectGaussianProcess class performs Gaussian Process
(GP) interpolation over defects in an image.

Parameters:
-----------
masked_image : `lsst.afw.image.MaskedImage`
    The masked image containing the defects to be interpolated.
defects : `list`[`str`], optional
    The types of defects to be interpolated. Default is ["SAT"].
fwhm : `float`, optional
    The full width at half maximum (FWHM) of the PSF. Default is 5.
bin_spacing : `int`, optional
    The spacing between bins for good pixel binning. Default is 10.
threshold_dynamic_binning : `int`, optional
    The threshold for dynamic binning. Default is 1000.
threshold_subdivide : `int`, optional
    The threshold for sub-dividing the bad pixel array to avoid memory error. Default is 20000.
correlation_length_cut : `int`, optional
    The factor by which to dilate the bounding box around defects. Default is 5.
log : `lsst.log.Log`, `logging.Logger` or `None`, optional
    Logger object used to write out messages. If `None` a default
    logger will be used.

Definition at line 168 of file gp_interpolation.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.__init__	(	self,
		masked_image,
		defects = ["SAT"],
		fwhm = 5,
		bin_image = True,
		bin_spacing = 10,
		threshold_dynamic_binning = 1000,
		threshold_subdivide = 20000,
		correlation_length_cut = 5,
		log = None )

Definition at line 194 of file gp_interpolation.py.

Member Function Documentation

◆ _good_pixel_binning()

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess._good_pixel_binning	(		self,
			pixels )

protected

Performs pixel binning using treegp.meanify

Parameters:
-----------
pixels : `np.array`
    The array of pixels.

Returns:
--------
`np.array`
    The binned array of pixels.

Definition at line 255 of file gp_interpolation.py.

◆ interpolate_masked_sub_image()

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.interpolate_masked_sub_image	(		self,
			masked_sub_image )

Interpolate the masked sub-image.

Parameters:
-----------
masked_sub_image : `lsst.afw.image.MaskedImage`
    The sub-masked image to be interpolated.

Returns:
--------
`lsst.afw.image.MaskedImage`
    The interpolated sub-masked image.

Definition at line 286 of file gp_interpolation.py.

◆ run()

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.run ( self )

Interpolate over the defects in the image.

Change self.masked_image .

Definition at line 221 of file gp_interpolation.py.

Member Data Documentation

◆ bin_image

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.bin_image = bin_image

Definition at line 209 of file gp_interpolation.py.

◆ bin_spacing

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.bin_spacing = bin_spacing

Definition at line 210 of file gp_interpolation.py.

◆ correlation_length

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.correlation_length = fwhm

Definition at line 216 of file gp_interpolation.py.

◆ correlation_length_cut

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.correlation_length_cut = correlation_length_cut

Definition at line 217 of file gp_interpolation.py.

◆ defects

list lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.defects = defects

Definition at line 215 of file gp_interpolation.py.

◆ interpBit

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.interpBit = self.masked_image.mask.getPlaneBitMask("INTRP")

Definition at line 219 of file gp_interpolation.py.

◆ log

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.log = log or logging.getLogger(__name__)

Definition at line 207 of file gp_interpolation.py.

◆ masked_image

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.masked_image = masked_image

Definition at line 214 of file gp_interpolation.py.

◆ threshold_dynamic_binning

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.threshold_dynamic_binning = threshold_dynamic_binning

Definition at line 212 of file gp_interpolation.py.

◆ threshold_subdivide

lsst.meas.algorithms.gp_interpolation.InterpolateOverDefectGaussianProcess.threshold_subdivide = threshold_subdivide

Definition at line 211 of file gp_interpolation.py.

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

python/lsst/meas/algorithms/gp_interpolation.py

Public Member Functions

Public Attributes

Protected Member Functions