lsst.afw.cameraGeom.utils.ButlerImage Class Reference

Inheritance diagram for lsst.afw.cameraGeom.utils.ButlerImage:

Public Member Functions
def	__init__ (self, butler=None, type="raw", isTrimmed=True, verbose=False, background=numpy.nan, callback=None, *args, **kwargs)
def	getCcdImage (self, ccd, imageFactory=afwImage.ImageF, binSize=1, asMaskedImage=False)
def	getCcdImage (self, det, imageFactory, binSize)
def	getAmpImage (self, amp, imageFactory)

Public Attributes
	isTrimmed
	type
	butler
	kwargs
	isRaw
	background
	verbose
	callback
	showAmpGain
	markSize
	markValue
	ampImValue
	scaleGain

Detailed Description

A class to return an Image of a given Ccd using the butler.

Parameters
----------
butler : `lsst.daf.persistence.Butler` or `None`
    The butler to use. If `None`, an empty image is returned.
type : `str`
    The type of image to read (e.g. raw, bias, flat, calexp).
isTrimmed : `bool`
    If true, the showCamera command expects to be given trimmed images.
verbose : `bool`
    Be chatty (in particular, log any error messages from the butler)?
background : `float`
    The value of any pixels that lie outside the CCDs.
callback : callable
    A function called with (image, ccd, butler) for every image, which
    returns the image to be displayed (e.g. rawCallback). The image must
    be of the correct size, allowing for the value of isTrimmed.
*args : `list`
    Passed to the butler.
**kwargs : `dict`
    Passed to the butler.

Notes
-----
You can define a short named function as a callback::

    def callback(im, ccd, imageSource):
        return cameraGeom.utils.rawCallback(im, ccd, imageSource, correctGain=True)

Definition at line 397 of file utils.py.

Constructor & Destructor Documentation

__init__()

def lsst.afw.cameraGeom.utils.ButlerImage.__init__	(		self,
			butler = None,
			type = "raw",
			isTrimmed = True,
			verbose = False,
			background = numpy.nan,
			callback = None,
		*	args,
		**	kwargs
	)

Definition at line 428 of file utils.py.

                 callback=None, *args, **kwargs):
        super(ButlerImage, self).__init__(*args)
        self.isTrimmed = isTrimmed
        self.type = type
        self.butler = butler
        self.kwargs = kwargs
        self.isRaw = False
        self.background = background
        self.verbose = verbose
        self.callback = callback
 

Member Function Documentation

getAmpImage()

def lsst.afw.cameraGeom.utils.FakeImageDataSource.getAmpImage (   self,   amp,   imageFactory  )

inherited

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.

    def 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.
        """
        ampImage = makeImageFromAmp(amp, imValue=self.ampImValue, imageFactory=imageFactory,
                                    markSize=self.markSize, markValue=self.markValue,
                                    scaleGain=self.scaleGain)
        if self.isTrimmed:
            ampImage = ampImage.Factory(ampImage, amp.getRawDataBBox())
        return ampImage
 
 

getCcdImage() [1/2]

def lsst.afw.cameraGeom.utils.ButlerImage.getCcdImage	(		self,
			ccd,
			imageFactory = afwImage.ImageF,
			binSize = 1,
			asMaskedImage = False
	)

Return an image of the specified ccd, and also the (possibly updated) ccd

Definition at line 451 of file utils.py.

    def getCcdImage(self, ccd, imageFactory=afwImage.ImageF, binSize=1, asMaskedImage=False):
        """Return an image of the specified ccd, and also the (possibly updated) ccd"""
 
        log = lsst.log.Log.getLogger("afw.cameraGeom.utils.ButlerImage")
 
        if self.isTrimmed:
            bbox = ccd.getBBox()
        else:
            bbox = calcRawCcdBBox(ccd)
 
        im = None
        if self.butler is not None:
            err = None
            for dataId in [dict(detector=ccd.getId()), dict(ccd=ccd.getId()), dict(ccd=ccd.getName())]:
                try:
                    im = self.butler.get(self.type, dataId, **self.kwargs)
                except FitsError as e:  # no point trying another dataId
                    err = IOError(e.args[0].split('\n')[0])  # It's a very chatty error
                    break
                except Exception as e:  # try a different dataId
                    if err is None:
                        err = e
                    continue
                else:
                    ccd = im.getDetector()  # possibly modified by assembleCcdTask
                    break
 
            if im:
                if asMaskedImage:
                    im = im.getMaskedImage()
                else:
                    im = im.getMaskedImage().getImage()
            else:
                if self.verbose:
                    # Lost by jupyterlab.
                    print(f"Reading {ccd.getId()}: {err}")
 
                log.warn(f"Reading {ccd.getId()}: {err}")
 
        if im is None:
            return self._prepareImage(ccd, imageFactory(*bbox.getDimensions()), binSize), ccd
 
        if self.type == "raw":
            if hasattr(im, 'convertF'):
                im = im.convertF()
            if False and self.callback is None:   # we need to trim the raw image
                self.callback = rawCallback
 
        allowRotate = True
        if self.callback:
            try:
                im = self.callback(im, ccd, imageSource=self)
            except Exception as e:
                if self.verbose:
                    log.error(f"callback failed: {e}")
                im = imageFactory(*bbox.getDimensions())
            else:
                allowRotate = False     # the callback was responsible for any rotations
 
        return self._prepareImage(ccd, im, binSize, allowRotate=allowRotate), ccd
 
 

getCcdImage() [2/2]

def lsst.afw.cameraGeom.utils.FakeImageDataSource.getCcdImage (   self,   det,   imageFactory,   binSize  )

inherited

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.

    def 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.
        """
        ccdImage = makeImageFromCcd(det, isTrimmed=self.isTrimmed, showAmpGain=self.showAmpGain,
                                    imageFactory=imageFactory, binSize=binSize)
        return afwMath.rotateImageBy90(ccdImage, det.getOrientation().getNQuarter()), det
 

Member Data Documentation

ampImValue

lsst.afw.cameraGeom.utils.FakeImageDataSource.ampImValue

inherited

Definition at line 350 of file utils.py.

background

lsst.afw.cameraGeom.utils.ButlerImage.background

Definition at line 437 of file utils.py.

butler

lsst.afw.cameraGeom.utils.ButlerImage.butler

Definition at line 434 of file utils.py.

callback

lsst.afw.cameraGeom.utils.ButlerImage.callback

Definition at line 439 of file utils.py.

isRaw

lsst.afw.cameraGeom.utils.ButlerImage.isRaw

Definition at line 436 of file utils.py.

isTrimmed

lsst.afw.cameraGeom.utils.ButlerImage.isTrimmed

Definition at line 432 of file utils.py.

kwargs

lsst.afw.cameraGeom.utils.ButlerImage.kwargs

Definition at line 435 of file utils.py.

markSize

lsst.afw.cameraGeom.utils.FakeImageDataSource.markSize

inherited

Definition at line 348 of file utils.py.

markValue

lsst.afw.cameraGeom.utils.FakeImageDataSource.markValue

inherited

Definition at line 349 of file utils.py.

scaleGain

lsst.afw.cameraGeom.utils.FakeImageDataSource.scaleGain

inherited

Definition at line 351 of file utils.py.

showAmpGain

lsst.afw.cameraGeom.utils.FakeImageDataSource.showAmpGain

inherited

Definition at line 347 of file utils.py.

type

lsst.afw.cameraGeom.utils.ButlerImage.type

Definition at line 433 of file utils.py.

verbose

lsst.afw.cameraGeom.utils.ButlerImage.verbose

Definition at line 438 of file utils.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-32-g5ddfab5d3+60ce4897b0/python/lsst/afw/cameraGeom/utils.py