Enhance documentation and type hints across main modules

Author: KedoKudo

src/hyperctui/__init__.py

@@ -1,4 +1,13 @@
+"""
+HyperCTui initialization module.
+
+This module provides constants, helper functions, and configuration settings for the
+HyperCT UI application. It includes path definitions, UI styling properties,
+and class definitions to organize application structure and data.
+"""
+
 import os
+from typing import Any, Dict, Union
 
 from qtpy.uic import loadUi
 
@@ -35,7 +44,7 @@
 SOURCE_DETECTOR_DISTANCE = 19.855  # m, at SNAP
 DETECTOR_OFFSET = 0  # micros
 
-DEFAULT_EVALUATION_REGIONS = {
+DEFAULT_EVALUATION_REGIONS: Dict[int, Dict[str, Union[str, int]]] = {
     0: {
         "name": "Region 1",
         "from": 20,
@@ -56,21 +65,73 @@
 
 # main window dimensions
 class UiSizeSmall:
+    """
+    Small UI window size configuration.
+
+    Attributes
+    ----------
+    width : int
+        Width of the UI window in pixels.
+    height : int
+        Height of the UI window in pixels.
+    """
+
     width = 800
     height = 300
 
 
 class UiSizeLarge:
+    """
+    Large UI window size configuration.
+
+    Attributes
+    ----------
+    width : int
+        Width of the UI window in pixels.
+    height : int
+        Height of the UI window in pixels.
+    """
+
     width = 800
     height = 800
 
 
 class DataType:
+    """
+    Constants defining data types used in the application.
+
+    Attributes
+    ----------
+    projection : str
+        String identifier for projection data.
+    ob : str
+        String identifier for open beam data.
+    """
+
     projection = "projections"
     ob = "ob"
 
 
 class TabNames:
+    """
+    Names for the application tabs.
+
+    Attributes
+    ----------
+    tab0 : str
+        Open beam setup tab label.
+    tab1 : str
+        Initial projections tab label.
+    tab2 : str
+        Crop tab label.
+    tab3 : str
+        Rotation center tab label.
+    tab4 : str
+        Autonomous reconstruction tab label.
+    tab5 : str
+        Settings tab label.
+    """
+
     tab0 = " - Setup the open beams"
     tab1 = " - Initialize first projections (0\u00b0 and 180\u00b0)"
     tab2 = " - Crop"
@@ -80,11 +141,47 @@ class TabNames:
 
 
 class ObTabNames:
+    """
+    Constants for the open beam tab indices.
+
+    Attributes
+    ----------
+    new_obs : int
+        Index for the new open beams tab.
+    selected_obs : int
+        Index for the selected open beams tab.
+    """
+
     new_obs = 0
     selected_obs = 1
 
 
 class EvaluationRegionKeys:
+    """
+    Keys used in evaluation region dictionaries.
+
+    Attributes
+    ----------
+    state : str
+        Key for checkbox state.
+    from_value : str
+        Key for start value.
+    to_value : str
+        Key for end value.
+    id : str
+        Key for horizontal line ID.
+    name : str
+        Key for region name.
+    label_id : str
+        Key for label ID.
+    from_index : str
+        Key for start file index.
+    to_index : str
+        Key for end file index.
+    str_from_to_value : str
+        Key for string representation of range.
+    """
+
     state = "state of the checkbox"
     from_value = "from value"
     to_value = "to value"
@@ -96,5 +193,20 @@ class EvaluationRegionKeys:
     str_from_to_value = "string form of from -> to range"
 
 
-def load_ui(ui_filename, baseinstance):
+def load_ui(ui_filename: str, baseinstance: Any) -> Any:
+    """
+    Load a Qt UI file and apply it to the specified base instance.
+
+    Parameters
+    ----------
+    ui_filename : str
+        Path to the UI file to load.
+    baseinstance : Any
+        Instance to which the UI should be applied.
+
+    Returns
+    -------
+    Any
+        The baseinstance with the UI applied.
+    """
     return loadUi(ui_filename, baseinstance=baseinstance)

src/hyperctui/__main__.py

@@ -1,4 +1,21 @@
 #!/usr/bin/env python3
+"""
+HyperCTui entry point module.
+
+This module serves as the main entry point for the HyperCTui application.
+When the package is executed directly (using `python -m hyperctui`), this
+module initializes the application and launches the GUI interface.
+
+Examples
+--------
+To run the application from the command line:
+    $ python -m hyperctui [arguments]
+
+Notes
+-----
+The module uses multiprocessing freeze support for compatibility with
+packaged executables on Windows platforms.
+"""
 
 import multiprocessing
 import sys
@@ -9,4 +26,4 @@
 
 # Run the GUI
 multiprocessing.freeze_support()
-sys.exit(main(sys.argv))
+sys.exit(main(sys.argv))  # type: List[str]

src/hyperctui/commands_launcher.py

@@ -1,15 +1,71 @@
+#!/usr/bin/env python
+"""
+Module for launching various commands in the HyperCTui application.
+
+This module provides functionality to launch different acquisition and
+reconstruction operations through the CommandLauncher class.
+"""
+
 from hyperctui.utilities.parent import Parent
 
 
 class CommandLauncher(Parent):
-    def launch_ob_first_projections_acquisition(self):
+    """
+    Class for launching various command operations in the HyperCTui application.
+
+    This class provides methods to trigger different acquisition and
+    reconstruction processes within the application.
+
+    Parameters
+    ----------
+    *args : tuple
+        Arguments to pass to the parent class.
+    **kwargs : dict
+        Keyword arguments to pass to the parent class.
+
+    Attributes
+    ----------
+    Inherits attributes from Parent class.
+    """
+
+    def launch_ob_first_projections_acquisition(self) -> None:
+        """
+        Launch open beam first projections acquisition process.
+
+        This method handles the acquisition of open beam (OB) projections,
+        including determining the number of OBs requested and setting an
+        appropriate title for the operation.
+
+        Parameters
+        ----------
+        None
+
+        Returns
+        -------
+        None
+        """
         # get the number of OBs requested (if any)
 
         # get the title
 
         pass
 
-    def launch_preprocessing_autonomous_reconstruction(self):
+    def launch_preprocessing_autonomous_reconstruction(self) -> None:
+        """
+        Launch preprocessing and autonomous reconstruction process.
+
+        This method sets up and executes the preprocessing and autonomous
+        reconstruction with appropriate parameters including angles,
+        evaluation regions, and TOF (Time of Flight) regions.
+
+        Parameters
+        ----------
+        None
+
+        Returns
+        -------
+        None
+        """
         # list of angles
         # evaluation regions
         # TOF regions