Mapping

class lsst.afw.display.Mapping(minimum=None, image=None)

Bases: object

Base class to map red, blue, green intensities into uint8 values

Parameters:

minimumfloat or sequence of float

Intensity that should be mapped to black. If an array, has three elements for R, G, B.

image

The image to be used to calculate the mapping. If provided, also the default for makeRgbImage()

Methods Summary

intensity(imageR, imageG, imageB)	Return the total intensity from the red, blue, and green intensities
makeRgbImage([imageR, imageG, imageB, ...])	Convert 3 arrays, imageR, imageG, and imageB into a numpy RGB image
mapIntensityToUint8(intensity)	Map an intensity into the range of a uint8, [0, 255] (but not converted to uint8)

Methods Documentation

intensity(imageR, imageG, imageB)

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

Notes

This is a naive computation, and may be overridden by subclasses

makeRgbImage(imageR=None, imageG=None, imageB=None, xSize=None, ySize=None, rescaleFactor=None)

Convert 3 arrays, imageR, imageG, and imageB into a numpy RGB image

imageRlsst.afw.image.Image or numpy.ndarray, (Nx, Ny)

Image to map to red (if None, use the image passed to the ctor)

imageGlsst.afw.image.Image or numpy.ndarray, (Nx, Ny), optional

Image to map to green (if None, use imageR)

imageBlsst.afw.image.Image or numpy.ndarray, (Nx, Ny), optional

Image to map to blue (if None, use imageR)

xSizeint, optional

Desired width of RGB image. If ySize is None, preserve aspect ratio

ySizeint, optional

Desired height of RGB image

rescaleFactorfloat, optional

Make size of output image rescaleFactor*size of the input image

mapIntensityToUint8(intensity)

Map an intensity into the range of a uint8, [0, 255] (but not converted to uint8)