LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator Class Reference

Generates Gaussian noise whose variance matches that of the variance plane of the image. More...

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

Public Member Functions

def __init__
 
def __str__
 
def getImage
 
- Public Member Functions inherited from lsst.meas.base.noiseReplacer.GaussianNoiseGenerator
def __init__
 
def getRandomImage
 
- Public Member Functions inherited from lsst.meas.base.noiseReplacer.NoiseGenerator
def getHeavyFootprint
 
def getMaskedImage
 
def getImage
 

Public Attributes

 var
 
 mean
 
- Public Attributes inherited from lsst.meas.base.noiseReplacer.GaussianNoiseGenerator
 rand
 

Detailed Description

Generates Gaussian noise whose variance matches that of the variance plane of the image.

Definition at line 411 of file noiseReplacer.py.

Constructor & Destructor Documentation

def lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.__init__ (   self,
  var,
  mean = None,
  rand = None 
)
var: an afwImage.ImageF; the variance plane.
mean: floating-point or afwImage.Image

Definition at line 416 of file noiseReplacer.py.

417  def __init__(self, var, mean=None, rand=None):
418  """
419  var: an afwImage.ImageF; the variance plane.
420  mean: floating-point or afwImage.Image
421  """
422  super(VariancePlaneNoiseGenerator, self).__init__(rand=rand)
423  self.var = var
424  if mean is not None and mean == 0.:
425  mean = None
426  self.mean = mean

Member Function Documentation

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

Definition at line 427 of file noiseReplacer.py.

428  def __str__(self):
429  return 'VariancePlaneNoiseGenerator: mean=' + str(self.mean)
def lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.getImage (   self,
  bb 
)

Definition at line 430 of file noiseReplacer.py.

431  def getImage(self, bb):
432  rim = self.getRandomImage(bb)
433  # Use the image's variance plane to scale the noise.
434  stdev = afwImage.ImageF(self.var, bb, afwImage.LOCAL, True)
435  stdev.sqrt()
436  rim *= stdev
437  if self.mean is not None:
438  rim += self.mean
439  return rim
440 

Member Data Documentation

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.mean

Definition at line 425 of file noiseReplacer.py.

lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator.var

Definition at line 422 of file noiseReplacer.py.


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