lsst.afw  19.0.0-26-g4476391b4+2
Classes | Functions
lsst.afw.display.rgb.rgbContinued Namespace Reference

Classes

class  _RgbImageF
 
class  AsinhMapping
 
class  asinhMappingF
 
class  AsinhZScaleMapping
 
class  LinearMapping
 
class  Mapping
 
class  ZScaleMapping
 

Functions

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

Function Documentation

◆ computeIntensity()

def 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 31 of file rgbContinued.py.

◆ displayRGB()

def 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 433 of file rgbContinued.py.

◆ makeRGB()

def 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 386 of file rgbContinued.py.

◆ RgbImageF()

def lsst.afw.display.rgb.rgbContinued.RgbImageF (   imageR,
  imageG,
  imageB,
  mapping 
)
Deprecated legacy API

Definition at line 500 of file rgbContinued.py.

◆ writeRGB()

def 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 450 of file rgbContinued.py.