Inheritance diagram for lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator:

Public Member Functions
	__init__ (self, var, mean=None, rand=None)

	__str__ (self)

	getImage (self, bb)

Public Attributes
	var

	mean

Detailed Description

Generates Gaussian noise with variance matching an image variance plane.

Parameters
----------
var : `lsst.afw.image.ImageF`
    The input variance image.
mean : `float` or `lsst.afw.image.Image`, optional.
    Mean value for the generated noise.

Definition at line 492 of file noiseReplacer.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.__init__	(	self,
		var,
		mean = None,
		rand = None )

Reimplemented from lsst.meas.base.noiseReplacer.GaussianNoiseGenerator.

Definition at line 503 of file noiseReplacer.py.

    def __init__(self, var, mean=None, rand=None):
        super(VariancePlaneNoiseGenerator, self).__init__(rand=rand)
        self.var = var
        if mean is not None and mean == 0.:
            mean = None
        self.mean = mean
 

Member Function Documentation

◆ str()

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.__str__ ( self )

Definition at line 510 of file noiseReplacer.py.

    def __str__(self):
        return 'VariancePlaneNoiseGenerator: mean=' + str(self.mean)
 

◆ getImage()

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.getImage	(		self,
			bb )

Reimplemented from lsst.meas.base.noiseReplacer.NoiseGenerator.

Definition at line 513 of file noiseReplacer.py.

    def getImage(self, bb):
        rim = self.getRandomImage(bb)
        # Use the image's variance plane to scale the noise.
        stdev = afwImage.ImageF(self.var, bb, afwImage.LOCAL, True)
        stdev.sqrt()
        rim *= stdev
        if self.mean is not None:
            rim += self.mean
        return rim
 
 

Member Data Documentation

◆ mean

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.mean

Definition at line 508 of file noiseReplacer.py.

◆ var

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.var

Definition at line 505 of file noiseReplacer.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g212a7c68fe+04a9158687/python/lsst/meas/base/noiseReplacer.py

Public Member Functions

Public Attributes