Source code for pyqtgraph.widgets.RawImageWidget
"""
RawImageWidget.py
Copyright 2010-2016 Luke Campagnola
Distributed under MIT/X11 license. See license.txt for more information.
"""
import numpy
from .. import functions as fn
from .. import functions_qimage
from .. import getConfigOption, getCupy
from ..Qt import QtCore, QtGui, QtWidgets
try:
QOpenGLWidget = QtWidgets.QOpenGLWidget
from OpenGL.GL import * # noqa
HAVE_OPENGL = True
except (ImportError, AttributeError):
# Would prefer `except ImportError` here, but some versions of pyopengl generate
# AttributeError upon import
HAVE_OPENGL = False
__all__ = ['RawImageWidget']
[docs]
class RawImageWidget(QtWidgets.QWidget):
"""
Widget optimized for very fast video display.
Generally using an ImageItem inside GraphicsView is fast enough.
On some systems this may provide faster video. See the VideoSpeedTest example for benchmarking.
"""
[docs]
def __init__(self, parent=None, scaled=False):
"""
Setting scaled=True will cause the entire image to be displayed within the boundaries of the widget.
This also greatly reduces the speed at which it will draw frames.
"""
QtWidgets.QWidget.__init__(self, parent)
self.setSizePolicy(QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Expanding, QtWidgets.QSizePolicy.Policy.Expanding))
self.scaled = scaled
self.opts = None
self.image = None
self._cp = getCupy()
[docs]
def setImage(self, img, *args, **kargs):
"""
img must be ndarray of shape (x,y), (x,y,3), or (x,y,4).
Extra arguments are sent to functions.makeARGB
"""
if getConfigOption('imageAxisOrder') == 'col-major':
img = img.swapaxes(0, 1)
self.opts = (img, args, kargs)
self.image = None
self.update()
def paintEvent(self, ev):
if self.opts is None:
return
if self.image is None:
img = self.opts[0]
xp = self._cp.get_array_module(img) if self._cp else numpy
qimage = None
if (
not self.opts[1] # no positional arguments
and {"levels", "lut"}.issuperset(self.opts[2]) # no kwargs besides levels and lut
):
transparentLocations = None
if img.dtype.kind == "f" and xp.isnan(img.min()):
nanmask = xp.isnan(img)
if nanmask.ndim == 3:
nanmask = nanmask.any(axis=2)
transparentLocations = nanmask.nonzero()
qimage = functions_qimage.try_make_qimage(
img,
levels=self.opts[2].get("levels"),
lut=self.opts[2].get("lut"),
transparentLocations=transparentLocations
)
if qimage is None:
argb, alpha = fn.makeARGB(self.opts[0], *self.opts[1], **self.opts[2])
if self._cp and self._cp.get_array_module(argb) == self._cp:
argb = argb.get() # transfer GPU data back to the CPU
qimage = fn.ndarray_to_qimage(argb, QtGui.QImage.Format.Format_ARGB32)
self.image = qimage
self.opts = ()
# if self.pixmap is None:
# self.pixmap = QtGui.QPixmap.fromImage(self.image)
p = QtGui.QPainter(self)
if self.scaled:
rect = self.rect()
ar = rect.width() / float(rect.height())
imar = self.image.width() / float(self.image.height())
if ar > imar:
rect.setWidth(int(rect.width() * imar / ar))
else:
rect.setHeight(int(rect.height() * ar / imar))
p.drawImage(rect, self.image)
else:
p.drawImage(QtCore.QPointF(), self.image)
# p.drawPixmap(self.rect(), self.pixmap)
p.end()
if HAVE_OPENGL:
__all__.append('RawImageGLWidget')
class RawImageGLWidget(QOpenGLWidget):
"""
Similar to RawImageWidget, but uses a GL widget to do all drawing.
Performance varies between platforms; see examples/VideoSpeedTest for benchmarking.
Checks if setConfigOptions(imageAxisOrder='row-major') was set.
"""
def __init__(self, parent=None, scaled=False):
QOpenGLWidget.__init__(self, parent)
self.scaled = scaled
self.image = None
self.uploaded = False
self.smooth = False
self.opts = None
def setImage(self, img, *args, **kargs):
"""
img must be ndarray of shape (x,y), (x,y,3), or (x,y,4).
Extra arguments are sent to functions.makeARGB
"""
if getConfigOption('imageAxisOrder') == 'col-major':
img = img.swapaxes(0, 1)
self.opts = (img, args, kargs)
self.image = None
self.uploaded = False
self.update()
def initializeGL(self):
self.texture = glGenTextures(1)
def uploadTexture(self):
glEnable(GL_TEXTURE_2D)
glBindTexture(GL_TEXTURE_2D, self.texture)
if self.smooth:
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR)
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR)
else:
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST)
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST)
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_BORDER)
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_BORDER)
# glTexParameteri(GL_TEXTURE_3D, GL_TEXTURE_WRAP_R, GL_CLAMP_TO_BORDER)
## Test texture dimensions first
# shape = self.image.shape
# glTexImage2D(GL_PROXY_TEXTURE_2D, 0, GL_RGBA, shape[0], shape[1], 0, GL_RGBA, GL_UNSIGNED_BYTE, None)
# if glGetTexLevelParameteriv(GL_PROXY_TEXTURE_2D, 0, GL_TEXTURE_WIDTH) == 0:
# raise Exception("OpenGL failed to create 2D texture (%dx%d); too large for this hardware." % shape[:2])
h, w = self.image.shape[:2]
glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, w, h, 0, GL_RGBA, GL_UNSIGNED_BYTE, self.image)
glDisable(GL_TEXTURE_2D)
self.uploaded = True
def paintGL(self):
glClear(GL_COLOR_BUFFER_BIT)
if self.image is None:
if self.opts is None:
return
img, args, kwds = self.opts
kwds['useRGBA'] = True
self.image, _ = fn.makeARGB(img, *args, **kwds)
if not self.uploaded:
self.uploadTexture()
glEnable(GL_TEXTURE_2D)
glBindTexture(GL_TEXTURE_2D, self.texture)
glColor4f(1, 1, 1, 1)
glBegin(GL_QUADS)
glTexCoord2f(0, 1)
glVertex3f(-1, -1, 0)
glTexCoord2f(1, 1)
glVertex3f(1, -1, 0)
glTexCoord2f(1, 0)
glVertex3f(1, 1, 0)
glTexCoord2f(0, 0)
glVertex3f(-1, 1, 0)
glEnd()
glDisable(GL_TEXTURE_2D)