lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator Class Reference

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

Public Member Functions
def	__init__ (self, var, mean=None, rand=None)
def	__str__ (self)
def	getImage (self, bb)
def	getRandomImage (self, bb)
def	getHeavyFootprint (self, fp)
def	getMaskedImage (self, bb)

Public Attributes
	var
	mean
	rand

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__()

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

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__()

def lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.__str__

(

self

)

Definition at line 510 of file noiseReplacer.py.

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

getHeavyFootprint()

def lsst.meas.base.noiseReplacer.NoiseGenerator.getHeavyFootprint (   self,   fp  )

inherited

Definition at line 425 of file noiseReplacer.py.

    def getHeavyFootprint(self, fp):
        bb = fp.getBBox()
        mim = self.getMaskedImage(bb)
        return afwDet.makeHeavyFootprint(fp, mim)
 

getImage()

def 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
 
 

getMaskedImage()

def lsst.meas.base.noiseReplacer.NoiseGenerator.getMaskedImage (   self,   bb  )

inherited

Reimplemented in lsst.meas.base.noiseReplacer.ImageNoiseGenerator.

Definition at line 430 of file noiseReplacer.py.

    def getMaskedImage(self, bb):
        im = self.getImage(bb)
        return afwImage.MaskedImageF(im)
 

getRandomImage()

def lsst.meas.base.noiseReplacer.GaussianNoiseGenerator.getRandomImage (   self,   bb  )

inherited

Definition at line 465 of file noiseReplacer.py.

    def getRandomImage(self, bb):
        # Create an Image and fill it with Gaussian noise.
        rim = afwImage.ImageF(bb.getWidth(), bb.getHeight())
        rim.setXY0(bb.getMinX(), bb.getMinY())
        afwMath.randomGaussianImage(rim, self.rand)
        return rim
 
 

Member Data Documentation

mean

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.mean

Definition at line 508 of file noiseReplacer.py.

rand

lsst.meas.base.noiseReplacer.GaussianNoiseGenerator.rand

inherited

Definition at line 463 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-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/python/lsst/meas/base/noiseReplacer.py