lsst.afw.display.rgb._rgbContinued Namespace Reference

Classes
class	AsinhMapping
class	AsinhZScaleMapping
class	LinearMapping
class	Mapping
class	ZScaleMapping

Functions
	computeIntensity (imageR, imageG=None, imageB=None)
	makeRGB (imageR, imageG=None, imageB=None, minimum=0, dataRange=5, Q=8, fileName=None, saturatedBorderWidth=0, saturatedPixelValue=None, xSize=None, ySize=None, rescaleFactor=None)
	displayRGB (rgb, show=True)
	writeRGB (fileName, rgbImage)

Function Documentation

computeIntensity()

lsst.afw.display.rgb._rgbContinued.computeIntensity	(		imageR,
			imageG = None,
			imageB = None )

Return a naive total intensity from the red, blue, and green intensities

Parameters
----------
imageR : `lsst.afw.image.MaskedImage`, `lsst.afw.image.Image`, or `numpy.ndarray`, (Nx, Ny)
    intensity of image that'll be mapped to red; or intensity if imageG and imageB are None
imageG : `lsst.afw.image.MaskedImage`, `lsst.afw.image.Image`, or `numpy.ndarray`, (Nx, Ny)
    intensity of image that'll be mapped to green; or None
imageB : `lsst.afw.image.MaskedImage`, `lsst.afw.image.Image`, or `numpy.ndarray`, (Nx, Ny)
    intensity of image that'll be mapped to blue; or None

Returns
-------
image : type of ``imageR``, ``imageG``, and `imageB``

Definition at line 30 of file _rgbContinued.py.

displayRGB()

lsst.afw.display.rgb._rgbContinued.displayRGB	(		rgb,
			show = True )

Display an rgb image using matplotlib

Parameters
----------
rgb
    The RGB image in question
show : `bool`
    If `True`, call `matplotlib.pyplot.show()`

Definition at line 432 of file _rgbContinued.py.

makeRGB()

lsst.afw.display.rgb._rgbContinued.makeRGB	(		imageR,
			imageG = None,
			imageB = None,
			minimum = 0,
			dataRange = 5,
			Q = 8,
			fileName = None,
			saturatedBorderWidth = 0,
			saturatedPixelValue = None,
			xSize = None,
			ySize = None,
			rescaleFactor = None )

Make a set of three images into an RGB image using an asinh stretch and
optionally write it to disk

Parameters
----------
imageR
imageG
imageB
minimum : `float` or sequence of `float`
dataRange
Q : `int`
fileName : `str`
    The output file. The suffix defines the format, and must be supported by matplotlib
saturatedBorderWidth
    If saturatedBorderWidth is non-zero, replace saturated pixels with
    ``saturatedPixelValue``. Note that replacing saturated pixels requires
    that the input images be `lsst.afw.image.MaskedImage`.
saturatedPixelValue
xSize
ySize
rescaleFactor

Definition at line 385 of file _rgbContinued.py.

writeRGB()

lsst.afw.display.rgb._rgbContinued.writeRGB	(		fileName,
			rgbImage )

Write an RGB image to disk

Parameters
----------
fileName : `str`
    The output file. The suffix defines the format, and must be supported by matplotlib

    Most versions of matplotlib support png and pdf (although the eps/pdf/svg writers may be buggy,
    possibly due an interaction with useTeX=True in the matplotlib settings).

    If your matplotlib bundles pil/pillow you should also be able to write jpeg and tiff files.
rgbImage
    The image, as made by e.g. makeRGB

Definition at line 449 of file _rgbContinued.py.