LSST Applications g1635faa6d4+215bc75b8c,g1653933729+a8ce1bb630,g22ce9dc20b+d972d8df89,g28da252d5a+0fcf840c6d,g29321ee8c0+e558be0e74,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+2a6f257a1d,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g7ab3e175f3+59ce30aec6,g80478fca09+f8b2ab54e1,g82479be7b0+ba9d578ff8,g858d7b2824+d972d8df89,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+630363936d,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gb9c6c11c1e+9553554aa7,gbd46683f8f+0c4209622a,gc28159a63d+9634bc57db,gcf0d15dbbd+2db122af0a,gda3e153d99+d972d8df89,gda6a2b7d83+2db122af0a,gdaeeff99f8+1711a396fd,ge2409df99d+d1dc2f3b25,ge33fd446bb+d972d8df89,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+02b11634a5,w.2024.45
LSST Data Management Base Package
Loading...
Searching...
No Matches
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

 __init__ (self, isTrimmed=True, verbose=False, background=numpy.nan, showAmpGain=True, markSize=10, markValue=0, ampImValue=None, scaleGain=lambda gain:(gain *1000)//10)
 
 getCcdImage (self, det, imageFactory, binSize)
 
 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 321 of file utils.py.

Constructor & Destructor Documentation

◆ __init__()

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 )

Reimplemented in lsst.afw.cameraGeom.utils.ButlerImage.

Definition at line 343 of file utils.py.

345 ampImValue=None, scaleGain=lambda gain: (gain*1000)//10):
346 self.isTrimmed = isTrimmed
347 self.verbose = verbose
348 self.background = background
349 self.showAmpGain = showAmpGain
350 self.markSize = markSize
351 self.markValue = markValue
352 self.ampImValue = ampImValue
353 self.scaleGain = scaleGain
354

Member Function Documentation

◆ getAmpImage()

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 376 of file utils.py.

376 def getAmpImage(self, amp, imageFactory):
377 """Return an amp segment image.
378
379 Parameters
380 ----------
381 amp : `lsst.afw.table.AmpInfoTable`
382 AmpInfoTable for this amp.
383 imageFactory : callable like `lsst.afw.image.Image`
384 Image constructor for making the image.
385
386 Returns
387 -------
388 ampImage : `lsst.afw.image.Image`
389 The constructed image.
390 """
391 ampImage = makeImageFromAmp(amp, imValue=self.ampImValue, imageFactory=imageFactory,
392 markSize=self.markSize, markValue=self.markValue,
393 scaleGain=self.scaleGain)
394 if self.isTrimmed:
395 ampImage = ampImage.Factory(ampImage, amp.getRawDataBBox())
396 return ampImage
397
398

◆ getCcdImage()

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.

Reimplemented in lsst.afw.cameraGeom.utils.ButlerImage.

Definition at line 355 of file utils.py.

355 def getCcdImage(self, det, imageFactory, binSize):
356 """Return a CCD image for the detector and the (possibly updated) Detector.
357
358 Parameters
359 ----------
360 det : `lsst.afw.cameraGeom.Detector`
361 Detector to use for making the image.
362 imageFactory : callable like `lsst.afw.image.Image`
363 Image constructor for making the image.
364 binSize : `int`
365 Bin the image by this factor in both dimensions.
366
367 Returns
368 -------
369 ccdImage : `lsst.afw.image.Image`
370 The constructed image.
371 """
372 ccdImage = makeImageFromCcd(det, isTrimmed=self.isTrimmed, showAmpGain=self.showAmpGain,
373 imageFactory=imageFactory, binSize=binSize)
374 return afwMath.rotateImageBy90(ccdImage, det.getOrientation().getNQuarter()), det
375
std::shared_ptr< ImageT > rotateImageBy90(ImageT const &image, int nQuarter)
Rotate an image by an integral number of quarter turns.

Member Data Documentation

◆ ampImValue

lsst.afw.cameraGeom.utils.FakeImageDataSource.ampImValue

Definition at line 352 of file utils.py.

◆ background

lsst.afw.cameraGeom.utils.FakeImageDataSource.background

Definition at line 348 of file utils.py.

◆ isTrimmed

lsst.afw.cameraGeom.utils.FakeImageDataSource.isTrimmed

Definition at line 346 of file utils.py.

◆ markSize

lsst.afw.cameraGeom.utils.FakeImageDataSource.markSize

Definition at line 350 of file utils.py.

◆ markValue

lsst.afw.cameraGeom.utils.FakeImageDataSource.markValue

Definition at line 351 of file utils.py.

◆ scaleGain

lsst.afw.cameraGeom.utils.FakeImageDataSource.scaleGain

Definition at line 353 of file utils.py.

◆ showAmpGain

lsst.afw.cameraGeom.utils.FakeImageDataSource.showAmpGain

Definition at line 349 of file utils.py.

◆ verbose

lsst.afw.cameraGeom.utils.FakeImageDataSource.verbose

Definition at line 347 of file utils.py.


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