LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator Class Reference
Inheritance diagram for lsst.meas.base.noiseReplacer.VariancePlaneNoiseGenerator:
lsst.meas.base.noiseReplacer.GaussianNoiseGenerator lsst.meas.base.noiseReplacer.NoiseGenerator

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.

503 def __init__(self, var, mean=None, rand=None):
504 super(VariancePlaneNoiseGenerator, self).__init__(rand=rand)
505 self.var = var
506 if mean is not None and mean == 0.:
507 mean = None
508 self.mean = mean
509

Member Function Documentation

◆ __str__()

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

Definition at line 510 of file noiseReplacer.py.

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

◆ getImage()

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

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

Definition at line 513 of file noiseReplacer.py.

513 def getImage(self, bb):
514 rim = self.getRandomImage(bb)
515 # Use the image's variance plane to scale the noise.
516 stdev = afwImage.ImageF(self.var, bb, afwImage.LOCAL, True)
517 stdev.sqrt()
518 rim *= stdev
519 if self.mean is not None:
520 rim += self.mean
521 return rim
522
523

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: