Inheritance diagram for lsst.afw.cameraGeom.utils.ButlerImage:
Public Member Functions | |
| __init__ (self, butler=None, type="raw", isTrimmed=True, verbose=False, background=numpy.nan, callback=None, *args, **kwargs) | |
| getCcdImage (self, ccd, imageFactory=afwImage.ImageF, binSize=1, asMaskedImage=False) | |
Public Attributes | |
| isTrimmed | |
| type | |
| butler | |
| kwargs | |
| isRaw | |
| background | |
| verbose | |
| callback | |
Protected Member Functions | |
| _prepareImage (self, ccd, im, binSize, allowRotate=True) | |
Detailed Description
A class to return an Image of a given Ccd using the butler.
Parameters
----------
butler : `lsst.daf.butler.Butler` or `None`
The butler to use. If `None`, an empty image is returned. Assumes that
the instrument was specified during butler construction or is included
in the ``kwargs`` parameter.
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, detector, 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 base class constructor.
**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)
Constructor & Destructor Documentation
◆ __init__()
| lsst.afw.cameraGeom.utils.ButlerImage.__init__ | ( | self, | |
| butler = None, | |||
| type = "raw", | |||
| isTrimmed = True, | |||
| verbose = False, | |||
| background = numpy.nan, | |||
| callback = None, | |||
| * | args, | ||
| ** | kwargs ) |
Reimplemented from lsst.afw.cameraGeom.utils.FakeImageDataSource.
Definition at line 432 of file utils.py.
434 callback=None, *args, **kwargs):
435 super().__init__(*args)
436 self.isTrimmed = isTrimmed
437 self.type = type
438 self.butler = butler
439 self.kwargs = kwargs
440 self.isRaw = False
441 self.background = background
442 self.verbose = verbose
443 self.callback = callback
444
Member Function Documentation
◆ _prepareImage()
|
protected |
Definition at line 445 of file utils.py.
445 def _prepareImage(self, ccd, im, binSize, allowRotate=True):
446 if binSize > 1:
447 im = afwMath.binImage(im, binSize)
448
449 if allowRotate:
450 im = afwMath.rotateImageBy90(
451 im, ccd.getOrientation().getNQuarter())
452
453 return im
454
std::shared_ptr< ImageT > rotateImageBy90(ImageT const &image, int nQuarter)
Rotate an image by an integral number of quarter turns.
Definition rotateImage.cc:39
std::shared_ptr< ImageT > binImage(ImageT const &inImage, int const binX, int const binY, lsst::afw::math::Property const flags=lsst::afw::math::MEAN)
Definition binImage.cc:44
◆ getCcdImage()
| 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
Reimplemented from lsst.afw.cameraGeom.utils.FakeImageDataSource.
Definition at line 455 of file utils.py.
455 def getCcdImage(self, ccd, imageFactory=afwImage.ImageF, binSize=1, asMaskedImage=False):
456 """Return an image of the specified ccd, and also the (possibly updated) ccd"""
457
458 log = _LOG.getChild("ButlerImage")
459
460 if self.isTrimmed:
461 bbox = ccd.getBBox()
462 else:
463 bbox = calcRawCcdBBox(ccd)
464
465 im = None
466 if self.butler is not None:
467 err = None
468 try:
469 im = self.butler.get(self.type, detector=ccd.getId(), **self.kwargs)
470 except FitsError as e:
471 err = IOError(e.args[0].split('\n')[0]) # It's a very chatty error
472 except Exception as e: # try a different dataId
473 err = e
474 else:
475 ccd = im.getDetector() # possibly modified by assembleCcdTask
476
477 if im:
478 if asMaskedImage:
479 im = im.getMaskedImage()
480 else:
481 im = im.getMaskedImage().getImage()
482 else:
483 if self.verbose:
484 # Lost by jupyterlab.
485 print(f"Reading {ccd.getId()}: {err}")
486
487 log.warning("Reading %s: %s", ccd.getId(), err)
488
489 if im is None:
490 return self._prepareImage(ccd, imageFactory(*bbox.getDimensions()), binSize), ccd
491
492 if self.type == "raw":
493 if hasattr(im, 'convertF'):
494 im = im.convertF()
495 if False and self.callback is None: # we need to trim the raw image
496 self.callback = rawCallback
497
498 allowRotate = True
499 if self.callback:
500 try:
501 im = self.callback(im, ccd, imageSource=self)
502 except Exception as e:
503 if self.verbose:
504 log.error("callback failed: %s", e)
505 im = imageFactory(*bbox.getDimensions())
506 else:
507 allowRotate = False # the callback was responsible for any rotations
508
509 return self._prepareImage(ccd, im, binSize, allowRotate=allowRotate), ccd
510
511
Member Data Documentation
◆ background
◆ butler
◆ callback
◆ isRaw
◆ isTrimmed
◆ kwargs
◆ type
◆ verbose
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/cameraGeom/utils.py
