def mouseReleaseEvent(self, ev):
if ev.button() == Qt.MouseButton.LeftButton:
item = self.itemAt(ev.pos())
if item is not None:
if self.over_close(item, ev.pos()):
tab = item.tabref()
if tab is not None:
self.tab_close_requested.emit(tab)
ev.accept()
return
return QTreeWidget.mouseReleaseEvent(self, ev)
def displayFilesDock(self):
"""Dock widget that displays the movie file location in a QLineEdit
widget, provides a button for opening directories with images and GIFs,
and shows the media from the selected folder in a QTreeWidget."""
self.files_dock = QDockWidget()
self.files_dock.setWindowTitle("Media Folder")
self.files_dock.setAllowedAreas(Qt.DockWidgetArea.LeftDockWidgetArea)
folder_label = QLabel("Media Location:")
# The QLineEdit widget is set to read-only as a quick way to display
# the folder path
self.folder_line = QLineEdit()
self.folder_line.setMinimumWidth(100)
self.folder_line.setReadOnly(True)
open_button = QPushButton("Open...")
open_button.clicked.connect(self.openDirectory)
folder_h_box = QHBoxLayout()
folder_h_box.addWidget(folder_label)
folder_h_box.addWidget(self.folder_line)
folder_h_box.addWidget(open_button)
self.files_tree = QTreeWidget()
self.files_tree.setHeaderLabel("Media Files")
self.files_tree.setColumnCount(1)
# Set up the dock's layout
dock_v_box = QVBoxLayout()
dock_v_box.addLayout(folder_h_box)
dock_v_box.addWidget(self.files_tree)
dock_container = QWidget()
dock_container.setLayout(dock_v_box)
self.files_dock.setWidget(dock_container)
self.addDockWidget(Qt.DockWidgetArea.LeftDockWidgetArea,
self.files_dock)
def eventFilter(self, widget, event):
if widget is self.viewport():
etype = event.type()
item = last_item = self._last_item()
if etype == QEvent.Type.MouseMove:
pos = event.pos()
item = self.itemAt(pos)
if item is not None:
item.setData(0, CLOSE_HOVER_ROLE,
self.over_close(item, pos))
elif etype == QEvent.Type.Leave:
item = None
if item is not last_item:
if last_item is not None:
last_item.set_data(HOVER_ROLE, False)
last_item.set_data(CLOSE_HOVER_ROLE, False)
self._last_item = (
lambda: None) if item is None else weakref.ref(item)
return QTreeWidget.eventFilter(self, widget, event)
def initUI(self):
self.grid = QGridLayout(self)
self.file_control_grid = QGridLayout()
self.file_control_grid.setSpacing(3)
self.grid.addLayout(self.file_control_grid, 0, 0)
self.file_tree_grid = QGridLayout()
self.file_tree_grid.setSpacing(3)
self.grid.addLayout(self.file_tree_grid, 1, 0)
self.group_control_grid = QGridLayout()
self.group_control_grid.setSpacing(3)
self.grid.addLayout(self.group_control_grid, 0, 1)
self.attribute_grid = QGridLayout()
self.attribute_grid.setSpacing(3)
self.grid.addLayout(self.attribute_grid, 1, 1)
self.roi_control_grid = QGridLayout()
self.roi_control_grid.setSpacing(3)
self.grid.addLayout(self.roi_control_grid, 0, 2)
self.plot_grid = QGridLayout()
self.plot_grid.setSpacing(3)
self.grid.addLayout(self.plot_grid, 1, 2)
# # # # File control browser: # # # # # # # # (0,0)
loadButton = QPushButton("Load expt. file", self)
loadButton.clicked.connect(self.selectDataFile)
# Label with current expt file
self.currentExperimentLabel = QLabel('')
self.file_control_grid.addWidget(loadButton, 0, 0)
self.file_control_grid.addWidget(self.currentExperimentLabel, 1, 0)
directoryButton = QPushButton("Select data directory", self)
directoryButton.clicked.connect(self.selectDataDirectory)
self.file_control_grid.addWidget(directoryButton, 0, 1)
self.data_directory_display = QLabel('')
self.data_directory_display.setFont(QtGui.QFont('SansSerif', 8))
self.file_control_grid.addWidget(self.data_directory_display, 1, 1)
# Attach metadata to file
attachDatabutton = QPushButton("Attach metadata to file", self)
attachDatabutton.clicked.connect(self.attachData)
self.file_control_grid.addWidget(attachDatabutton, 2, 0, 1, 2)
# Select image data file
selectImageDataFileButton = QPushButton("Select image data file", self)
selectImageDataFileButton.clicked.connect(self.selectImageDataFile)
self.file_control_grid.addWidget(selectImageDataFileButton, 3, 0, 1, 2)
# # # # File tree: # # # # # # # # (1,0)
self.groupTree = QTreeWidget(self)
self.groupTree.setHeaderHidden(True)
self.groupTree.itemClicked.connect(self.onTreeItemClicked)
self.file_tree_grid.addWidget(self.groupTree, 3, 0, 2, 7)
# # # # Group control: # # # # # # # # (0, 1)
deleteGroupButton = QPushButton("Delete selected group", self)
deleteGroupButton.clicked.connect(self.deleteSelectedGroup)
self.group_control_grid.addWidget(deleteGroupButton, 0, 0, 1, 2)
# File name display
self.currentImageFileNameLabel = QLabel('')
self.group_control_grid.addWidget(self.currentImageFileNameLabel, 1, 0)
# Channel drop down
ch_label = QLabel('Channel:')
self.ChannelComboBox = QComboBox(self)
self.ChannelComboBox.addItem("1")
self.ChannelComboBox.addItem("0")
self.ChannelComboBox.activated.connect(self.selectChannel)
self.group_control_grid.addWidget(ch_label, 2, 0)
self.group_control_grid.addWidget(self.ChannelComboBox, 2, 1)
# # # # Attribute table: # # # # # # # # (1, 1)
self.tableAttributes = QTableWidget()
self.tableAttributes.setStyleSheet("")
self.tableAttributes.setColumnCount(2)
self.tableAttributes.setObjectName("tableAttributes")
self.tableAttributes.setRowCount(0)
item = QTableWidgetItem()
font = QtGui.QFont()
font.setPointSize(10)
item.setFont(font)
item.setBackground(QtGui.QColor(121, 121, 121))
brush = QtGui.QBrush(QtGui.QColor(91, 91, 91))
brush.setStyle(QtCore.Qt.BrushStyle.SolidPattern)
item.setForeground(brush)
self.tableAttributes.setHorizontalHeaderItem(0, item)
item = QTableWidgetItem()
item.setBackground(QtGui.QColor(123, 123, 123))
brush = QtGui.QBrush(QtGui.QColor(91, 91, 91))
brush.setStyle(QtCore.Qt.BrushStyle.SolidPattern)
item.setForeground(brush)
self.tableAttributes.setHorizontalHeaderItem(1, item)
self.tableAttributes.horizontalHeader().setCascadingSectionResizes(
True)
self.tableAttributes.horizontalHeader().setHighlightSections(False)
self.tableAttributes.horizontalHeader().setSortIndicatorShown(True)
self.tableAttributes.horizontalHeader().setStretchLastSection(True)
self.tableAttributes.verticalHeader().setVisible(False)
self.tableAttributes.verticalHeader().setHighlightSections(False)
item = self.tableAttributes.horizontalHeaderItem(0)
item.setText("Attribute")
item = self.tableAttributes.horizontalHeaderItem(1)
item.setText("Value")
self.tableAttributes.itemChanged.connect(self.update_attrs_to_file)
self.attribute_grid.addWidget(self.tableAttributes, 3, 0, 1, 8)
# # # # Roi control # # # # # # # # (0, 2)
# ROI type drop-down
self.RoiTypeComboBox = QComboBox(self)
self.RoiTypeComboBox.addItem("freehand")
radii = [1, 2, 3, 4, 6, 8]
for radius in radii:
self.RoiTypeComboBox.addItem("circle:" + str(radius))
self.RoiTypeComboBox.activated.connect(self.selectRoiType)
self.roi_control_grid.addWidget(self.RoiTypeComboBox, 0, 0)
# Clear all ROIs button
self.clearROIsButton = QPushButton("Clear ROIs", self)
self.clearROIsButton.clicked.connect(self.clearRois)
self.roi_control_grid.addWidget(self.clearROIsButton, 0, 2)
# Response display type dropdown
self.RoiResponseTypeComboBox = QComboBox(self)
self.RoiResponseTypeComboBox.addItem("RawTrace")
self.RoiResponseTypeComboBox.addItem("TrialAverage")
self.RoiResponseTypeComboBox.addItem("TrialResponses")
self.RoiResponseTypeComboBox.addItem("TrialAverageDFF")
self.roi_control_grid.addWidget(self.RoiResponseTypeComboBox, 2, 2)
# ROIset file name line edit box
self.defaultRoiSetName = "roi_set_name"
self.le_roiSetName = QLineEdit(self.defaultRoiSetName)
self.roi_control_grid.addWidget(self.le_roiSetName, 1, 1)
# Save ROIs button
self.saveROIsButton = QPushButton("Save ROIs", self)
self.saveROIsButton.clicked.connect(self.saveRois)
self.roi_control_grid.addWidget(self.saveROIsButton, 1, 0)
# Load ROI set combobox
self.loadROIsComboBox = QComboBox(self)
self.loadROIsComboBox.addItem("(load existing ROI set)")
self.loadROIsComboBox.activated.connect(self.selectedExistingRoiSet)
self.roi_control_grid.addWidget(self.loadROIsComboBox, 1, 2)
self.updateExistingRoiSetList()
# Delete current roi button
self.deleteROIButton = QPushButton("Delete ROI", self)
self.deleteROIButton.clicked.connect(self.deleteRoi)
self.roi_control_grid.addWidget(self.deleteROIButton, 2, 0)
# Current roi slider
self.roiSlider = QSlider(QtCore.Qt.Orientation.Horizontal, self)
self.roiSlider.setMinimum(0)
self.roiSlider.setMaximum(self.max_rois)
self.roiSlider.valueChanged.connect(self.sliderUpdated)
self.roi_control_grid.addWidget(self.roiSlider, 2, 1, 1, 1)
ctx = plt.rc_context({
'xtick.major.size': 1,
'axes.spines.top': False,
'axes.spines.right': False,
'xtick.labelsize': 'xx-small',
'ytick.labelsize': 'xx-small',
'xtick.major.size': 1.0,
'ytick.major.size': 1.0,
'xtick.major.pad': 1.0,
'ytick.major.pad': 1.0
})
with ctx:
self.responseFig = plt.figure(frameon=False, layout='constrained')
self.responsePlot = self.responseFig.add_subplot(111)
self.responseCanvas = FigureCanvas(self.responseFig)
self.responseCanvas.draw_idle()
self.plot_grid.addWidget(self.responseCanvas, 0, 0)
# # # # Image canvas # # # # # # # # (1, 2)
self.roi_fig = plt.figure()
self.roi_ax = self.roi_fig.add_subplot(111)
self.roi_canvas = FigureCanvas(self.roi_fig)
self.toolbar = NavigationToolbar(self.roi_canvas, self)
self.roi_ax.set_aspect('equal')
self.roi_ax.set_axis_off()
self.plot_grid.addWidget(self.toolbar, 1, 0)
self.plot_grid.addWidget(self.roi_canvas, 2, 0)
self.plot_grid.setRowStretch(0, 1)
self.plot_grid.setRowStretch(1, 3)
self.plot_grid.setRowStretch(2, 3)
# Current z slice slider
self.zSlider = QSlider(QtCore.Qt.Orientation.Horizontal, self)
self.zSlider.setMinimum(0)
self.zSlider.setMaximum(50)
self.zSlider.setValue(0)
self.zSlider.valueChanged.connect(self.zSliderUpdated)
self.plot_grid.addWidget(self.zSlider, 3, 0)
self.roi_fig.tight_layout()
self.setWindowTitle('Visanalysis')
self.setGeometry(200, 200, 1200, 600)
self.show()
class DataGUI(QWidget):
def __init__(self):
super().__init__()
self.experiment_file_name = None
self.experiment_file_directory = None
self.data_directory = None
self.max_rois = 50
self.roi_type = 'freehand'
self.roi_radius = None
self.existing_roi_set_paths = {}
self.current_roi_index = 0
self.current_z_slice = 0
self.current_channel = 1 # index
self.image_series_name = ''
self.series_number = None
self.roi_response = []
self.roi_mask = []
self.roi_path = []
self.roi_image = None
self.roi_path_list = []
self.blank_image = np.zeros((1, 1))
self.colors = [
mcolors.to_rgb(x) for x in list(mcolors.TABLEAU_COLORS)[:20]
]
self.initUI()
def initUI(self):
self.grid = QGridLayout(self)
self.file_control_grid = QGridLayout()
self.file_control_grid.setSpacing(3)
self.grid.addLayout(self.file_control_grid, 0, 0)
self.file_tree_grid = QGridLayout()
self.file_tree_grid.setSpacing(3)
self.grid.addLayout(self.file_tree_grid, 1, 0)
self.group_control_grid = QGridLayout()
self.group_control_grid.setSpacing(3)
self.grid.addLayout(self.group_control_grid, 0, 1)
self.attribute_grid = QGridLayout()
self.attribute_grid.setSpacing(3)
self.grid.addLayout(self.attribute_grid, 1, 1)
self.roi_control_grid = QGridLayout()
self.roi_control_grid.setSpacing(3)
self.grid.addLayout(self.roi_control_grid, 0, 2)
self.plot_grid = QGridLayout()
self.plot_grid.setSpacing(3)
self.grid.addLayout(self.plot_grid, 1, 2)
# # # # File control browser: # # # # # # # # (0,0)
loadButton = QPushButton("Load expt. file", self)
loadButton.clicked.connect(self.selectDataFile)
# Label with current expt file
self.currentExperimentLabel = QLabel('')
self.file_control_grid.addWidget(loadButton, 0, 0)
self.file_control_grid.addWidget(self.currentExperimentLabel, 1, 0)
directoryButton = QPushButton("Select data directory", self)
directoryButton.clicked.connect(self.selectDataDirectory)
self.file_control_grid.addWidget(directoryButton, 0, 1)
self.data_directory_display = QLabel('')
self.data_directory_display.setFont(QtGui.QFont('SansSerif', 8))
self.file_control_grid.addWidget(self.data_directory_display, 1, 1)
# Attach metadata to file
attachDatabutton = QPushButton("Attach metadata to file", self)
attachDatabutton.clicked.connect(self.attachData)
self.file_control_grid.addWidget(attachDatabutton, 2, 0, 1, 2)
# Select image data file
selectImageDataFileButton = QPushButton("Select image data file", self)
selectImageDataFileButton.clicked.connect(self.selectImageDataFile)
self.file_control_grid.addWidget(selectImageDataFileButton, 3, 0, 1, 2)
# # # # File tree: # # # # # # # # (1,0)
self.groupTree = QTreeWidget(self)
self.groupTree.setHeaderHidden(True)
self.groupTree.itemClicked.connect(self.onTreeItemClicked)
self.file_tree_grid.addWidget(self.groupTree, 3, 0, 2, 7)
# # # # Group control: # # # # # # # # (0, 1)
deleteGroupButton = QPushButton("Delete selected group", self)
deleteGroupButton.clicked.connect(self.deleteSelectedGroup)
self.group_control_grid.addWidget(deleteGroupButton, 0, 0, 1, 2)
# File name display
self.currentImageFileNameLabel = QLabel('')
self.group_control_grid.addWidget(self.currentImageFileNameLabel, 1, 0)
# Channel drop down
ch_label = QLabel('Channel:')
self.ChannelComboBox = QComboBox(self)
self.ChannelComboBox.addItem("1")
self.ChannelComboBox.addItem("0")
self.ChannelComboBox.activated.connect(self.selectChannel)
self.group_control_grid.addWidget(ch_label, 2, 0)
self.group_control_grid.addWidget(self.ChannelComboBox, 2, 1)
# # # # Attribute table: # # # # # # # # (1, 1)
self.tableAttributes = QTableWidget()
self.tableAttributes.setStyleSheet("")
self.tableAttributes.setColumnCount(2)
self.tableAttributes.setObjectName("tableAttributes")
self.tableAttributes.setRowCount(0)
item = QTableWidgetItem()
font = QtGui.QFont()
font.setPointSize(10)
item.setFont(font)
item.setBackground(QtGui.QColor(121, 121, 121))
brush = QtGui.QBrush(QtGui.QColor(91, 91, 91))
brush.setStyle(QtCore.Qt.BrushStyle.SolidPattern)
item.setForeground(brush)
self.tableAttributes.setHorizontalHeaderItem(0, item)
item = QTableWidgetItem()
item.setBackground(QtGui.QColor(123, 123, 123))
brush = QtGui.QBrush(QtGui.QColor(91, 91, 91))
brush.setStyle(QtCore.Qt.BrushStyle.SolidPattern)
item.setForeground(brush)
self.tableAttributes.setHorizontalHeaderItem(1, item)
self.tableAttributes.horizontalHeader().setCascadingSectionResizes(
True)
self.tableAttributes.horizontalHeader().setHighlightSections(False)
self.tableAttributes.horizontalHeader().setSortIndicatorShown(True)
self.tableAttributes.horizontalHeader().setStretchLastSection(True)
self.tableAttributes.verticalHeader().setVisible(False)
self.tableAttributes.verticalHeader().setHighlightSections(False)
item = self.tableAttributes.horizontalHeaderItem(0)
item.setText("Attribute")
item = self.tableAttributes.horizontalHeaderItem(1)
item.setText("Value")
self.tableAttributes.itemChanged.connect(self.update_attrs_to_file)
self.attribute_grid.addWidget(self.tableAttributes, 3, 0, 1, 8)
# # # # Roi control # # # # # # # # (0, 2)
# ROI type drop-down
self.RoiTypeComboBox = QComboBox(self)
self.RoiTypeComboBox.addItem("freehand")
radii = [1, 2, 3, 4, 6, 8]
for radius in radii:
self.RoiTypeComboBox.addItem("circle:" + str(radius))
self.RoiTypeComboBox.activated.connect(self.selectRoiType)
self.roi_control_grid.addWidget(self.RoiTypeComboBox, 0, 0)
# Clear all ROIs button
self.clearROIsButton = QPushButton("Clear ROIs", self)
self.clearROIsButton.clicked.connect(self.clearRois)
self.roi_control_grid.addWidget(self.clearROIsButton, 0, 2)
# Response display type dropdown
self.RoiResponseTypeComboBox = QComboBox(self)
self.RoiResponseTypeComboBox.addItem("RawTrace")
self.RoiResponseTypeComboBox.addItem("TrialAverage")
self.RoiResponseTypeComboBox.addItem("TrialResponses")
self.RoiResponseTypeComboBox.addItem("TrialAverageDFF")
self.roi_control_grid.addWidget(self.RoiResponseTypeComboBox, 2, 2)
# ROIset file name line edit box
self.defaultRoiSetName = "roi_set_name"
self.le_roiSetName = QLineEdit(self.defaultRoiSetName)
self.roi_control_grid.addWidget(self.le_roiSetName, 1, 1)
# Save ROIs button
self.saveROIsButton = QPushButton("Save ROIs", self)
self.saveROIsButton.clicked.connect(self.saveRois)
self.roi_control_grid.addWidget(self.saveROIsButton, 1, 0)
# Load ROI set combobox
self.loadROIsComboBox = QComboBox(self)
self.loadROIsComboBox.addItem("(load existing ROI set)")
self.loadROIsComboBox.activated.connect(self.selectedExistingRoiSet)
self.roi_control_grid.addWidget(self.loadROIsComboBox, 1, 2)
self.updateExistingRoiSetList()
# Delete current roi button
self.deleteROIButton = QPushButton("Delete ROI", self)
self.deleteROIButton.clicked.connect(self.deleteRoi)
self.roi_control_grid.addWidget(self.deleteROIButton, 2, 0)
# Current roi slider
self.roiSlider = QSlider(QtCore.Qt.Orientation.Horizontal, self)
self.roiSlider.setMinimum(0)
self.roiSlider.setMaximum(self.max_rois)
self.roiSlider.valueChanged.connect(self.sliderUpdated)
self.roi_control_grid.addWidget(self.roiSlider, 2, 1, 1, 1)
ctx = plt.rc_context({
'xtick.major.size': 1,
'axes.spines.top': False,
'axes.spines.right': False,
'xtick.labelsize': 'xx-small',
'ytick.labelsize': 'xx-small',
'xtick.major.size': 1.0,
'ytick.major.size': 1.0,
'xtick.major.pad': 1.0,
'ytick.major.pad': 1.0
})
with ctx:
self.responseFig = plt.figure(frameon=False, layout='constrained')
self.responsePlot = self.responseFig.add_subplot(111)
self.responseCanvas = FigureCanvas(self.responseFig)
self.responseCanvas.draw_idle()
self.plot_grid.addWidget(self.responseCanvas, 0, 0)
# # # # Image canvas # # # # # # # # (1, 2)
self.roi_fig = plt.figure()
self.roi_ax = self.roi_fig.add_subplot(111)
self.roi_canvas = FigureCanvas(self.roi_fig)
self.toolbar = NavigationToolbar(self.roi_canvas, self)
self.roi_ax.set_aspect('equal')
self.roi_ax.set_axis_off()
self.plot_grid.addWidget(self.toolbar, 1, 0)
self.plot_grid.addWidget(self.roi_canvas, 2, 0)
self.plot_grid.setRowStretch(0, 1)
self.plot_grid.setRowStretch(1, 3)
self.plot_grid.setRowStretch(2, 3)
# Current z slice slider
self.zSlider = QSlider(QtCore.Qt.Orientation.Horizontal, self)
self.zSlider.setMinimum(0)
self.zSlider.setMaximum(50)
self.zSlider.setValue(0)
self.zSlider.valueChanged.connect(self.zSliderUpdated)
self.plot_grid.addWidget(self.zSlider, 3, 0)
self.roi_fig.tight_layout()
self.setWindowTitle('Visanalysis')
self.setGeometry(200, 200, 1200, 600)
self.show()
def _populateTree(self, widget, dict):
widget.clear()
self.fill_item(widget.invisibleRootItem(), dict)
def fill_item(self, item, value):
item.setExpanded(True)
if type(value) is dict:
for key, val in sorted(value.items()):
child = QTreeWidgetItem()
child.setText(0, key)
item.addChild(child)
self.fill_item(child, val)
elif type(value) is list:
for val in value:
child = QTreeWidgetItem()
item.addChild(child)
if type(val) is dict:
child.setText(0, '[dict]')
self.fill_item(child, val)
elif type(val) is list:
child.setText(0, '[list]')
self.fill_item(child, val)
else:
child.setText(0, val)
child.setExpanded(True)
else:
child = QTreeWidgetItem()
child.setText(0, value)
item.addChild(child)
def onTreeItemClicked(self, item, column):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
group_path = h5io.getPathFromTreeItem(
self.groupTree.selectedItems()[0])
self.clearRois()
self.series_number = None
if 'series_' in group_path:
self.series_number = int(
group_path.split('series_')[-1].split('/')[0])
if self.plugin.dataIsAttached(file_path, self.series_number):
self.plugin.updateImagingDataObject(
self.experiment_file_directory, self.experiment_file_name,
self.series_number)
# look for image_file_name or ask user to select it
if self.data_directory is not None:
image_file_name = h5io.readImageFileName(
file_path, self.series_number)
if image_file_name is None or image_file_name == '':
image_file_path, _ = QFileDialog.getOpenFileName(
self, "Select image file")
print('User selected image file at {}'.format(
image_file_path))
image_file_name = os.path.split(image_file_path)[-1]
self.data_directory = os.path.split(
image_file_path)[:-1][0]
h5io.attachImageFileName(file_path, self.series_number,
image_file_name)
print('Attached image_file_name {} to series {}'.format(
image_file_name, self.series_number))
print('Data directory is {}'.format(self.data_directory))
self.image_file_name = image_file_name
self.currentImageFileNameLabel.setText(self.image_file_name)
else: # clicked part of the tree upstream of any series
self.series_number = None
if item.parent() is not None:
if item.parent().text(
column) == 'rois': # selected existing roi group
roi_set_name = item.text(column)
# print('Selected roi set {} from series {}'.format(roi_set_name, self.series_number))
self.le_roiSetName.setText(roi_set_name)
roi_set_path = h5io.getPathFromTreeItem(
self.groupTree.selectedItems()[0])
self.loadRois(roi_set_path)
self.redrawRoiTraces()
if group_path != '':
attr_dict = h5io.getAttributesFromGroup(file_path, group_path)
editable_values = True # user can edit metadata
self.populate_attrs(attr_dict=attr_dict,
editable_values=editable_values)
# show roi image
if self.series_number is not None: # Clicked on node of the tree associated with a single series
if self.data_directory is not None: # user has selected a raw data directory
if self.plugin.dataIsAttached(file_path, self.series_number):
self.plugin.updateImageSeries(
data_directory=self.data_directory,
image_file_name=self.image_file_name,
series_number=self.series_number,
channel=self.current_channel)
self.roi_image = self.plugin.mean_brain
self.zSlider.setValue(0)
self.zSlider.setMaximum(self.roi_image.shape[2] - 1)
self.redrawRoiTraces()
else:
print('Attach metadata to file before drawing rois')
else:
print('Select a data directory before drawing rois')
# # # TEST # # #
memory_usage = psutil.Process(os.getpid()).memory_info().rss * 10**-9
print('Current Memory Usage: {:.2f}GB'.format(memory_usage))
sys.stdout.flush()
# # # TEST # # #
def updateExistingRoiSetList(self):
if self.experiment_file_name is not None:
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
self.existing_roi_set_paths = self.plugin.getRoiSetPaths(
file_path) # dictionary of name: full path
self.loadROIsComboBox.clear()
for r_path in self.existing_roi_set_paths:
self.loadROIsComboBox.addItem(r_path)
self.show()
def selectedExistingRoiSet(self):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
roi_set_key = self.loadROIsComboBox.currentText()
roi_set_path = self.existing_roi_set_paths[roi_set_key]
_, _, self.roi_path, self.roi_mask = self.plugin.loadRoiSet(
file_path, roi_set_path)
if self.series_number is not None:
self.roi_response = []
for new_path in self.roi_path:
new_roi_resp = self.plugin.getRoiDataFromPath(
roi_path=new_path)
self.roi_response.append(new_roi_resp)
# update slider to show most recently drawn roi response
self.current_roi_index = len(self.roi_response) - 1
self.roiSlider.setValue(self.current_roi_index)
# Update figures
self.redrawRoiTraces()
def selectDataFile(self):
filePath, _ = QFileDialog.getOpenFileName(
self, "Open experiment (hdf5) file")
self.experiment_file_name = os.path.split(filePath)[1].split('.')[0]
self.experiment_file_directory = os.path.split(filePath)[0]
if self.experiment_file_name != '':
self.currentExperimentLabel.setText(self.experiment_file_name)
self.initializeDataAnalysis()
self.populateGroups()
self.updateExistingRoiSetList()
def selectDataDirectory(self):
filePath = str(
QFileDialog.getExistingDirectory(self, "Select data directory"))
self.data_directory = filePath
self.data_directory_display.setText('..' + self.data_directory[-24:])
def initializeDataAnalysis(self):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
data_type = h5io.getDataType(file_path)
# Load plugin based on Rig name in hdf5 file
if data_type == 'Bruker':
from visanalysis.plugin import bruker
self.plugin = bruker.BrukerPlugin()
elif data_type == 'AODscope':
from visanalysis.plugin import aodscope
self.plugin = aodscope.AodScopePlugin()
else:
self.plugin = h5io.BasePlugin()
self.plugin.parent_gui = self
# # # TEST # # #
memory_usage = psutil.Process(os.getpid()).memory_info().rss * 10**-9
print('Current memory usage: {:.2f}GB'.format(memory_usage))
sys.stdout.flush()
# # # TEST # # #
def attachData(self):
if self.data_directory is not None:
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
self.plugin.attachData(self.experiment_file_name, file_path,
self.data_directory)
print('Data attached')
else:
print('Select a data directory before attaching new data')
def selectImageDataFile(self):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
image_file_path, _ = QFileDialog.getOpenFileName(
self, "Select image file")
print('User selected image file at {}'.format(image_file_path))
self.image_file_name = os.path.split(image_file_path)[-1]
self.data_directory = os.path.split(image_file_path)[:-1][0]
h5io.attachImageFileName(file_path, self.series_number,
self.image_file_name)
print('Attached image_file_name {} to series {}'.format(
self.image_file_name, self.series_number))
print('Data directory is {}'.format(self.data_directory))
self.currentImageFileNameLabel.setText(self.image_file_name)
# show roi image
if self.series_number is not None:
if self.data_directory is not None: # user has selected a raw data directory
self.plugin.updateImageSeries(
data_directory=self.data_directory,
image_file_name=self.image_file_name,
series_number=self.series_number,
channel=self.current_channel)
self.roi_image = self.plugin.mean_brain
self.zSlider.setValue(0)
self.zSlider.setMaximum(self.roi_image.shape[2] - 1)
self.redrawRoiTraces()
else:
print('Select a data directory before drawing rois')
def deleteSelectedGroup(self):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
group_path = h5io.getPathFromTreeItem(
self.groupTree.selectedItems()[0])
group_name = group_path.split('/')[-1]
buttonReply = QMessageBox.question(
self, 'Delete series',
"Are you sure you want to delete group {}?".format(group_name),
QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No,
QMessageBox.StandardButton.No)
if buttonReply == QMessageBox.StandardButton.Yes:
h5io.deleteGroup(file_path=file_path, group_path=group_path)
print('Deleted group {}'.format(group_name))
self.updateExistingRoiSetList()
self.populateGroups()
else:
print('Delete aborted')
def populateGroups(self):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
self.group_dset_dict = h5io.getHierarchy(file_path)
self._populateTree(self.groupTree, self.group_dset_dict)
def populate_attrs(self, attr_dict=None, editable_values=False):
"""Populate attribute for currently selected group."""
self.tableAttributes.blockSignals(
True) # block udpate signals for auto-filled forms
self.tableAttributes.setRowCount(0)
self.tableAttributes.setColumnCount(2)
self.tableAttributes.setSortingEnabled(False)
if attr_dict:
for num, key in enumerate(attr_dict):
self.tableAttributes.insertRow(self.tableAttributes.rowCount())
key_item = QTableWidgetItem(key)
key_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable
| QtCore.Qt.ItemFlag.ItemIsEnabled)
self.tableAttributes.setItem(num, 0, key_item)
val_item = QTableWidgetItem(str(attr_dict[key]))
if editable_values:
val_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable
| QtCore.Qt.ItemFlag.ItemIsEditable
| QtCore.Qt.ItemFlag.ItemIsEnabled)
else:
val_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable
| QtCore.Qt.ItemFlag.ItemIsEnabled)
self.tableAttributes.setItem(num, 1, val_item)
self.tableAttributes.blockSignals(False)
def update_attrs_to_file(self, item):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
group_path = h5io.getPathFromTreeItem(
self.groupTree.selectedItems()[0])
attr_key = self.tableAttributes.item(item.row(), 0).text()
attr_val = item.text()
# update attr in file
h5io.changeAttribute(file_path=file_path,
group_path=group_path,
attr_key=attr_key,
attr_val=attr_val)
print('Changed attr {} to = {}'.format(attr_key, attr_val))
# %% # # # # # # # # ROI SELECTOR WIDGET # # # # # # # # # # # # # # # # # # #
def refreshLassoWidget(self, keep_paths=False):
self.roi_ax.clear()
init_lasso = False
if self.roi_image is not None:
if len(self.roi_mask) > 0:
newImage = plot_tools.overlayImage(
self.roi_image[:, :, self.current_z_slice],
self.roi_mask,
0.5,
self.colors,
z=self.current_z_slice)
else:
newImage = self.roi_image[:, :, self.current_z_slice]
self.roi_ax.imshow(newImage, cmap=cm.gray)
init_lasso = True
else:
self.roi_ax.imshow(self.blank_image)
self.roi_ax.set_axis_off()
self.roi_canvas.draw()
if not keep_paths:
self.roi_path_list = []
if init_lasso:
if self.roi_type == 'circle':
self.lasso_1 = EllipseSelector(self.roi_ax,
onselect=self.newEllipse,
button=1)
elif self.roi_type == 'freehand':
self.lasso_1 = LassoSelector(self.roi_ax,
onselect=self.newFreehand,
button=1)
self.lasso_2 = LassoSelector(self.roi_ax,
onselect=self.appendFreehand,
button=3)
else:
print(
'Warning ROI type not recognized. Choose circle or freehand'
)
def newFreehand(self, verts):
new_roi_path = path.Path(verts)
new_roi_path.z_level = self.zSlider.value()
new_roi_path.channel = self.current_channel
self.updateRoiSelection([new_roi_path])
def appendFreehand(self, verts):
print('Appending rois, hit Enter/Return to finish')
new_roi_path = path.Path(verts)
new_roi_path.z_level = self.zSlider.value()
new_roi_path.channel = self.current_channel
self.roi_path_list.append(new_roi_path)
def keyPressEvent(self, event):
if type(event) == QtGui.QKeyEvent:
if np.any([
event.key() == QtCore.Qt.Key.Key_Return,
event.key() == QtCore.Qt.Key.Key_Enter
]):
if len(self.roi_path_list) > 0:
event.accept()
self.updateRoiSelection(self.roi_path_list)
else:
event.ignore()
else:
event.ignore()
else:
event.ignore()
def newEllipse(self, pos1, pos2, definedRadius=None):
x1 = np.round(pos1.xdata)
x2 = np.round(pos2.xdata)
y1 = np.round(pos1.ydata)
y2 = np.round(pos2.ydata)
radiusX = np.sqrt((x1 - x2)**2) / 2
radiusY = np.sqrt((y1 - y2)**2) / 2
if self.roi_radius is not None:
radiusX = self.roi_radius
center = (np.round((x1 + x2) / 2), np.round((y1 + y2) / 2))
new_roi_path = path.Path.circle(center=center, radius=radiusX)
new_roi_path.z_level = self.zSlider.value()
new_roi_path.channel = self.current_channel
self.updateRoiSelection([new_roi_path])
def updateRoiSelection(self, new_roi_path):
mask = self.plugin.getRoiMaskFromPath(new_roi_path)
new_roi_resp = self.plugin.getRoiDataFromPath(roi_path=new_roi_path)
if mask.sum() == 0:
print('No pixels in the roi you just drew')
return
# update list of roi data
self.roi_mask.append(mask)
self.roi_path.append(new_roi_path) # list of lists of paths
self.roi_response.append(new_roi_resp)
# update slider to show most recently drawn roi response
self.current_roi_index = len(self.roi_response) - 1
self.roiSlider.setValue(self.current_roi_index)
# Update figures
self.redrawRoiTraces()
def sliderUpdated(self):
self.current_roi_index = self.roiSlider.value()
self.redrawRoiTraces()
def zSliderUpdated(self):
self.current_z_slice = self.zSlider.value()
if self.roi_image is not None:
self.refreshLassoWidget(keep_paths=True)
def redrawRoiTraces(self):
self.clearRoiArtists()
if self.current_roi_index < len(self.roi_response):
current_raw_trace = np.squeeze(
self.roi_response[self.current_roi_index])
fxn_name = self.RoiResponseTypeComboBox.currentText()
display_trace = getattr(self.plugin,
'getRoiResponse_{}'.format(fxn_name))(
[current_raw_trace])
self.responsePlot.plot(display_trace,
color=self.colors[self.current_roi_index],
linewidth=1,
alpha=0.5)
self.responsePlot.set_xlim([0, len(display_trace)])
y_min = np.nanmin(display_trace)
y_max = np.nanmax(display_trace)
self.responsePlot.set_ylim([y_min, y_max])
self.responseCanvas.draw()
self.refreshLassoWidget(keep_paths=False)
# %% # # # # # # # # LOADING / SAVING / COMPUTING ROIS # # # # # # # # # # # # # # # # # # #
def loadRois(self, roi_set_path):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
self.roi_response, self.roi_image, self.roi_path, self.roi_mask = self.plugin.loadRoiSet(
file_path, roi_set_path)
self.zSlider.setValue(0)
self.zSlider.setMaximum(self.roi_image.shape[2] - 1)
def saveRois(self):
file_path = os.path.join(self.experiment_file_directory,
self.experiment_file_name + '.hdf5')
roi_set_name = self.le_roiSetName.text()
if roi_set_name in h5io.getAvailableRoiSetNames(
file_path, self.series_number):
buttonReply = QMessageBox.question(
self, 'Overwrite roi set',
"Are you sure you want to overwrite roi set: {}?".format(
roi_set_name),
QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No,
QMessageBox.StandardButton.No)
if buttonReply == QMessageBox.StandardButton.Yes:
self.plugin.saveRoiSet(file_path,
series_number=self.series_number,
roi_set_name=roi_set_name,
roi_mask=self.roi_mask,
roi_response=self.roi_response,
roi_image=self.roi_image,
roi_path=self.roi_path)
print('Saved roi set {} to series {}'.format(
roi_set_name, self.series_number))
self.populateGroups()
self.updateExistingRoiSetList()
else:
print('Overwrite aborted - pick a unique roi set name')
else:
self.plugin.saveRoiSet(file_path,
series_number=self.series_number,
roi_set_name=roi_set_name,
roi_mask=self.roi_mask,
roi_response=self.roi_response,
roi_image=self.roi_image,
roi_path=self.roi_path)
print('Saved roi set {} to series {}'.format(
roi_set_name, self.series_number))
self.populateGroups()
self.updateExistingRoiSetList()
def deleteRoi(self):
if self.current_roi_index < len(self.roi_response):
self.roi_mask.pop(self.current_roi_index)
self.roi_response.pop(self.current_roi_index)
self.roi_path.pop(self.current_roi_index)
self.roiSlider.setValue(self.current_roi_index - 1)
self.redrawRoiTraces()
def clearRois(self):
self.roi_mask = []
self.roi_response = []
self.roi_path = []
self.roi_image = None
self.clearRoiArtists()
self.redrawRoiTraces()
self.roi_ax.clear()
def clearRoiArtists(self):
for artist in self.responsePlot.lines + self.responsePlot.collections:
artist.remove()
def selectRoiType(self):
self.roi_type = self.RoiTypeComboBox.currentText().split(':')[0]
if 'circle' in self.RoiTypeComboBox.currentText():
self.roi_radius = int(
self.RoiTypeComboBox.currentText().split(':')[1])
else:
self.roi_radius = None
self.redrawRoiTraces()
def selectChannel(self):
self.current_channel = int(self.ChannelComboBox.currentText())
# show roi image
if self.series_number is not None:
if self.data_directory is not None: # user has selected a raw data directory
self.plugin.updateImageSeries(
data_directory=self.data_directory,
image_file_name=self.image_file_name,
series_number=self.series_number,
channel=self.current_channel)
self.roi_image = self.plugin.mean_brain
self.zSlider.setValue(0)
self.zSlider.setMaximum(self.roi_image.shape[2] - 1)
self.redrawRoiTraces()
else:
print('Select a data directory before drawing rois')
class MainWindow(QMainWindow):
def __init__(self):
""" MainWindow Constructor """
super().__init__()
self.initializeUI()
def initializeUI(self):
"""Initialize settings, call functions that define
UI elements, and display the main window."""
self.setMinimumSize(700, 400)
self.setWindowTitle("GIF and Image Viewer")
# Set up the main window, menu, and dock widget
self.setUpMainWindow()
self.displayFilesDock()
self.createActions()
self.createMenus()
self.createToolbar()
self.show() # Display the main window
def setUpMainWindow(self):
"""Set up the application's main window and widgets."""
self.movie = QMovie() # Create movie object
self.movie.stateChanged.connect(self.changeButtonStates)
self.media_label = QLabel() # Create label to place images/GIFs on
self.media_label.setPixmap(QPixmap("icons/image_label.png"))
self.media_label.setFrameShape(QFrame.Shape.StyledPanel)
self.media_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
self.setCentralWidget(self.media_label)
def createActions(self):
"""Create the application's menu actions."""
# Create actions for File menu
self.open_act = QAction("Open...", self, triggered=self.openDirectory)
self.open_act.setShortcut(QKeySequence.StandardKey.Open)
self.quit_act = QAction("Quit Viewer", self, triggered=self.close)
self.quit_act.setShortcut(QKeySequence.StandardKey.Quit) # Ctrl+Q
# Create actions for View menu
# Handle the visibility of the dock widget
self.show_dock_act = self.files_dock.toggleViewAction()
self.show_dock_act.setText("Show Media Folder")
# Create actions for the toolbar (These actions could also be
# added to the GUI's menu bar or to a context menu)
self.play_act = QAction(QIcon("icons/play.png"),
"Play",
self,
triggered=self.startMovie)
self.pause_act = QAction(QIcon("icons/pause.png"),
"Pause",
self,
triggered=self.pauseMovie)
self.stop_act = QAction(QIcon("icons/stop.png"),
"Stop/Reset",
self,
triggered=self.stopMovie)
self.disableMovieButtons()
def createMenus(self):
"""Create the application's menu."""
# Make the toolbar appear in the main window for macOS users.
# More information about this in Chapter 2 - Building the Foundation for GUIs
if QSysInfo.productType() == "macos" or "osx":
self.menuBar().setNativeMenuBar(False)
self.file_menu = self.menuBar().addMenu("&File")
self.file_menu.addAction(self.open_act)
self.file_menu.addSeparator()
self.file_menu.addAction(self.quit_act)
self.view_menu = self.menuBar().addMenu("&View")
self.view_menu.addAction(self.show_dock_act)
def createToolbar(self):
"""Create the application's toolbar for playing GIFs."""
toolbar = self.addToolBar("GIF Controls Toolbar")
toolbar.setIconSize(QSize(24, 24))
# Add actions to the toolbar
toolbar.addAction(self.play_act)
toolbar.addAction(self.pause_act)
toolbar.addAction(self.stop_act)
def displayFilesDock(self):
"""Dock widget that displays the movie file location in a QLineEdit
widget, provides a button for opening directories with images and GIFs,
and shows the media from the selected folder in a QTreeWidget."""
self.files_dock = QDockWidget()
self.files_dock.setWindowTitle("Media Folder")
self.files_dock.setAllowedAreas(Qt.DockWidgetArea.LeftDockWidgetArea)
folder_label = QLabel("Media Location:")
# The QLineEdit widget is set to read-only as a quick way to display
# the folder path
self.folder_line = QLineEdit()
self.folder_line.setMinimumWidth(100)
self.folder_line.setReadOnly(True)
open_button = QPushButton("Open...")
open_button.clicked.connect(self.openDirectory)
folder_h_box = QHBoxLayout()
folder_h_box.addWidget(folder_label)
folder_h_box.addWidget(self.folder_line)
folder_h_box.addWidget(open_button)
self.files_tree = QTreeWidget()
self.files_tree.setHeaderLabel("Media Files")
self.files_tree.setColumnCount(1)
# Set up the dock's layout
dock_v_box = QVBoxLayout()
dock_v_box.addLayout(folder_h_box)
dock_v_box.addWidget(self.files_tree)
dock_container = QWidget()
dock_container.setLayout(dock_v_box)
self.files_dock.setWidget(dock_container)
self.addDockWidget(Qt.DockWidgetArea.LeftDockWidgetArea,
self.files_dock)
def openDirectory(self):
"""Open a QFileDialog for selecting a local directory. Only display
image and GIF files."""
directory = QFileDialog.getExistingDirectory(
self, "Choose Directory", "", QFileDialog.Option.ShowDirsOnly
) # Specify the file mode to only select directories
if directory:
self.movie.setFileName(directory)
# Check if image data is valid before playing
if self.movie.isValid():
# Use setMovie() to set the label's contents as the selected GIF
self.media_label.setMovie(self.movie)
self.startMovie() # Call method to begin playing
def startMovie(self):
"""Start playing the movie."""
self.movie.start()
def pauseMovie(self):
"""Pause the movie."""
self.movie.setPaused(True)
def stopMovie(self):
"""Stop playing the movie and reset the movie back to
the first frame."""
self.movie.stop()
self.movie.jumpToFrame(0)
def changeButtonStates(self, state):
"""Slot that handles enabling/disabling buttons in the toolbar
based on the state of QMovie."""
if state == QMovie.MovieState.Running:
# The animation begins playing once control returns to the event loop
self.play_act.setEnabled(False)
self.pause_act.setEnabled(True)
self.stop_act.setEnabled(True)
if state == QMovie.MovieState.Paused:
self.play_act.setEnabled(True)
self.pause_act.setEnabled(False)
self.stop_act.setEnabled(False)
if state == QMovie.MovieState.NotRunning:
self.play_act.setEnabled(True)
self.pause_act.setEnabled(False)
self.stop_act.setEnabled(False)
def disableMovieButtons(self):
"""Simple method to disable the movie buttons in the toolbar."""
self.play_act.setEnabled(False)
self.pause_act.setEnabled(False)
self.stop_act.setEnabled(False)
def __init__(self, file: QIODevice):
super().__init__(file)
tree: QTreeWidget = QTreeWidget()
def __init__(self):
QTreeWidget.__init__(self)
self.itemExpanded.connect(self._item_expanded)
self.setHeaderHidden(True)
def __init__(self, parent):
QTreeWidget.__init__(self, parent)
self.deleted_parent_map = {}
pal = self.palette()
pal.setColor(QPalette.ColorRole.Highlight,
pal.color(QPalette.ColorRole.Base))
pal.setColor(QPalette.ColorRole.HighlightedText,
pal.color(QPalette.ColorRole.Text))
self.setPalette(pal)
self.setStyleSheet('''
QTreeView {
background: BG;
color: FG;
border: none;
}
QTreeView::item {
border: 1px solid transparent;
padding-top:0.5ex;
padding-bottom:0.5ex;
}
QTreeView::item:hover {
background: qlineargradient(x1: 0, y1: 0, x2: 0, y2: 1, stop: 0 GS, stop: 1 GE);
border: 1px solid BC;
border-radius: 6px;
}
QTreeView::branch {
background: BG;
}
QTreeView::branch:has-children:!has-siblings:closed, QTreeView::branch:closed:has-children:has-siblings {
image: url(CLOSED);
}
QTreeView::branch:open:has-children:!has-siblings, QTreeView::branch:open:has-children:has-siblings {
image: url(OPEN);
}
'''.replace(
'CLOSED', get_data_as_path('images/tree-closed.svg')).replace(
'OPEN', get_data_as_path('images/tree-open.svg')).replace(
'BG',
color('tab tree background', 'palette(window)')).replace(
'FG',
color('tab tree foreground',
'palette(window-text)')).replace(
'GS',
color(
'tab tree hover gradient start',
'#e7effd')).replace(
'GE',
color(
'tab tree hover gradient end',
'#cbdaf1')).replace(
'BC',
color(
'tab tree hover border',
'#bfcde4')))
self.setIconSize(QSize(ICON_SIZE, ICON_SIZE))
self.setAutoScrollMargin(ICON_SIZE * 2)
self.setAnimated(True)
self.setHeaderHidden(True)
self.setSelectionMode(QAbstractItemView.SelectionMode.SingleSelection)
self.setDragEnabled(True)
self.viewport().setAcceptDrops(True)
self.setDropIndicatorShown(True)
self.setDragDropMode(QAbstractItemView.DragDropMode.InternalMove)
self.setDefaultDropAction(Qt.DropAction.MoveAction)
self.invisibleRootItem().setFlags(Qt.ItemFlag.ItemIsDragEnabled
| Qt.ItemFlag.ItemIsDropEnabled
| self.invisibleRootItem().flags())
self.itemClicked.connect(self.item_clicked)
self.current_item = None
self.emphasis_font = QFont(self.font())
self.emphasis_font.setItalic(True)
self.setFocusPolicy(Qt.FocusPolicy.NoFocus)
self.loading_items = set()
self.delegate = TabDelegate(self)
self.setItemDelegate(self.delegate)
self.loading_animation_timer = t = QTimer(self)
t.setInterval(1000 // 60)
t.timeout.connect(self.repaint_loading_items)
self.setMouseTracking(True)
self._last_item = lambda: None
self.itemEntered.connect(self.item_entered)
self.setCursor(Qt.CursorShape.PointingHandCursor)
self.viewport().installEventFilter(self)
self.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu)
self.customContextMenuRequested.connect(self.show_context_menu)
class MainWindow(QMainWindow):
def __init__(self):
""" MainWindow Constructor """
super().__init__()
self.initializeUI()
def initializeUI(self):
"""Initialize settings, call functions that define
UI elements, and display the main window."""
self.setMinimumSize(700, 400)
self.setWindowTitle("GIF and Image Viewer")
# Set up the main window and dock widget
self.setUpMainWindow()
self.displayFilesDock()
self.show() # Display the main window
def setUpMainWindow(self):
"""Set up the application's main window and widgets."""
self.movie = QMovie() # Create movie object
self.media_label = QLabel() # Create label to place images/GIFs on
self.media_label.setPixmap(QPixmap("icons/image_label.png"))
self.media_label.setFrameShape(QFrame.Shape.StyledPanel)
self.media_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
self.setCentralWidget(self.media_label)
def displayFilesDock(self):
"""Dock widget that displays the movie file location in a QLineEdit
widget, provides a button for opening directories with images and GIFs,
and shows the media from the selected folder in a QTreeWidget."""
self.files_dock = QDockWidget()
self.files_dock.setWindowTitle("Media Folder")
self.files_dock.setAllowedAreas(Qt.DockWidgetArea.LeftDockWidgetArea)
folder_label = QLabel("Media Location:")
# The QLineEdit widget is set to read-only as a quick way to display
# the folder path
self.folder_line = QLineEdit()
self.folder_line.setMinimumWidth(100)
self.folder_line.setReadOnly(True)
open_button = QPushButton("Open...")
folder_h_box = QHBoxLayout()
folder_h_box.addWidget(folder_label)
folder_h_box.addWidget(self.folder_line)
folder_h_box.addWidget(open_button)
self.files_tree = QTreeWidget()
self.files_tree.setHeaderLabel("Media Files")
self.files_tree.setColumnCount(1)
# Set up the dock's layout
dock_v_box = QVBoxLayout()
dock_v_box.addLayout(folder_h_box)
dock_v_box.addWidget(self.files_tree)
dock_container = QWidget()
dock_container.setLayout(dock_v_box)
self.files_dock.setWidget(dock_container)
self.addDockWidget(Qt.DockWidgetArea.LeftDockWidgetArea,
self.files_dock)
class MainWindow(QMainWindow):
def __init__(self):
""" MainWindow Constructor """
super().__init__()
self.initializeUI()
def initializeUI(self):
"""Set up the GUI's main window."""
self.setMinimumSize(700, 400)
self.setWindowTitle("GIF and Image Viewer")
# Set up the main window, menu, and dock widget
self.setUpMainWindow()
self.displayFilesDock()
self.createActions()
self.createMenus()
self.createToolbar()
self.show() # Display the main window
def setUpMainWindow(self):
"""Set up the application's main window and widgets."""
self.movie = QMovie() # Create movie object
self.movie.stateChanged.connect(self.changeButtonStates)
self.media_label = QLabel() # Create label to place images/GIFs on
self.media_label.setPixmap(QPixmap("icons/image_label.png"))
self.media_label.setFrameShape(QFrame.Shape.StyledPanel)
self.media_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
# Prevent the label from resizing and affecting the
# dock widget when viewing images
self.media_label.setSizePolicy(QSizePolicy.Policy.Ignored, QSizePolicy.Policy.Expanding)
self.setCentralWidget(self.media_label)
def createActions(self):
"""Create the application's menu actions."""
# Create actions for File menu
self.open_act = QAction("Open...", self, triggered=self.openDirectory)
self.open_act.setShortcut(QKeySequence.StandardKey.Open)
self.quit_act = QAction("Quit Viewer", self, triggered=self.close)
self.quit_act.setShortcut(QKeySequence.StandardKey.Quit) # Ctrl+Q
# Create actions for View menu
# Handle the visibility of the dock widget
self.show_dock_act = self.files_dock.toggleViewAction()
self.show_dock_act.setText("Show Media Folder")
# Create actions for the toolbar (These actions could also be
# added to the GUI's menu bar or to a context menu)
self.play_act = QAction(QIcon("icons/play.png"), "Play", self, triggered=self.startMovie)
self.pause_act = QAction(QIcon("icons/pause.png"), "Pause", self, triggered=self.pauseMovie)
self.stop_act = QAction(QIcon("icons/stop.png"), "Stop/Reset", self, triggered=self.stopMovie)
self.disableMovieButtons()
def createMenus(self):
"""Create the application's menu."""
# Make the toolbar appear in the main window for macOS users.
# More information about this in Chapter 2 - Building the Foundation for GUIs
if QSysInfo.productType() == "macos" or "osx":
self.menuBar().setNativeMenuBar(False)
self.file_menu = self.menuBar().addMenu("&File")
self.file_menu.addAction(self.open_act)
self.file_menu.addSeparator()
self.file_menu.addAction(self.quit_act)
self.view_menu = self.menuBar().addMenu("&View")
self.view_menu.addAction(self.show_dock_act)
def createToolbar(self):
"""Create the application's toolbar for playing GIFs."""
toolbar = self.addToolBar("GIF Controls Toolbar")
toolbar.setIconSize(QSize(24, 24))
# Add actions to the toolbar
toolbar.addAction(self.play_act)
toolbar.addAction(self.pause_act)
toolbar.addAction(self.stop_act)
def displayFilesDock(self):
"""Dock widget that displays the movie file location in a QLineEdit
widget, provides a button for opening directories with images and GIFs,
and shows the media from the selected folder in a QTreeWidget."""
self.files_dock = QDockWidget()
self.files_dock.setWindowTitle("Media Folder")
self.files_dock.setAllowedAreas(Qt.DockWidgetArea.LeftDockWidgetArea)
folder_label = QLabel("Media Location:")
# The QLineEdit widget is set to read-only as a quick way to display
# the folder path
self.folder_line = QLineEdit()
self.folder_line.setMinimumWidth(100)
self.folder_line.setReadOnly(True)
open_button = QPushButton("Open...")
open_button.clicked.connect(self.openDirectory)
folder_h_box = QHBoxLayout()
folder_h_box.addWidget(folder_label)
folder_h_box.addWidget(self.folder_line)
folder_h_box.addWidget(open_button)
self.files_tree = QTreeWidget()
self.files_tree.setHeaderLabel("Media Files")
self.files_tree.setColumnCount(1)
self.files_tree.itemSelectionChanged.connect(self.displayMediaFile)
# Set up the dock's layout
dock_v_box = QVBoxLayout()
dock_v_box.addLayout(folder_h_box)
dock_v_box.addWidget(self.files_tree)
dock_container = QWidget()
dock_container.setLayout(dock_v_box)
self.files_dock.setWidget(dock_container)
self.addDockWidget(Qt.DockWidgetArea.LeftDockWidgetArea, self.files_dock)
def openDirectory(self):
"""Open a QFileDialog for selecting a local directory. Only display
image and GIF files."""
directory = QFileDialog.getExistingDirectory(self, "Choose Directory", "",
QFileDialog.Option.ShowDirsOnly) # Specify the file mode to only select directories
if directory:
# Display the selected folder text in the QLineEdit. There are other, and
# possibly better, ways to handle displaying the text, but for simplicity,
# this is the method used in this GUI
self.folder_line.setText(directory)
# Get the contents of the directory and only display files with
# specified extensions
file_dir = QDir(directory)
filters = ["*.gif", "*.png", "*.jpg", "*.jpeg"]
files_info = file_dir.entryInfoList(filters, QDir.Filter.Files)
# Clear the contents of the QTreeWidget
if self.files_tree.model().rowCount() > 0:
# NOTE: Since files_tree is connected to the itemSelectionChanged signal,
# using the clear() method below will also cause the signal to be emitted.
# This causes an undesired issue because of how the items are deleted. To avoid
# the signal being called, QObject.blockSignals() will halt files_tree from
# emitting signals while removing items
self.files_tree.blockSignals(True)
# Use the convenience method clear() provided by QTreeWidget to remove
# all items and selections
self.files_tree.clear()
self.files_tree.blockSignals(False)
# Reset the QLabel and its image, and disable the movie buttons (in case the
# last item selected was a GIF)
self.media_label.clear()
self.media_label.setPixmap(QPixmap("icons/image_label.png"))
self.disableMovieButtons()
# Create items for each file and add them to the tree
for file in files_info:
item = QTreeWidgetItem()
item.setText(0, file.fileName())
self.files_tree.addTopLevelItem(item)
def displayMediaFile(self):
"""Display the selected media file on the QLabel. Used instead of
the itemClicked signal to handle whether the user clicks on an item
or if arrow keys are used to navigate the items in the tree."""
# Check the state of the movie, i.e. check if a movie is playing. If it is,
# stop the movie
if self.movie.state() == QMovie.MovieState.Running:
self.stopMovie()
# Get the text from the QLineEdit, folder_line, and concatenate it with
# the selected item's text
column = self.files_tree.currentColumn()
media_location = self.folder_line.text() + "/" + self.files_tree.selectedItems()[0].text(column)
if media_location.split(".")[1] == "gif":
self.movie.setFileName(media_location)
# Check if image data is valid before playing
if self.movie.isValid():
# Use setMovie() to set the label's contents as the selected GIF
self.media_label.setMovie(self.movie)
self.startMovie() # Call method to begin playing
else:
# Disable all buttons when an image is selected
self.disableMovieButtons()
# Set the label's pixmap (have the image fit the current size of the image label)
self.media_label.setPixmap(QPixmap(media_location).scaled(self.media_label.size(),
Qt.AspectRatioMode.KeepAspectRatio, Qt.TransformationMode.SmoothTransformation))
def startMovie(self):
"""Start playing the movie."""
self.movie.start()
def pauseMovie(self):
"""Pause the movie."""
self.movie.setPaused(True)
def stopMovie(self):
"""Stop playing the movie and reset the movie back to
the first frame."""
self.movie.stop()
self.movie.jumpToFrame(0)
def changeButtonStates(self, state):
"""Slot that handles enabling/disabling buttons in the toolbar
based on the state of QMovie."""
if state == QMovie.MovieState.Running:
# The animation begins playing once control returns to the event loop
self.play_act.setEnabled(False)
self.pause_act.setEnabled(True)
self.stop_act.setEnabled(True)
if state == QMovie.MovieState.Paused:
self.play_act.setEnabled(True)
self.pause_act.setEnabled(False)
self.stop_act.setEnabled(False)
if state == QMovie.MovieState.NotRunning:
self.play_act.setEnabled(True)
self.pause_act.setEnabled(False)
self.stop_act.setEnabled(False)
def disableMovieButtons(self):
"""Simple method to disable the movie buttons in the toolbar."""
self.play_act.setEnabled(False)
self.pause_act.setEnabled(False)
self.stop_act.setEnabled(False)