LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
lsst.afw.display.rgb._rgbContinued.LinearMapping Class Reference
Inheritance diagram for lsst.afw.display.rgb._rgbContinued.LinearMapping:
lsst.afw.display.rgb._rgbContinued.Mapping lsst.afw.display.rgb._rgbContinued.ZScaleMapping

Public Member Functions

 __init__ (self, minimum=None, maximum=None, image=None)
 
 mapIntensityToUint8 (self, intensity)
 

Public Attributes

 maximum
 

Protected Attributes

 _range
 

Detailed Description

A linear map of 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.
maximum : `float`
    Intensity that should be mapped to white
image
    Image to estimate minimum/maximum if not explicitly set

Definition at line 213 of file _rgbContinued.py.

Constructor & Destructor Documentation

◆ __init__()

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

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

Reimplemented in lsst.afw.display.rgb._rgbContinued.ZScaleMapping.

Definition at line 227 of file _rgbContinued.py.

227 def __init__(self, minimum=None, maximum=None, image=None):
228 if minimum is None or maximum is None:
229 assert image is not None, "You must provide an image if you don't set both minimum and maximum"
230
231 stats = afwMath.makeStatistics(image, afwMath.MIN | afwMath.MAX)
232 if minimum is None:
233 minimum = stats.getValue(afwMath.MIN)
234 if maximum is None:
235 maximum = stats.getValue(afwMath.MAX)
236
237 Mapping.__init__(self, minimum, image)
238 self.maximum = maximum
239
240 if maximum is None:
241 self._range = None
242 else:
243 assert maximum - minimum != 0, "minimum and maximum values must not be equal"
244 self._range = float(maximum - minimum)
245
Statistics makeStatistics(lsst::afw::image::Image< Pixel > const &img, lsst::afw::image::Mask< image::MaskPixel > const &msk, int const flags, StatisticsControl const &sctrl=StatisticsControl())
Handle a watered-down front-end to the constructor (no variance)
Definition Statistics.h:361

Member Function Documentation

◆ mapIntensityToUint8()

lsst.afw.display.rgb._rgbContinued.LinearMapping.mapIntensityToUint8 ( self,
intensity )
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 246 of file _rgbContinued.py.

246 def mapIntensityToUint8(self, intensity):
247 """Return an array which, when multiplied by an image, returns that
248 image mapped to the range of a uint8, [0, 255] (but not converted to uint8)
249
250 The intensity is assumed to have had ``minimum`` subtracted (as that
251 can be done per-band)
252 """
253 with np.errstate(invalid='ignore', divide='ignore'): # n.b. np.where can't and doesn't short-circuit
254 return np.where(intensity <= 0, 0,
255 np.where(intensity >= self._range,
256 self._uint8Max/intensity, self._uint8Max/self._range))
257
258

Member Data Documentation

◆ _range

lsst.afw.display.rgb._rgbContinued.LinearMapping._range
protected

Definition at line 241 of file _rgbContinued.py.

◆ maximum

lsst.afw.display.rgb._rgbContinued.LinearMapping.maximum

Definition at line 238 of file _rgbContinued.py.


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