ASCEE/pyqtgraph
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Docstring updates

Browse Source
This commit is contained in:
Luke Campagnola 2017-10-03 08:27:36 -07:00
parent faca369a8d
commit 21bda49a29
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
pyqtgraph/graphicsItems/HistogramLUTItem.py
View File

@ -25,11 +25,29 @@ __all__ = ['HistogramLUTItem']
class HistogramLUTItem(GraphicsWidget): class HistogramLUTItem(GraphicsWidget):
""" """
This is a graphicsWidget which provides controls for adjusting the display of an image. This is a graphicsWidget which provides controls for adjusting the display of an image.
Includes: Includes:
- Image histogram - Image histogram
- Movable region over histogram to select black/white levels - Movable region over histogram to select black/white levels
- Gradient editor to define color lookup table for single-channel images - Gradient editor to define color lookup table for single-channel images
Parameters
----------
image : ImageItem or None
If *image* is provided, then the control will be automatically linked to
the image and changes to the control will be immediately reflected in
the image's appearance.
fillHistogram : bool
By default, the histogram is rendered with a fill.
For performance, set *fillHistogram* = False.
rgbHistogram : bool
Sets whether the histogram is computed once over all channels of the
image, or once per channel.
levelMode : 'mono' or 'rgba'
If 'mono', then only a single set of black/whilte level lines is drawn,
and the levels apply to all channels in the image. If 'rgba', then one
set of levels is drawn for each channel.
""" """
sigLookupTableChanged = QtCore.Signal(object) sigLookupTableChanged = QtCore.Signal(object)
@ -37,10 +55,6 @@ class HistogramLUTItem(GraphicsWidget):
sigLevelChangeFinished = QtCore.Signal(object) sigLevelChangeFinished = QtCore.Signal(object)
def __init__(self, image=None, fillHistogram=True, rgbHistogram=False, levelMode='mono'): def __init__(self, image=None, fillHistogram=True, rgbHistogram=False, levelMode='mono'):
"""
If *image* (ImageItem) is provided, then the control will be automatically linked to the image and changes to the control will be immediately reflected in the image's appearance.
By default, the histogram is rendered with a fill. For performance, set *fillHistogram* = False.
"""
GraphicsWidget.__init__(self) GraphicsWidget.__init__(self)
self.lut = None self.lut = None
self.imageItem = lambda: None # fake a dead weakref self.imageItem = lambda: None # fake a dead weakref
@ -241,6 +255,8 @@ class HistogramLUTItem(GraphicsWidget):
def getLevels(self): def getLevels(self):
"""Return the min and max levels. """Return the min and max levels.
For rgba mode, this returns a list of the levels for each channel.
""" """
if self.levelMode == 'mono': if self.levelMode == 'mono':
return self.region.getRegion() return self.region.getRegion()