Add getArrayRegion tests for ROI, RectROI, and EllipseROI

pyqtgraph/graphicsItems/tests/test_ROI.py

@@ -1,53 +1,126 @@
+import numpy as np
+import pytest
 import pyqtgraph as pg
-pg.mkQApp()
+from pyqtgraph.tests import assertImageApproved
 
-vb = pg.ViewBox()
-data = pg.np.ones((7, 100, 110, 5))
-image_tx = pg.ImageItem(data[:, :, 0, 0])
-image_xy = pg.ImageItem(data[0, :, :, 0])
-image_yz = pg.ImageItem(data[0, 0, :, :])
-vb.addItem(image_tx)
-vb.addItem(image_xy)
-vb.addItem(image_yz)
 
-size = (10, 15)
+app = pg.mkQApp()
-pos = (0, 0)
-rois = [
-    pg.ROI(pos, size),
-    pg.RectROI(pos, size),
-    pg.EllipseROI(pos, size),
-    pg.CircleROI(pos, size),
-    pg.PolyLineROI([pos, size]),
-]
-
-for roi in rois:
-    vb.addItem(roi)
 
 
 def test_getArrayRegion():
-    global vb, image, rois, data, size
+    rois = [
+        (pg.ROI([1, 1], [27, 28], pen='y'), 'baseroi'),
+        (pg.RectROI([1, 1], [27, 28], pen='y'), 'rectroi'),
+        (pg.EllipseROI([1, 1], [27, 28], pen='y'), 'ellipseroi'),
+    ]
+    for roi, name in rois:
+        check_getArrayRegion(roi, name)
     
-    # Test we can call getArrayRegion without errors 
-    # (not checking for data validity)
-    for roi in rois:
-        arr = roi.getArrayRegion(data, image_tx)
-        assert arr.shape == size + data.shape[2:]
     
-        arr = roi.getArrayRegion(data, image_tx, axes=(0, 1))
+def check_getArrayRegion(roi, name):
-        assert arr.shape == size + data.shape[2:]
+    win = pg.GraphicsLayoutWidget()
+    win.show()
+    win.resize(200, 400)
     
-        arr = roi.getArrayRegion(data.transpose(1, 0, 2, 3), image_tx, axes=(1, 0))
+    vb1 = win.addViewBox()
-        assert arr.shape == size + data.shape[2:]
+    win.nextRow()
+    vb2 = win.addViewBox()
+    img1 = pg.ImageItem(border='w')
+    img2 = pg.ImageItem(border='w')
+    vb1.addItem(img1)
+    vb2.addItem(img2)
     
-        arr = roi.getArrayRegion(data, image_xy, axes=(1, 2))
+    np.random.seed(0)
-        assert arr.shape == data.shape[:1] + size + data.shape[3:]
+    data = np.random.normal(size=(7, 30, 31, 5))
+    data[0, :, :, :] += 10
+    data[:, 1, :, :] += 10
+    data[:, :, 2, :] += 10
+    data[:, :, :, 3] += 10
     
-        arr = roi.getArrayRegion(data.transpose(0, 2, 1, 3), image_xy, axes=(2, 1))
+    img1.setImage(data[0, ..., 0])
-        assert arr.shape == data.shape[:1] + size + data.shape[3:]
+    vb1.setAspectLocked()
+    vb1.enableAutoRange(True, True)
     
-        arr, coords = roi.getArrayRegion(data, image_xy, axes=(1, 2), returnMappedCoords=True)
+    roi.setZValue(10)
-        assert arr.shape == data.shape[:1] + size + data.shape[3:]
+    vb1.addItem(roi)
-        assert coords.shape == (2,) + size
+
+    rgn = roi.getArrayRegion(data, img1, axes=(1, 2))
+    assert np.all(rgn == data[:, 1:-2, 1:-2, :])
+    img2.setImage(rgn[0, ..., 0])
+    vb2.setAspectLocked()
+    vb2.enableAutoRange(True, True)
+    
+    app.processEvents()
+    
+    assertImageApproved(win, name+'/roi_getarrayregion', 'Simple ROI region selection.')
+
+    with pytest.raises(TypeError):
+        roi.setPos(0, 0)
+
+    roi.setPos([0.5, 1.5])
+    rgn = roi.getArrayRegion(data, img1, axes=(1, 2))
+    img2.setImage(rgn[0, ..., 0])
+    app.processEvents()
+    assertImageApproved(win, name+'/roi_getarrayregion_halfpx', 'Simple ROI region selection, 0.5 pixel shift.')
+
+    roi.setAngle(45)
+    roi.setPos([3, 0])
+    rgn = roi.getArrayRegion(data, img1, axes=(1, 2))
+    img2.setImage(rgn[0, ..., 0])
+    app.processEvents()
+    assertImageApproved(win, name+'/roi_getarrayregion_rotate', 'Simple ROI region selection, rotation.')
+
+    roi.setSize([60, 60])
+    rgn = roi.getArrayRegion(data, img1, axes=(1, 2))
+    img2.setImage(rgn[0, ..., 0])
+    app.processEvents()
+    assertImageApproved(win, name+'/roi_getarrayregion_resize', 'Simple ROI region selection, resized.')
+
+    img1.scale(1, -1)
+    img1.setPos(0, img1.height())
+    img1.rotate(20)
+    rgn = roi.getArrayRegion(data, img1, axes=(1, 2))
+    img2.setImage(rgn[0, ..., 0])
+    app.processEvents()
+    assertImageApproved(win, name+'/roi_getarrayregion_img_trans', 'Simple ROI region selection, image transformed.')
+
+    vb1.invertY()
+    rgn = roi.getArrayRegion(data, img1, axes=(1, 2))
+    img2.setImage(rgn[0, ..., 0])
+    app.processEvents()
+    assertImageApproved(win, name+'/roi_getarrayregion_inverty', 'Simple ROI region selection, view inverted.')
+
+    roi.setAngle(0)
+    roi.setSize(30, 30)
+    roi.setPos([0, 0])
+    img1.resetTransform()
+    img1.setPos(0, 0)
+    img1.scale(1, 0.5)
+    #img1.scale(0.5, 1)
+    rgn = roi.getArrayRegion(data, img1, axes=(1, 2))
+    img2.setImage(rgn[0, ..., 0])
+    app.processEvents()
+    assertImageApproved(win, name+'/roi_getarrayregion_anisotropic', 'Simple ROI region selection, image scaled anisotropically.')
+
+    # test features:
+    #   pen / hoverpen
+    #   handle pen / hoverpen
+    #   handle types + mouse interaction
+    #   getstate
+    #   savestate
+    #   restore state
+    #   getarrayregion
+    #   getarrayslice
+    #   
+    # test conditions:
+    #   y inverted
+    #   extra array axes
+    #   imageAxisOrder
+    #   roi classes
+    #   image transforms--rotation, scaling, flip
+    #   view transforms--anisotropic scaling
+    #   ROI transforms
+    #   ROI parent transforms