lsst.afw.cameraGeom.utils.ButlerImage Class Reference

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

Public Member Functions
def	__init__
	Create an object that knows how to prepare images for showCamera using the butler. More...
def	getCcdImage
Public Member Functions inherited from lsst.afw.cameraGeom.utils.FakeImageDataSource
def	__init__
	Construct a FakeImageDataSource. More...
def	getCcdImage
	Return a CCD image for the detector. More...
def	getAmpImage
	Return an amp segment image. More...

Public Attributes
	isTrimmed
	type
	butler
	kwargs
	isRaw
	gravity
	background
	verbose
Public Attributes inherited from lsst.afw.cameraGeom.utils.FakeImageDataSource
	isTrimmed
	verbose
	background
	showAmpGain
	markSize
	markValue
	ampImValue
	scaleGain

Private Member Functions
def	_prepareImage

Detailed Description

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

Definition at line 296 of file utils.py.

Constructor & Destructor Documentation

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

Create an object that knows how to prepare images for showCamera using the butler.

Parameters

The	butler to use. If no butler is provided an empty image is returned
type	The type of image to read (e.g. raw, bias, flat, calexp)
isTrimmed	If true, the showCamera command expects to be given trimmed images
verbose	Be chatty (in particular, print any error messages from the butler)
background	The value of any pixels that lie outside the CCDs
gravity	If the image returned by the butler is trimmed (e.g. some of the SuprimeCam CCDs) Specify how to fit the image into the available space; N => align top, W => align left
*args,*kwargs	Passed to the butler

Definition at line 300 of file utils.py.

                 isTrimmed=True, verbose=False, background=numpy.nan, gravity=None, *args, **kwargs):
        """!Create an object that knows how to prepare images for showCamera using the butler

        \param The butler to use.  If no butler is provided an empty image is returned
        \param type The type of image to read (e.g. raw, bias, flat, calexp)
        \param isTrimmed If true, the showCamera command expects to be given trimmed images
        \param verbose  Be chatty (in particular, print any error messages from the butler)
        \param background  The value of any pixels that lie outside the CCDs
        \param  gravity  If the image returned by the butler is trimmed (e.g. some of the SuprimeCam CCDs)
                 Specify how to fit the image into the available space; N => align top, W => align left
        \param *args, *kwargs Passed to the butler
        """
        super(ButlerImage, self).__init__(*args)
        self.isTrimmed = isTrimmed
        self.type = type
        self.butler = butler
        self.kwargs = kwargs
        self.isRaw = False
        self.gravity = gravity
        self.background = background
        self.verbose = verbose