Inheritance diagram for lsst.display.matplotlib.matplotlib.ZScaleNormalize:

Public Member Functions
def	__init__ (self, image=None, nSamples=1000, contrast=0.25)

def	__call__ (self, value, clip=None)

Public Attributes
	mapping

Detailed Description

Provide a zscale stretch for mtv()

Definition at line 862 of file matplotlib.py.

Constructor & Destructor Documentation

◆ init()

def lsst.display.matplotlib.matplotlib.ZScaleNormalize.__init__	(	self,
		image = `None`,
		nSamples = `1000`,
		contrast = `0.25`
	)

Initialise an object able to carry out a zscale mapping

@param image to be used to estimate the stretch
@param nSamples Number of data points to use (default: 1000)
@param contrast Control the range of pixels to display around the
                median (default: 0.25)

Definition at line 864 of file matplotlib.py.

     def __init__(self, image=None, nSamples=1000, contrast=0.25):
         """Initialise an object able to carry out a zscale mapping
  
         @param image to be used to estimate the stretch
         @param nSamples Number of data points to use (default: 1000)
         @param contrast Control the range of pixels to display around the
                         median (default: 0.25)
         """
  
         # The object used to perform the desired mapping
         self.mapping = afwRgb.ZScaleMapping(image, nSamples, contrast)
  
         super().__init__(self.mapping.minimum[0], self.mapping.maximum)
  
  

Member Function Documentation

◆ call()

def lsst.display.matplotlib.matplotlib.Normalize.__call__	(	self,
		value,
		clip = `None`
	)

inherited

Return a MaskedArray with value mapped to [0, 255]

@param value Input pixel value or array to be mapped

Definition at line 791 of file matplotlib.py.

     def __call__(self, value, clip=None):
         """
         Return a MaskedArray with value mapped to [0, 255]
  
         @param value Input pixel value or array to be mapped
         """
         if isinstance(value, np.ndarray):
             data = value
         else:
             data = value.data
  
         data = data - self.mapping.minimum[0]
         return ma.array(data*self.mapping.mapIntensityToUint8(data)/255.0)
  
  

Member Data Documentation

◆ mapping

lsst.display.matplotlib.matplotlib.ZScaleNormalize.mapping

Definition at line 874 of file matplotlib.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/display_matplotlib/22.0.0+6312710a6c/python/lsst/display/matplotlib/matplotlib.py

Public Member Functions

Public Attributes