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

Update doc strings to clarify getArrayRegion API for ROI subclasses

Browse Source
This commit is contained in:
Kenneth Lyons 2020-06-28 14:39:12 -07:00
parent 4110b3e539
commit 8a3d4bab2f
1 changed files with 25 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
pyqtgraph/graphicsItems/ROI.py
View File

@ -1662,6 +1662,15 @@ class MultiRectROI(QtGui.QGraphicsObject):
return pos return pos
def getArrayRegion(self, arr, img=None, axes=(0,1), **kwds): def getArrayRegion(self, arr, img=None, axes=(0,1), **kwds):
"""
Return the result of :meth:`~pyqtgraph.ROI.getArrayRegion` for each rect
in the chain concatenated into a single ndarray.
See :meth:`~pyqtgraph.ROI.getArrayRegion` for a description of the
arguments.
Note: ``returnMappedCoords`` is not yet supported for this ROI type.
"""
rgns = [] rgns = []
for l in self.lines: for l in self.lines:
rgn = l.getArrayRegion(arr, img, axes=axes, **kwds) rgn = l.getArrayRegion(arr, img, axes=axes, **kwds)
@ -1775,8 +1784,13 @@ class EllipseROI(ROI):
def getArrayRegion(self, arr, img=None, axes=(0, 1), **kwds): def getArrayRegion(self, arr, img=None, axes=(0, 1), **kwds):
""" """
Return the result of ROI.getArrayRegion() masked by the elliptical shape Return the result of :meth:`~pyqtgraph.ROI.getArrayRegion` masked by the
of the ROI. Regions outside the ellipse are set to 0. elliptical shape of the ROI. Regions outside the ellipse are set to 0.
See :meth:`~pyqtgraph.ROI.getArrayRegion` for a description of the
arguments.
Note: ``returnMappedCoords`` is not yet supported for this ROI type.
""" """
# Note: we could use the same method as used by PolyLineROI, but this # Note: we could use the same method as used by PolyLineROI, but this
# implementation produces a nicer mask. # implementation produces a nicer mask.
@ -2059,8 +2073,13 @@ class PolyLineROI(ROI):
def getArrayRegion(self, data, img, axes=(0,1), **kwds): def getArrayRegion(self, data, img, axes=(0,1), **kwds):
""" """
Return the result of ROI.getArrayRegion(), masked by the shape of the Return the result of :meth:`~pyqtgraph.ROI.getArrayRegion`, masked by
ROI. Values outside the ROI shape are set to 0. the shape of the ROI. Values outside the ROI shape are set to 0.
See :meth:`~pyqtgraph.ROI.getArrayRegion` for a description of the
arguments.
Note: ``returnMappedCoords`` is not yet supported for this ROI type.
""" """
br = self.boundingRect() br = self.boundingRect()
if br.width() > 1000: if br.width() > 1000:
@ -2179,7 +2198,8 @@ class LineSegmentROI(ROI):
Since this pulls 1D data from a 2D coordinate system, the return value Since this pulls 1D data from a 2D coordinate system, the return value
will have ndim = data.ndim-1 will have ndim = data.ndim-1
See ROI.getArrayRegion() for a description of the arguments. See :meth:`~pytqgraph.ROI.getArrayRegion` for a description of the
arguments.
""" """
imgPts = [self.mapToItem(img, h.pos()) for h in self.endpoints] imgPts = [self.mapToItem(img, h.pos()) for h in self.endpoints]
rgns = [] rgns = []