lsst.afw  20.0.0-18-gcabc0c9fd+109ac6652c
Public Member Functions | Public Attributes | List of all members
lsst.afw.cameraGeom.utils.FakeImageDataSource Class Reference
Inheritance diagram for lsst.afw.cameraGeom.utils.FakeImageDataSource:
lsst.afw.cameraGeom.utils.ButlerImage

Public Member Functions

def __init__ (self, isTrimmed=True, verbose=False, background=numpy.nan, showAmpGain=True, markSize=10, markValue=0, ampImValue=None, scaleGain=lambda gain:(gain *1000)//10)
 
def getCcdImage (self, det, imageFactory, binSize)
 
def getAmpImage (self, amp, imageFactory)
 

Public Attributes

 isTrimmed
 
 verbose
 
 background
 
 showAmpGain
 
 markSize
 
 markValue
 
 ampImValue
 
 scaleGain
 

Detailed Description

A class to retrieve synthetic images for display by the show* methods

Parameters
----------
isTrimmed : `bool`
    Should amps be trimmed?
verbose : `bool`
    Be chatty?
background : `float`
    The value of any pixels that lie outside the CCDs.
showAmpGain : `bool`
    Color the amp segments with the gain of the amp?
markSize : `float`
    Size of the side of the box used to mark the read corner.
markValue : `float`
    Value to assign the read corner mark.
ampImValue : `float` or `None`
    Value to assign to amps; scaleGain(gain) is used if `None`.
scaleGain : callable
    Function to scale the gain by.

Definition at line 319 of file utils.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.afw.cameraGeom.utils.FakeImageDataSource.__init__ (   self,
  isTrimmed = True,
  verbose = False,
  background = numpy.nan,
  showAmpGain = True,
  markSize = 10,
  markValue = 0,
  ampImValue = None,
  scaleGain = lambda gain: (gain*1000)//10 
)

Definition at line 341 of file utils.py.

Member Function Documentation

◆ getAmpImage()

def lsst.afw.cameraGeom.utils.FakeImageDataSource.getAmpImage (   self,
  amp,
  imageFactory 
)
Return an amp segment image.

Parameters
----------
amp : `lsst.afw.table.AmpInfoTable`
    AmpInfoTable for this amp.
imageFactory : callable like `lsst.afw.image.Image`
    Image constructor for making the image.

Returns
-------
ampImage : `lsst.afw.image.Image`
    The constructed image.

Definition at line 374 of file utils.py.

◆ getCcdImage()

def lsst.afw.cameraGeom.utils.FakeImageDataSource.getCcdImage (   self,
  det,
  imageFactory,
  binSize 
)
Return a CCD image for the detector and the (possibly updated) Detector.

Parameters
----------
det : `lsst.afw.cameraGeom.Detector`
    Detector to use for making the image.
imageFactory : callable like `lsst.afw.image.Image`
    Image constructor for making the image.
binSize : `int`
    Bin the image by this factor in both dimensions.

Returns
-------
ccdImage : `lsst.afw.image.Image`
    The constructed image.

Definition at line 353 of file utils.py.

Member Data Documentation

◆ ampImValue

lsst.afw.cameraGeom.utils.FakeImageDataSource.ampImValue

Definition at line 348 of file utils.py.

◆ background

lsst.afw.cameraGeom.utils.FakeImageDataSource.background

Definition at line 344 of file utils.py.

◆ isTrimmed

lsst.afw.cameraGeom.utils.FakeImageDataSource.isTrimmed

Definition at line 342 of file utils.py.

◆ markSize

lsst.afw.cameraGeom.utils.FakeImageDataSource.markSize

Definition at line 346 of file utils.py.

◆ markValue

lsst.afw.cameraGeom.utils.FakeImageDataSource.markValue

Definition at line 347 of file utils.py.

◆ scaleGain

lsst.afw.cameraGeom.utils.FakeImageDataSource.scaleGain

Definition at line 349 of file utils.py.

◆ showAmpGain

lsst.afw.cameraGeom.utils.FakeImageDataSource.showAmpGain

Definition at line 345 of file utils.py.

◆ verbose

lsst.afw.cameraGeom.utils.FakeImageDataSource.verbose

Definition at line 343 of file utils.py.


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