lsst.afw.display.rgb._rgbContinued.ZScaleMapping Class Reference

Inheritance diagram for lsst.afw.display.rgb._rgbContinued.ZScaleMapping:

Public Member Functions
	__init__ (self, image, nSamples=1000, contrast=0.25)
	mapIntensityToUint8 (self, intensity)
	makeRgbImage (self, imageR=None, imageG=None, imageB=None, xSize=None, ySize=None, rescaleFactor=None)
	intensity (self, imageR, imageG, imageB)

Public Attributes
	maximum = maximum
	minimum = minimum

Protected Member Functions
	_convertImagesToUint8 (self, imageR, imageG, imageB)

Protected Attributes
	_range = None
	_uint8Max = float(np.iinfo(np.uint8).max)
	_image = image

Detailed Description

A mapping for a linear stretch chosen by the zscale algorithm
(preserving colours independent of brightness)

x = (I - minimum)/range

Parameters
----------
image
    Image whose parameters are desired
nSamples : `int`
    The number of samples to use to estimate the zscale parameters
contrast : `float`

Definition at line 259 of file _rgbContinued.py.

Constructor & Destructor Documentation

__init__()

lsst.afw.display.rgb._rgbContinued.ZScaleMapping.__init__	(		self,
			image,
			nSamples = 1000,
			contrast = 0.25 )

Definition at line 274 of file _rgbContinued.py.

Member Function Documentation

_convertImagesToUint8()

lsst.afw.display.rgb._rgbContinued.Mapping._convertImagesToUint8 ( self, imageR, imageG, imageB )

protectedinherited

Use the mapping to convert images imageR, imageG, and imageB to a triplet of uint8 images

Definition at line 176 of file _rgbContinued.py.

intensity()

lsst.afw.display.rgb._rgbContinued.Mapping.intensity ( self, imageR, imageG, imageB )

inherited

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

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

Definition at line 160 of file _rgbContinued.py.

makeRgbImage()

lsst.afw.display.rgb._rgbContinued.Mapping.makeRgbImage ( self, imageR = None, imageG = None, imageB = None, xSize = None, ySize = None, rescaleFactor = None )

inherited

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

imageR : `lsst.afw.image.Image` or `numpy.ndarray`, (Nx, Ny)
    Image to map to red (if `None`, use the image passed to the ctor)
imageG : `lsst.afw.image.Image` or `numpy.ndarray`, (Nx, Ny), optional
    Image to map to green (if `None`, use imageR)
imageB : `lsst.afw.image.Image` or `numpy.ndarray`, (Nx, Ny), optional
    Image to map to blue (if `None`, use imageR)
xSize : `int`, optional
    Desired width of RGB image. If ``ySize`` is `None`, preserve aspect ratio
ySize : `int`, optional
    Desired height of RGB image
rescaleFactor : `float`, optional
    Make size of output image ``rescaleFactor*size`` of the input image

Definition at line 98 of file _rgbContinued.py.

mapIntensityToUint8()

lsst.afw.display.rgb._rgbContinued.LinearMapping.mapIntensityToUint8 ( self, intensity )

inherited

Return an array which, when multiplied by an image, returns that
image mapped to the range of a uint8, [0, 255] (but not converted to uint8)

The intensity is assumed to have had ``minimum`` subtracted (as that
can be done per-band)

Reimplemented from lsst.afw.display.rgb._rgbContinued.Mapping.

Definition at line 246 of file _rgbContinued.py.

Member Data Documentation

_image

lsst.afw.display.rgb._rgbContinued.Mapping._image = image

protectedinherited

Definition at line 96 of file _rgbContinued.py.

_range

lsst.afw.display.rgb._rgbContinued.LinearMapping._range = None

protectedinherited

Definition at line 241 of file _rgbContinued.py.

_uint8Max

lsst.afw.display.rgb._rgbContinued.Mapping._uint8Max = float(np.iinfo(np.uint8).max)

protectedinherited

Definition at line 87 of file _rgbContinued.py.

maximum

lsst.afw.display.rgb._rgbContinued.LinearMapping.maximum = maximum

inherited

Definition at line 238 of file _rgbContinued.py.

minimum

lsst.afw.display.rgb._rgbContinued.Mapping.minimum = minimum

inherited

Definition at line 95 of file _rgbContinued.py.

---

The documentation for this class was generated from the following file:

• python/lsst/afw/display/rgb/_rgbContinued.py