lsst.afw  19.0.0-24-gf0e72354e+1
Public Member Functions | Public Attributes | List of all members
lsst.afw.display.rgb.rgbContinued.ZScaleMapping Class Reference
Inheritance diagram for lsst.afw.display.rgb.rgbContinued.ZScaleMapping:
lsst.afw.display.rgb.rgbContinued.LinearMapping lsst.afw.display.rgb.rgbContinued.Mapping

Public Member Functions

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

Public Attributes

 maximum
 
 minimum
 

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

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from lsst.afw.display.rgb.rgbContinued.LinearMapping.

Definition at line 275 of file rgbContinued.py.

Member Function Documentation

◆ intensity()

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

◆ mapIntensityToUint8()

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

Member Data Documentation

◆ maximum

lsst.afw.display.rgb.rgbContinued.LinearMapping.maximum
inherited

Definition at line 239 of file rgbContinued.py.

◆ minimum

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

Definition at line 96 of file rgbContinued.py.


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