LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
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: