def updateBounds(self, line: pg.InfiniteLine, index: int):
if index == 0 or index == len(self.segments) - 1:
return
last_partition = self.segments[index - 1].getXPos()
next_partition = self.segments[index + 1].getXPos()
cushion = self.calcCushion()
min_bounds = last_partition + cushion
max_bounds = next_partition - cushion
line.setBounds((min_bounds, max_bounds))
self.item.updatePartitionBoundaries.emit(index, min_bounds, max_bounds)
class ScanPlotWidget(PlotWidget):
"""
Extend the PlotWidget Class with more functionality used for qudi scan images.
Supported features:
- draggable/static crosshair with optional range and size constraints.
- zoom feature by rubberband selection
- rubberband area selection
This class depends on the ScanViewBox class defined further below.
This class can be promoted in the Qt designer.
"""
sigMouseAreaSelected = QtCore.Signal(
QtCore.QRectF) # mapped rectangle mouse cursor selection
sigCrosshairPosChanged = QtCore.Signal(QtCore.QPointF)
sigCrosshairDraggedPosChanged = QtCore.Signal(QtCore.QPointF)
def __init__(self, *args, **kwargs):
kwargs['viewBox'] = ScanViewBox() # Use custom pg.ViewBox subclass
super().__init__(*args, **kwargs)
self.getViewBox().sigMouseAreaSelected.connect(
self.sigMouseAreaSelected)
self._min_crosshair_factor = 0.02
self._crosshair_size = (0, 0)
self._crosshair_range = None
self.getViewBox().sigRangeChanged.connect(
self._constraint_crosshair_size)
self.crosshair = ROI((0, 0), (0, 0),
pen={
'color': '#00ff00',
'width': 1
})
self.hline = InfiniteLine(pos=0,
angle=0,
movable=True,
pen={
'color': '#00ff00',
'width': 1
},
hoverPen={
'color': '#ffff00',
'width': 1
})
self.vline = InfiniteLine(pos=0,
angle=90,
movable=True,
pen={
'color': '#00ff00',
'width': 1
},
hoverPen={
'color': '#ffff00',
'width': 1
})
self.vline.sigDragged.connect(self._update_pos_from_line)
self.hline.sigDragged.connect(self._update_pos_from_line)
self.crosshair.sigRegionChanged.connect(self._update_pos_from_roi)
self.sigCrosshairDraggedPosChanged.connect(self.sigCrosshairPosChanged)
@property
def crosshair_enabled(self):
items = self.items()
return (self.vline in items) and (self.hline
in items) and (self.crosshair
in items)
@property
def crosshair_movable(self):
return bool(self.crosshair.translatable)
@property
def crosshair_position(self):
pos = self.vline.pos()
pos[1] = self.hline.pos()[1]
return tuple(pos)
@property
def crosshair_size(self):
return tuple(self._crosshair_size)
@property
def crosshair_min_size_factor(self):
return float(self._min_crosshair_factor)
@property
def crosshair_range(self):
if self._crosshair_range is None:
return None
return tuple(self._crosshair_range)
@property
def selection_enabled(self):
return bool(self.getViewBox().rectangle_selection)
@property
def zoom_by_selection_enabled(self):
return bool(self.getViewBox().zoom_by_selection)
def toggle_selection(self, enable):
"""
De-/Activate the rectangular rubber band selection tool.
If active you can select a rectangular region within the ViewBox by dragging the mouse
with the left button. Each selection rectangle in real-world data coordinates will be
emitted by sigMouseAreaSelected.
By using activate_zoom_by_selection you can optionally de-/activate zooming in on the
selection.
@param bool enable: Toggle selection on (True) or off (False)
"""
return self.getViewBox().toggle_selection(enable)
def toggle_zoom_by_selection(self, enable):
"""
De-/Activate automatic zooming into a selection.
See also: toggle_selection
@param bool enable: Toggle zoom upon selection on (True) or off (False)
"""
return self.getViewBox().toggle_zoom_by_selection(enable)
def _update_pos_from_line(self, obj):
"""
Called each time the position of the InfiniteLines has been changed by a user drag.
Causes the crosshair rectangle to follow the lines.
"""
if obj not in (self.hline, self.vline):
return
pos = self.vline.pos()
pos[1] = self.hline.pos()[1]
size = self.crosshair.size()
self.crosshair.blockSignals(True)
self.crosshair.setPos((pos[0] - size[0] / 2, pos[1] - size[1] / 2))
self.crosshair.blockSignals(False)
self.sigCrosshairDraggedPosChanged.emit(QtCore.QPointF(pos[0], pos[1]))
return
def _update_pos_from_roi(self, obj):
"""
Called each time the position of the rectangular ROI has been changed by a user drag.
Causes the InfiniteLines to follow the ROI.
"""
if obj is not self.crosshair:
return
pos = self.crosshair.pos()
size = self.crosshair.size()
pos[0] += size[0] / 2
pos[1] += size[1] / 2
self.vline.setPos(pos[0])
self.hline.setPos(pos[1])
self.sigCrosshairDraggedPosChanged.emit(QtCore.QPointF(pos[0], pos[1]))
return
def toggle_crosshair(self, enable, movable=True):
"""
Disable/Enable the crosshair within the PlotWidget. Optionally also toggle if it can be
dragged by the user.
@param bool enable: enable crosshair (True), disable crosshair (False)
@param bool movable: enable user drag (True), disable user drag (False)
"""
if not isinstance(enable, bool):
raise TypeError('Positional argument "enable" must be bool type.')
if not isinstance(movable, bool):
raise TypeError('Optional argument "movable" must be bool type.')
self.toggle_crosshair_movable(movable)
is_enabled = self.crosshair_enabled
if enable and not is_enabled:
self.addItem(self.vline)
self.addItem(self.hline)
self.addItem(self.crosshair)
elif not enable and is_enabled:
self.removeItem(self.vline)
self.removeItem(self.hline)
self.removeItem(self.crosshair)
return
def toggle_crosshair_movable(self, enable):
"""
Toggle if the crosshair can be dragged by the user.
@param bool enable: enable (True), disable (False)
"""
self.crosshair.translatable = bool(enable)
self.vline.setMovable(enable)
self.hline.setMovable(enable)
return
def set_crosshair_pos(self, pos):
"""
Set the crosshair center to the given coordinates.
@param QPointF|float[2] pos: (x,y) position of the crosshair
"""
try:
pos = tuple(pos)
except TypeError:
pos = (pos.x(), pos.y())
size = self.crosshair.size()
self.crosshair.blockSignals(True)
self.vline.blockSignals(True)
self.hline.blockSignals(True)
self.crosshair.setPos(pos[0] - size[0] / 2, pos[1] - size[1] / 2)
self.vline.setPos(pos[0])
self.hline.setPos(pos[1])
self.crosshair.blockSignals(False)
self.vline.blockSignals(False)
self.hline.blockSignals(False)
self.sigCrosshairPosChanged.emit(QtCore.QPointF(*pos))
return
def set_crosshair_size(self, size, force_default=True):
"""
Set the default size of the crosshair rectangle (x, y) and update the display.
@param QSize|float[2] size: the (x,y) size of the crosshair rectangle
@param bool force_default: Set default crosshair size and enforce minimal size (True).
Enforce displayed crosshair size while keeping default size
untouched (False).
"""
try:
size = tuple(size)
except TypeError:
size = (size.width(), size.height())
if force_default:
if size[0] <= 0 and size[1] <= 0:
self._crosshair_size = (0, 0)
else:
self._crosshair_size = size
# Check if actually displayed size needs to be adjusted due to minimal size
size = self._get_corrected_crosshair_size(size)
pos = self.vline.pos()
pos[1] = self.hline.pos()[1] - size[1] / 2
pos[0] -= size[0] / 2
if self._crosshair_range:
crange = self._crosshair_range
self.crosshair.maxBounds = QtCore.QRectF(
crange[0][0] - size[0] / 2, crange[1][0] - size[1] / 2,
crange[0][1] - crange[0][0] + size[0],
crange[1][1] - crange[1][0] + size[1])
self.crosshair.blockSignals(True)
self.crosshair.setSize(size)
self.crosshair.setPos(pos)
self.crosshair.blockSignals(False)
return
def set_crosshair_min_size_factor(self, factor):
"""
Sets the minimum crosshair size factor. This will determine the minimum size of the
smallest edge of the crosshair center rectangle.
This minimum size is calculated by taking the smallest visible axis of the ViewBox and
multiplying it with the scale factor set by this method.
The crosshair rectangle will be then scaled accordingly if the set crosshair size is
smaller than this minimal size.
@param float factor: The scale factor to set. If <= 0 no minimal crosshair size enforced.
"""
if factor <= 0:
self._min_crosshair_factor = 0
elif factor <= 1:
self._min_crosshair_factor = float(factor)
else:
raise ValueError('Crosshair min size factor must be a value <= 1.')
return
def set_crosshair_range(self, new_range):
"""
Sets a range boundary for the crosshair position.
@param float[2][2] new_range: two min-max range value tuples (for x and y axis).
If None set unlimited ranges.
"""
if new_range is None:
self.vline.setBounds([None, None])
self.hline.setBounds([None, None])
self.crosshair.maxBounds = None
else:
self.vline.setBounds(new_range[0])
self.hline.setBounds(new_range[1])
size = self.crosshair.size()
pos = self.crosshair_position
self.crosshair.maxBounds = QtCore.QRectF(
new_range[0][0] - size[0] / 2, new_range[1][0] - size[1] / 2,
new_range[0][1] - new_range[0][0] + size[0],
new_range[1][1] - new_range[1][0] + size[1])
self.crosshair.setPos(pos[0] - size[0] / 2, pos[1] - size[1] / 2)
self._crosshair_range = new_range
return
def set_crosshair_pen(self, pen):
"""
Sets the pyqtgraph compatible pen to be used for drawing the crosshair lines.
@param pen: pyqtgraph compatible pen to use
"""
self.crosshair.setPen(pen)
self.vline.setPen(pen)
self.hline.setPen(pen)
return
def _constraint_crosshair_size(self):
if self._min_crosshair_factor == 0:
return
if self._crosshair_size[0] == 0 or self._crosshair_size[1] == 0:
return
corr_size = self._get_corrected_crosshair_size(self._crosshair_size)
if corr_size != tuple(self.crosshair.size()):
self.set_crosshair_size(corr_size, force_default=False)
return
def _get_corrected_crosshair_size(self, size):
try:
size = tuple(size)
except TypeError:
size = (size.width(), size.height())
min_size = min(size)
if min_size == 0:
return size
vb_size = self.getViewBox().viewRect().size()
short_index = int(vb_size.width() > vb_size.height())
min_vb_size = vb_size.width() if short_index == 0 else vb_size.height()
min_vb_size *= self._min_crosshair_factor
if min_size < min_vb_size:
scale_factor = min_vb_size / min_size
size = (size[0] * scale_factor, size[1] * scale_factor)
return size
class ScanPlotWidget(PlotWidget):
"""
Extend the PlotWidget Class with more functionality used for qudi scan images.
Supported features:
- draggable/static crosshair with optional range and size constraints.
- zoom feature by rubberband selection
- rubberband area selection
This class depends on the ScanViewBox class defined further below.
This class can be promoted in the Qt designer.
"""
sigMouseAreaSelected = QtCore.Signal(QtCore.QRectF) # mapped rectangle mouse cursor selection
sigCrosshairPosChanged = QtCore.Signal(QtCore.QPointF)
sigCrosshairDraggedPosChanged = QtCore.Signal(QtCore.QPointF)
def __init__(self, *args, **kwargs):
kwargs['viewBox'] = ScanViewBox() # Use custom pg.ViewBox subclass
super().__init__(*args, **kwargs)
self.getViewBox().sigMouseAreaSelected.connect(self.sigMouseAreaSelected)
self._min_crosshair_factor = 0.02
self._crosshair_size = (0, 0)
self._crosshair_range = None
self.getViewBox().sigRangeChanged.connect(self._constraint_crosshair_size)
self.crosshair = ROI((0, 0), (0, 0), pen={'color': '#00ff00', 'width': 1})
self.hline = InfiniteLine(pos=0,
angle=0,
movable=True,
pen={'color': '#00ff00', 'width': 1},
hoverPen={'color': '#ffff00', 'width': 1})
self.vline = InfiniteLine(pos=0,
angle=90,
movable=True,
pen={'color': '#00ff00', 'width': 1},
hoverPen={'color': '#ffff00', 'width': 1})
self.vline.sigDragged.connect(self._update_pos_from_line)
self.hline.sigDragged.connect(self._update_pos_from_line)
self.crosshair.sigRegionChanged.connect(self._update_pos_from_roi)
self.sigCrosshairDraggedPosChanged.connect(self.sigCrosshairPosChanged)
@property
def crosshair_enabled(self):
items = self.items()
return (self.vline in items) and (self.hline in items) and (self.crosshair in items)
@property
def crosshair_movable(self):
return bool(self.crosshair.translatable)
@property
def crosshair_position(self):
pos = self.vline.pos()
pos[1] = self.hline.pos()[1]
return tuple(pos)
@property
def crosshair_size(self):
return tuple(self._crosshair_size)
@property
def crosshair_min_size_factor(self):
return float(self._min_crosshair_factor)
@property
def crosshair_range(self):
if self._crosshair_range is None:
return None
return tuple(self._crosshair_range)
@property
def selection_enabled(self):
return bool(self.getViewBox().rectangle_selection)
@property
def zoom_by_selection_enabled(self):
return bool(self.getViewBox().zoom_by_selection)
def toggle_selection(self, enable):
"""
De-/Activate the rectangular rubber band selection tool.
If active you can select a rectangular region within the ViewBox by dragging the mouse
with the left button. Each selection rectangle in real-world data coordinates will be
emitted by sigMouseAreaSelected.
By using activate_zoom_by_selection you can optionally de-/activate zooming in on the
selection.
@param bool enable: Toggle selection on (True) or off (False)
"""
return self.getViewBox().toggle_selection(enable)
def toggle_zoom_by_selection(self, enable):
"""
De-/Activate automatic zooming into a selection.
See also: toggle_selection
@param bool enable: Toggle zoom upon selection on (True) or off (False)
"""
return self.getViewBox().toggle_zoom_by_selection(enable)
def _update_pos_from_line(self, obj):
"""
Called each time the position of the InfiniteLines has been changed by a user drag.
Causes the crosshair rectangle to follow the lines.
"""
if obj not in (self.hline, self.vline):
return
pos = self.vline.pos()
pos[1] = self.hline.pos()[1]
size = self.crosshair.size()
self.crosshair.blockSignals(True)
self.crosshair.setPos((pos[0] - size[0] / 2, pos[1] - size[1] / 2))
self.crosshair.blockSignals(False)
self.sigCrosshairDraggedPosChanged.emit(QtCore.QPointF(pos[0], pos[1]))
return
def _update_pos_from_roi(self, obj):
"""
Called each time the position of the rectangular ROI has been changed by a user drag.
Causes the InfiniteLines to follow the ROI.
"""
if obj is not self.crosshair:
return
pos = self.crosshair.pos()
size = self.crosshair.size()
pos[0] += size[0] / 2
pos[1] += size[1] / 2
self.vline.setPos(pos[0])
self.hline.setPos(pos[1])
self.sigCrosshairDraggedPosChanged.emit(QtCore.QPointF(pos[0], pos[1]))
return
def toggle_crosshair(self, enable, movable=True):
"""
Disable/Enable the crosshair within the PlotWidget. Optionally also toggle if it can be
dragged by the user.
@param bool enable: enable crosshair (True), disable crosshair (False)
@param bool movable: enable user drag (True), disable user drag (False)
"""
if not isinstance(enable, bool):
raise TypeError('Positional argument "enable" must be bool type.')
if not isinstance(movable, bool):
raise TypeError('Optional argument "movable" must be bool type.')
self.toggle_crosshair_movable(movable)
is_enabled = self.crosshair_enabled
if enable and not is_enabled:
self.addItem(self.vline)
self.addItem(self.hline)
self.addItem(self.crosshair)
elif not enable and is_enabled:
self.removeItem(self.vline)
self.removeItem(self.hline)
self.removeItem(self.crosshair)
return
def toggle_crosshair_movable(self, enable):
"""
Toggle if the crosshair can be dragged by the user.
@param bool enable: enable (True), disable (False)
"""
self.crosshair.translatable = bool(enable)
self.vline.setMovable(enable)
self.hline.setMovable(enable)
return
def set_crosshair_pos(self, pos):
"""
Set the crosshair center to the given coordinates.
@param QPointF|float[2] pos: (x,y) position of the crosshair
"""
try:
pos = tuple(pos)
except TypeError:
pos = (pos.x(), pos.y())
size = self.crosshair.size()
self.crosshair.blockSignals(True)
self.vline.blockSignals(True)
self.hline.blockSignals(True)
self.crosshair.setPos(pos[0] - size[0] / 2, pos[1] - size[1] / 2)
self.vline.setPos(pos[0])
self.hline.setPos(pos[1])
self.crosshair.blockSignals(False)
self.vline.blockSignals(False)
self.hline.blockSignals(False)
self.sigCrosshairPosChanged.emit(QtCore.QPointF(*pos))
return
def set_crosshair_size(self, size, force_default=True):
"""
Set the default size of the crosshair rectangle (x, y) and update the display.
@param QSize|float[2] size: the (x,y) size of the crosshair rectangle
@param bool force_default: Set default crosshair size and enforce minimal size (True).
Enforce displayed crosshair size while keeping default size
untouched (False).
"""
try:
size = tuple(size)
except TypeError:
size = (size.width(), size.height())
if force_default:
if size[0] <= 0 and size[1] <= 0:
self._crosshair_size = (0, 0)
else:
self._crosshair_size = size
# Check if actually displayed size needs to be adjusted due to minimal size
size = self._get_corrected_crosshair_size(size)
pos = self.vline.pos()
pos[1] = self.hline.pos()[1] - size[1] / 2
pos[0] -= size[0] / 2
if self._crosshair_range:
crange = self._crosshair_range
self.crosshair.maxBounds = QtCore.QRectF(crange[0][0] - size[0] / 2,
crange[1][0] - size[1] / 2,
crange[0][1] - crange[0][0] + size[0],
crange[1][1] - crange[1][0] + size[1])
self.crosshair.blockSignals(True)
self.crosshair.setSize(size)
self.crosshair.setPos(pos)
self.crosshair.blockSignals(False)
return
def set_crosshair_min_size_factor(self, factor):
"""
Sets the minimum crosshair size factor. This will determine the minimum size of the
smallest edge of the crosshair center rectangle.
This minimum size is calculated by taking the smallest visible axis of the ViewBox and
multiplying it with the scale factor set by this method.
The crosshair rectangle will be then scaled accordingly if the set crosshair size is
smaller than this minimal size.
@param float factor: The scale factor to set. If <= 0 no minimal crosshair size enforced.
"""
if factor <= 0:
self._min_crosshair_factor = 0
elif factor <= 1:
self._min_crosshair_factor = float(factor)
else:
raise ValueError('Crosshair min size factor must be a value <= 1.')
return
def set_crosshair_range(self, new_range):
"""
Sets a range boundary for the crosshair position.
@param float[2][2] new_range: two min-max range value tuples (for x and y axis).
If None set unlimited ranges.
"""
if new_range is None:
self.vline.setBounds([None, None])
self.hline.setBounds([None, None])
self.crosshair.maxBounds = None
else:
self.vline.setBounds(new_range[0])
self.hline.setBounds(new_range[1])
size = self.crosshair.size()
pos = self.crosshair_position
self.crosshair.maxBounds = QtCore.QRectF(new_range[0][0] - size[0] / 2,
new_range[1][0] - size[1] / 2,
new_range[0][1] - new_range[0][0] + size[0],
new_range[1][1] - new_range[1][0] + size[1])
self.crosshair.setPos(pos[0] - size[0] / 2, pos[1] - size[1] / 2)
self._crosshair_range = new_range
return
def set_crosshair_pen(self, pen):
"""
Sets the pyqtgraph compatible pen to be used for drawing the crosshair lines.
@param pen: pyqtgraph compatible pen to use
"""
self.crosshair.setPen(pen)
self.vline.setPen(pen)
self.hline.setPen(pen)
return
def _constraint_crosshair_size(self):
if self._min_crosshair_factor == 0:
return
if self._crosshair_size[0] == 0 or self._crosshair_size[1] == 0:
return
corr_size = self._get_corrected_crosshair_size(self._crosshair_size)
if corr_size != tuple(self.crosshair.size()):
self.set_crosshair_size(corr_size, force_default=False)
return
def _get_corrected_crosshair_size(self, size):
try:
size = tuple(size)
except TypeError:
size = (size.width(), size.height())
min_size = min(size)
if min_size == 0:
return size
vb_size = self.getViewBox().viewRect().size()
short_index = int(vb_size.width() > vb_size.height())
min_vb_size = vb_size.width() if short_index == 0 else vb_size.height()
min_vb_size *= self._min_crosshair_factor
if min_size < min_vb_size:
scale_factor = min_vb_size / min_size
size = (size[0] * scale_factor, size[1] * scale_factor)
return size
