lsst.afw  20.0.0-2-gf99403173
Public Member Functions | Public 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

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

Public Attributes

 minimum
 

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 87 of file rgbContinued.py.

Member Function Documentation

◆ intensity()

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

◆ makeRgbImage()

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

◆ mapIntensityToUint8()

def 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.AsinhMapping, and lsst.afw.display.rgb.rgbContinued.LinearMapping.

Definition at line 170 of file rgbContinued.py.

Member Data Documentation

◆ minimum

lsst.afw.display.rgb.rgbContinued.Mapping.minimum

Definition at line 96 of file rgbContinued.py.


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