(spectrum-viewer): add detailed logging for ROI actions and fitting

Author: ashleymeigh2

mantidimaging/gui/widgets/spectrum_widgets/export_data_table_widget.py

@@ -1,11 +1,14 @@
 # Copyright (C) 2021 ISIS Rutherford Appleton Laboratory UKRI
 # SPDX - License - Identifier: GPL-3.0-or-later
 from __future__ import annotations
+from logging import getLogger
 
 from PyQt5.QtWidgets import QWidget, QVBoxLayout, QTableView, QHeaderView, QAbstractItemView
 from PyQt5.QtGui import QStandardItemModel, QStandardItem
 from PyQt5.QtCore import Qt
 
+LOG = getLogger(__name__)
+
 
 class ExportDataTableWidget(QWidget):
     """
@@ -66,6 +69,8 @@ def update_roi_data(self, roi_name: str, params: dict[str, float], status: str =
         else:
             self.model.appendRow(items)
 
+        LOG.info("Export table updated: ROI=%s, Params=%s, Status=%s", roi_name, params, status)
+
     def _find_row_by_roi_name(self, roi_name: str) -> int | None:
         """
         Find the row index for a given ROI name. Returns None if not found.
@@ -80,3 +85,4 @@ def clear_table(self) -> None:
         Remove all rows from the table.
         """
         self.model.removeRows(0, self.model.rowCount())
+        LOG.info("Export table cleared")

mantidimaging/gui/widgets/spectrum_widgets/fitting_display_widget.py

@@ -13,6 +13,9 @@
 from mantidimaging.gui.windows.spectrum_viewer.model import allowed_modes
 from mantidimaging.gui.windows.spectrum_viewer.spectrum_widget import SpectrumPlotWidget, SpectrumROI
 from mantidimaging.core.fitting.fitting_functions import FittingRegion
+from logging import getLogger
+
+LOG = getLogger(__name__)
 
 
 class FittingDisplayWidget(QWidget):
@@ -64,6 +67,7 @@ def update_plot(self, x_data: np.ndarray, y_data: np.ndarray, label: str = "ROI"
         self.spectrum_plot.spectrum.plot(x_data, y_data, name=label, pen=(255, 255, 0))
         self.spectrum_plot.spectrum.addItem(self.fitting_region)
         self.set_default_region(x_data, y_data)
+        LOG.debug("Spectrum plot updated: label=%s, points=%d", label, len(x_data))
 
     def update_image(self, image: np.ndarray | None) -> None:
         if image is not None:
@@ -114,6 +118,7 @@ def set_selected_fit_region(self, region: tuple[float, float]) -> None:
         height = self.fitting_region.size().y()
         self.fitting_region.setPos((x_start, y_pos))
         self.fitting_region.setSize((width, height))
+        LOG.info("Fit region set: x_start=%.3f, x_end=%.3f", x_start, x_end)
 
     def get_selected_fit_region(self) -> FittingRegion:
         pos = self.fitting_region.pos()
@@ -154,6 +159,7 @@ def show_fit_line(self, x_data: np.ndarray, y_data: np.ndarray, *, color: tuple[
             self._current_fit_line = None
         self._current_fit_line = self.spectrum_plot.spectrum.plot(x_data, y_data, name=label, pen=color)
         self._showing_initial_fit = initial
+        LOG.debug("Fit line displayed: label=%s, initial=%s, points=%d", label, initial, len(x_data))
 
     def is_initial_fit_visible(self) -> bool:
         return self._showing_initial_fit

mantidimaging/gui/widgets/spectrum_widgets/fitting_param_form_widget.py

@@ -2,13 +2,16 @@
 # SPDX - License - Identifier: GPL-3.0-or-later
 from __future__ import annotations
 from typing import TYPE_CHECKING
+from logging import getLogger
 
 from PyQt5.QtWidgets import QWidget, QVBoxLayout, QHBoxLayout, QLabel, QLineEdit, QSizePolicy, QPushButton
 from PyQt5.QtGui import QDoubleValidator
 
 if TYPE_CHECKING:
     from mantidimaging.gui.windows.spectrum_viewer import SpectrumViewerWindowPresenter
 
+LOG = getLogger(__name__)
+
 
 class FittingParamFormWidget(QWidget):
     """
@@ -68,11 +71,13 @@ def set_parameter_values(self, values: dict[str, float]) -> None:
         for name, value in values.items():
             row = self._rows[name]
             row[2].setText(f"{value:f}")
+            LOG.debug("Final fit parameter values updated: %s", values)
 
     def set_fitted_parameter_values(self, values: dict[str, float]) -> None:
         for name, value in values.items():
             row = self._rows[name]
             row[3].setText(f"{value:f}")
+            LOG.debug("Final fit parameter values updated: %s", values)
 
     def get_initial_param_values(self) -> list[float]:
         params = [float(row[2].text()) for row in self._rows.values()]
@@ -91,3 +96,4 @@ def clear_rows(self) -> None:
                 widget.setParent(None)
             self.params_layout.layout().removeItem(row_layout)
         self._rows.clear()
+        LOG.debug("Parameter form rows cleared")

mantidimaging/gui/widgets/spectrum_widgets/fitting_selection_widget.py

@@ -7,12 +7,14 @@
 from PyQt5 import QtWidgets, QtCore
 
 from mantidimaging.core.fitting.fitting_functions import BaseFittingFunction
+from logging import getLogger
+
+LOG = getLogger(__name__)
 
 
 class FitSelectionWidget(QtWidgets.QGroupBox):
     """
     A custom Qt widget for selecting an Fitting Model.
-
     Attributes:
         fitDropdown: A dropdown menu for selecting fits.
         func_dict: A dictionary for storing fitting functions available in the viewer.
@@ -45,6 +47,7 @@ def _on_selection_changed(self) -> None:
         """ Handle dropdown selection change and emit signal. """
         selected_fit = self.fitDropdown.currentText()
         self.selectionChanged.emit(self.func_dict[selected_fit])
+        LOG.info("Fit function selected: %s", self.fitDropdown.currentText())
 
     def set_available_fitting_functions(self) -> None:
         """ Update the dropdown and trigger selection change if needed. """

mantidimaging/gui/widgets/spectrum_widgets/roi_form_widget.py

@@ -7,6 +7,7 @@
 from PyQt5.QtCore import pyqtSignal, QSignalBlocker, QModelIndex
 from PyQt5.QtGui import QPixmap
 from PyQt5.QtWidgets import QAbstractItemView, QHeaderView, QLabel
+from logging import getLogger
 
 from mantidimaging.core.utility import finder
 from mantidimaging.core.utility.sensible_roi import SensibleROI
@@ -17,6 +18,8 @@
 if TYPE_CHECKING:
     from PyQt5.QtWidgets import QTabWidget, QComboBox, QPushButton, QSpinBox, QGroupBox
 
+LOG = getLogger(__name__)
+
 
 class ROIFormWidget(BaseWidget):
     """
@@ -81,12 +84,15 @@ def _check_rits_step_validity(self) -> None:
         bin_size = self.bin_size_spinBox.value()
         roi_width = roi.right - roi.left
         roi_height = roi.bottom - roi.top
+        norm_mode = self.transmission_error_mode_combobox.currentText()
 
         if ((roi_width - bin_size) % step != 0 or (roi_height - bin_size) % step != 0):
             warning = (f"Step size {step} and bin size {bin_size} do not evenly divide ROI dimensions "
                        f"({roi_width}x{roi_height}). Some rows or columns may not be exported.")
             self.show_rits_warning(warning)
         else:
+            LOG.info("RITS config valid — bin=%d, step=%d, norm_error=%s, roi_size=%dx%d", bin_size, step, norm_mode,
+                     roi_width, roi_height)
             self.show_rits_warning(None)
 
 
@@ -123,6 +129,7 @@ def set_roi_values(self, roi: SensibleROI) -> None:
             self.spin_bottom.setValue(roi.bottom)
             self.label_width.setText(str(roi.width))
             self.label_height.setText(str(roi.height))
+            LOG.debug("ROI bounds set: left=%d, right=%d, top=%d, bottom=%d", roi.left, roi.right, roi.top, roi.bottom)
 
     def set_roi_limits(self, shape: tuple[int, ...]) -> None:
         self.spin_left.setMaximum(shape[1])
@@ -234,19 +241,22 @@ def add_row(self, name: str, colour: tuple[int, int, int, int], roi_names: list[
         self.roi_table_model.appendNewRow(name, colour, True)
         self.selected_row = self.roi_table_model.rowCount() - 1
         self.selectRow(self.selected_row)
+        LOG.debug("ROI added to table: name=%s, color=%s", name, colour[:3])
 
     def remove_row(self, row: int) -> None:
         """
         Remove a row from the ROI table
         """
         self.roi_table_model.remove_row(row)
         self.selectRow(0)
+        LOG.debug("ROI row removed: row=%d", row)
 
     def clear_table(self) -> None:
         """
         Clears the ROI table in the spectrum viewer.
         """
         self.roi_table_model.clear_table()
+        LOG.debug("ROI table cleared")
 
     def select_roi(self, roi_name: str) -> None:
         selected_row = self.find_row_for_roi(roi_name)

mantidimaging/gui/widgets/spectrum_widgets/roi_selection_widget.py

@@ -3,12 +3,14 @@
 
 from mantidimaging.gui.windows.spectrum_viewer.model import ROI_RITS
 from PyQt5 import QtWidgets, QtCore
+from logging import getLogger
+
+LOG = getLogger(__name__)
 
 
 class ROISelectionWidget(QtWidgets.QGroupBox):
     """
     A custom Qt widget for selecting an ROI.
-
     Attributes:
         roiDropdown: A dropdown menu for selecting ROIs.
         selectionChanged: Signal emitted when the ROI selection changes.
@@ -34,6 +36,7 @@ def _on_selection_changed(self) -> None:
         selected_roi = self.roiDropdown.currentText()
         if selected_roi != self.previous_selection:
             self.previous_selection = selected_roi
+            LOG.info("ROI selected: %s", selected_roi)
             self.selectionChanged.emit(selected_roi)
 
     def update_roi_list(self, roi_names: list[str]) -> None:
@@ -50,6 +53,7 @@ def update_roi_list(self, roi_names: list[str]) -> None:
             self._on_selection_changed()
             self._on_selection_changed()
         self.roiDropdown.blockSignals(False)
+        LOG.debug("ROI dropdown updated: %s", filtered_rois)
 
     def set_selected_roi(self, roi_name: str) -> None:
         """ Set the dropdown selection to the given ROI name. """

mantidimaging/gui/widgets/spectrum_widgets/tof_properties.py

@@ -2,6 +2,9 @@
 # SPDX - License - Identifier: GPL-3.0-or-later
 
 from PyQt5 import QtCore, QtWidgets
+from logging import getLogger
+
+LOG = getLogger(__name__)
 
 
 class ExperimentSetupFormWidget(QtWidgets.QGroupBox):
@@ -75,6 +78,7 @@ def flight_path(self) -> float:
     @flight_path.setter
     def flight_path(self, value: float) -> None:
         self.flightPathSpinBox.setValue(value)
+        LOG.debug("Flight path set to: %.3f m", value)
 
     @property
     def time_delay(self) -> float:
@@ -83,6 +87,7 @@ def time_delay(self) -> float:
     @time_delay.setter
     def time_delay(self, value: float):
         self.timeDelaySpinBox.setValue(value)
+        LOG.debug("Time delay set to: %.3f µs", value)
 
     def connect_value_changed(self, handler: QtCore.pyqtSlot):
         self.flightPathSpinBox.valueChanged.connect(handler)

mantidimaging/gui/windows/spectrum_viewer/model.py

@@ -127,9 +127,15 @@ def set_stack(self, stack: ImageStack | None) -> None:
             return
         self.tof_range = (0, stack.data.shape[0] - 1)
         self.tof_data = self.get_stack_time_of_flight()
+        LOG.info("Sample stack set: shape=%s, ToF range=(%d–%d)", stack.data.shape, self.tof_range[0],
+                 self.tof_range[1])
 
     def set_normalise_stack(self, normalise_stack: ImageStack | None) -> None:
         self._normalise_stack = normalise_stack
+        if normalise_stack is not None:
+            LOG.info("Normalisation stack set: shape=%s", normalise_stack.data.shape)
+        else:
+            LOG.info("Normalisation stack cleared")
 
     def get_normalized_averaged_image(self) -> np.ndarray | None:
         """
@@ -164,7 +170,6 @@ def get_stack_spectrum(stack: ImageStack | None,
         """
         Computes the mean spectrum of the given image stack within the specified region of interest (ROI).
         If the image stack is None, an empty numpy array is returned.
-
         Parameters:
             stack (Optional[ImageStack]): The image stack to compute the spectrum from.
                 It can be None, in which case an empty array is returned.
@@ -250,6 +255,9 @@ def get_spectrum(self,
             average_shuttercount = self.get_shuttercount_normalised_correction_parameter()
             spectrum = spectrum / average_shuttercount
 
+        LOG.debug("Computing spectrum: ROI=%s, mode=%s, cached=%s", roi, mode.name,
+                  (*roi, mode, normalise_with_shuttercount) in self.spectrum_cache)
+
         return spectrum
 
     def store_spectrum(self, roi: SensibleROI, mode: SpecType, normalise_with_shuttercount: bool, spectrum: np.ndarray):
@@ -382,6 +390,9 @@ def save_csv(self,
             csv_output.write(outfile)
             self.save_roi_coords(self.get_roi_coords_filename(path), rois)
 
+        LOG.info("Saving spectra to CSV: path=%s, ROIs=%s, normalised=%s, shuttercount=%s", path, list(rois.keys()),
+                 normalise, normalise_with_shuttercount)
+
     def save_single_rits_spectrum(self, path: Path, error_mode: ErrorMode, roi: SensibleROI) -> None:
         """
         Saves the spectrum for the RITS ROI to a RITS file.
@@ -419,6 +430,9 @@ def save_rits_roi(self, path: Path, error_mode: ErrorMode, roi: SensibleROI, nor
 
         self.export_spectrum_to_rits(path, tof, transmission, transmission_error)
 
+        LOG.info("Exporting RITS file: path=%s, ROI=(%d,%d,%d,%d), error_mode=%s", path, roi.left, roi.top, roi.right,
+                 roi.bottom, error_mode.name)
+
     def validate_bin_and_step_size(self, roi: SensibleROI, bin_size: int, step_size: int) -> None:
         """
         Validates the bin size and step size for saving RITS images.
@@ -427,7 +441,6 @@ def validate_bin_and_step_size(self, roi: SensibleROI, bin_size: int, step_size:
         - Bin size must be larger than or equal to step size.
         - Both bin size and step size must be less than or equal to the smallest dimension of the ROI.
         If any of these conditions are not met, a ValueError is raised.
-
         Parameters:
             roi: The region of interest (ROI) to which the bin size and step size should be compared.
             bin_size (int): The size of the bins to be validated.