lsst.afw g5a732f18d5+66d966b544
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
lsst.afw.display.rgb._rgbContinued.Mapping Class Reference
Inheritance diagram for lsst.afw.display.rgb._rgbContinued.Mapping:
lsst.afw.display.rgb._rgbContinued.AsinhMapping lsst.afw.display.rgb._rgbContinued.LinearMapping lsst.afw.display.rgb._rgbContinued.AsinhZScaleMapping lsst.afw.display.rgb._rgbContinued.ZScaleMapping

Public Member Functions

 __init__ (self, minimum=None, image=None)
 
 makeRgbImage (self, imageR=None, imageG=None, imageB=None, xSize=None, ySize=None, rescaleFactor=None)
 
 intensity (self, imageR, imageG, imageB)
 
 mapIntensityToUint8 (self, intensity)
 

Public Attributes

 minimum
 

Protected Member Functions

 _convertImagesToUint8 (self, imageR, imageG, imageB)
 

Protected Attributes

 _uint8Max
 
 _image
 

Detailed Description

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

Parameters
----------
minimum : `float` 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()

Definition at line 73 of file _rgbContinued.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.afw.display.rgb._rgbContinued.Mapping.__init__ ( self,
minimum = None,
image = None )

Member Function Documentation

◆ _convertImagesToUint8()

lsst.afw.display.rgb._rgbContinued.Mapping._convertImagesToUint8 ( self,
imageR,
imageG,
imageB )
protected
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 )
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 )
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.Mapping.mapIntensityToUint8 ( self,
intensity )
Map an intensity into the range of a uint8, [0, 255] (but not converted to uint8)

Reimplemented in lsst.afw.display.rgb._rgbContinued.LinearMapping, and lsst.afw.display.rgb._rgbContinued.AsinhMapping.

Definition at line 169 of file _rgbContinued.py.

Member Data Documentation

◆ _image

lsst.afw.display.rgb._rgbContinued.Mapping._image
protected

Definition at line 96 of file _rgbContinued.py.

◆ _uint8Max

lsst.afw.display.rgb._rgbContinued.Mapping._uint8Max
protected

Definition at line 87 of file _rgbContinued.py.

◆ minimum

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

Definition at line 95 of file _rgbContinued.py.


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