lsst.afw  22.0.1-22-gf1d71818e+4206820b0d
Public Member Functions | Public Attributes | List of all members
lsst.afw.display.rgb._rgbContinued.AsinhZScaleMapping Class Reference
Inheritance diagram for lsst.afw.display.rgb._rgbContinued.AsinhZScaleMapping:
lsst.afw.display.rgb._rgbContinued.AsinhMapping lsst.afw.display.rgb._rgbContinued.Mapping

Public Member Functions

def __init__ (self, image, Q=8, pedestal=None)
 
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

 minimum
 

Detailed Description

A mapping for an asinh stretch, estimating the linear stretch by zscale

x = asinh(Q (I - z1)/(z2 - z1))/Q

Parameters
----------
image
    The image to analyse, or a list of 3 images to be converted to an intensity image
Q : `int`
    The asinh softening parameter
pedestal : `float` or sequence of `float`, optional
    The value, or array of 3 values, to subtract from the images

    N.b. pedestal, if not None, is removed from the images when calculating the zscale
    stretch, and added back into Mapping.minimum[]

See also
--------
AsinhMapping

Definition at line 324 of file _rgbContinued.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.afw.display.rgb._rgbContinued.AsinhZScaleMapping.__init__ (   self,
  image,
  Q = 8,
  pedestal = None 
)

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

Definition at line 346 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 160 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 98 of file _rgbContinued.py.

◆ mapIntensityToUint8()

def lsst.afw.display.rgb._rgbContinued.AsinhMapping.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 314 of file _rgbContinued.py.

Member Data Documentation

◆ minimum

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

Definition at line 95 of file _rgbContinued.py.


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