diff --git a/docs/source/_autosummary/parallax.axis_filter.rst b/docs/source/_autosummary/parallax.axis_filter.rst new file mode 100644 index 0000000..0d05944 --- /dev/null +++ b/docs/source/_autosummary/parallax.axis_filter.rst @@ -0,0 +1,29 @@ +parallax.axis\_filter +===================== + +.. automodule:: parallax.axis_filter + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + AxisFilter + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.bundle_adjustment.rst b/docs/source/_autosummary/parallax.bundle_adjustment.rst new file mode 100644 index 0000000..a80d856 --- /dev/null +++ b/docs/source/_autosummary/parallax.bundle_adjustment.rst @@ -0,0 +1,30 @@ +parallax.bundle\_adjustment +=========================== + +.. automodule:: parallax.bundle_adjustment + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + BALOptimizer + BALProblem + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.calculator.rst b/docs/source/_autosummary/parallax.calculator.rst new file mode 100644 index 0000000..a6b7164 --- /dev/null +++ b/docs/source/_autosummary/parallax.calculator.rst @@ -0,0 +1,29 @@ +parallax.calculator +=================== + +.. automodule:: parallax.calculator + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Calculator + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.calibration_camera.rst b/docs/source/_autosummary/parallax.calibration_camera.rst new file mode 100644 index 0000000..8f251e1 --- /dev/null +++ b/docs/source/_autosummary/parallax.calibration_camera.rst @@ -0,0 +1,30 @@ +parallax.calibration\_camera +============================ + +.. automodule:: parallax.calibration_camera + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + CalibrationCamera + CalibrationStereo + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.camera.rst b/docs/source/_autosummary/parallax.camera.rst new file mode 100644 index 0000000..ebc1909 --- /dev/null +++ b/docs/source/_autosummary/parallax.camera.rst @@ -0,0 +1,38 @@ +parallax.camera +=============== + +.. automodule:: parallax.camera + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + close_cameras + list_cameras + + + + + + .. rubric:: Classes + + .. autosummary:: + + MockCamera + PySpinCamera + VideoSource + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.coords_transformation.rst b/docs/source/_autosummary/parallax.coords_transformation.rst new file mode 100644 index 0000000..522bd98 --- /dev/null +++ b/docs/source/_autosummary/parallax.coords_transformation.rst @@ -0,0 +1,29 @@ +parallax.coords\_transformation +=============================== + +.. automodule:: parallax.coords_transformation + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + RotationTransformation + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.curr_bg_cmp_processor.rst b/docs/source/_autosummary/parallax.curr_bg_cmp_processor.rst new file mode 100644 index 0000000..e77a258 --- /dev/null +++ b/docs/source/_autosummary/parallax.curr_bg_cmp_processor.rst @@ -0,0 +1,29 @@ +parallax.curr\_bg\_cmp\_processor +================================= + +.. automodule:: parallax.curr_bg_cmp_processor + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + CurrBgCmpProcessor + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.curr_prev_cmp_processor.rst b/docs/source/_autosummary/parallax.curr_prev_cmp_processor.rst new file mode 100644 index 0000000..dd914d4 --- /dev/null +++ b/docs/source/_autosummary/parallax.curr_prev_cmp_processor.rst @@ -0,0 +1,29 @@ +parallax.curr\_prev\_cmp\_processor +=================================== + +.. automodule:: parallax.curr_prev_cmp_processor + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + CurrPrevCmpProcessor + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.main_window_wip.rst b/docs/source/_autosummary/parallax.main_window_wip.rst new file mode 100644 index 0000000..899c998 --- /dev/null +++ b/docs/source/_autosummary/parallax.main_window_wip.rst @@ -0,0 +1,29 @@ +parallax.main\_window\_wip +========================== + +.. automodule:: parallax.main_window_wip + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + MainWindow + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.mask_generator.rst b/docs/source/_autosummary/parallax.mask_generator.rst new file mode 100644 index 0000000..5144ac9 --- /dev/null +++ b/docs/source/_autosummary/parallax.mask_generator.rst @@ -0,0 +1,29 @@ +parallax.mask\_generator +======================== + +.. automodule:: parallax.mask_generator + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + MaskGenerator + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.model.rst b/docs/source/_autosummary/parallax.model.rst new file mode 100644 index 0000000..3f5354a --- /dev/null +++ b/docs/source/_autosummary/parallax.model.rst @@ -0,0 +1,29 @@ +parallax.model +============== + +.. automodule:: parallax.model + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Model + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.no_filter.rst b/docs/source/_autosummary/parallax.no_filter.rst new file mode 100644 index 0000000..c40c26e --- /dev/null +++ b/docs/source/_autosummary/parallax.no_filter.rst @@ -0,0 +1,29 @@ +parallax.no\_filter +=================== + +.. automodule:: parallax.no_filter + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + NoFilter + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.point_mesh.rst b/docs/source/_autosummary/parallax.point_mesh.rst new file mode 100644 index 0000000..45a8455 --- /dev/null +++ b/docs/source/_autosummary/parallax.point_mesh.rst @@ -0,0 +1,29 @@ +parallax.point\_mesh +==================== + +.. automodule:: parallax.point_mesh + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + PointMesh + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.probe_calibration.rst b/docs/source/_autosummary/parallax.probe_calibration.rst new file mode 100644 index 0000000..6b0844f --- /dev/null +++ b/docs/source/_autosummary/parallax.probe_calibration.rst @@ -0,0 +1,29 @@ +parallax.probe\_calibration +=========================== + +.. automodule:: parallax.probe_calibration + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ProbeCalibration + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.probe_detect_manager.rst b/docs/source/_autosummary/parallax.probe_detect_manager.rst new file mode 100644 index 0000000..fe6aa7d --- /dev/null +++ b/docs/source/_autosummary/parallax.probe_detect_manager.rst @@ -0,0 +1,29 @@ +parallax.probe\_detect\_manager +=============================== + +.. automodule:: parallax.probe_detect_manager + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ProbeDetectManager + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.probe_detector.rst b/docs/source/_autosummary/parallax.probe_detector.rst new file mode 100644 index 0000000..7788058 --- /dev/null +++ b/docs/source/_autosummary/parallax.probe_detector.rst @@ -0,0 +1,29 @@ +parallax.probe\_detector +======================== + +.. automodule:: parallax.probe_detector + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ProbeDetector + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.probe_fine_tip_detector.rst b/docs/source/_autosummary/parallax.probe_fine_tip_detector.rst new file mode 100644 index 0000000..b012923 --- /dev/null +++ b/docs/source/_autosummary/parallax.probe_fine_tip_detector.rst @@ -0,0 +1,29 @@ +parallax.probe\_fine\_tip\_detector +=================================== + +.. automodule:: parallax.probe_fine_tip_detector + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ProbeFineTipDetector + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.recording_manager.rst b/docs/source/_autosummary/parallax.recording_manager.rst new file mode 100644 index 0000000..f69155f --- /dev/null +++ b/docs/source/_autosummary/parallax.recording_manager.rst @@ -0,0 +1,29 @@ +parallax.recording\_manager +=========================== + +.. automodule:: parallax.recording_manager + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + RecordingManager + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.reticle_detect_manager.rst b/docs/source/_autosummary/parallax.reticle_detect_manager.rst new file mode 100644 index 0000000..fc5812a --- /dev/null +++ b/docs/source/_autosummary/parallax.reticle_detect_manager.rst @@ -0,0 +1,29 @@ +parallax.reticle\_detect\_manager +================================= + +.. automodule:: parallax.reticle_detect_manager + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ReticleDetectManager + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.reticle_detection.rst b/docs/source/_autosummary/parallax.reticle_detection.rst new file mode 100644 index 0000000..291abbc --- /dev/null +++ b/docs/source/_autosummary/parallax.reticle_detection.rst @@ -0,0 +1,29 @@ +parallax.reticle\_detection +=========================== + +.. automodule:: parallax.reticle_detection + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ReticleDetection + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.reticle_detection_coords_interests.rst b/docs/source/_autosummary/parallax.reticle_detection_coords_interests.rst new file mode 100644 index 0000000..c5becb4 --- /dev/null +++ b/docs/source/_autosummary/parallax.reticle_detection_coords_interests.rst @@ -0,0 +1,29 @@ +parallax.reticle\_detection\_coords\_interests +============================================== + +.. automodule:: parallax.reticle_detection_coords_interests + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ReticleDetectCoordsInterest + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.reticle_metadata.rst b/docs/source/_autosummary/parallax.reticle_metadata.rst new file mode 100644 index 0000000..728ac86 --- /dev/null +++ b/docs/source/_autosummary/parallax.reticle_metadata.rst @@ -0,0 +1,29 @@ +parallax.reticle\_metadata +========================== + +.. automodule:: parallax.reticle_metadata + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ReticleMetadata + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.rst b/docs/source/_autosummary/parallax.rst new file mode 100644 index 0000000..5abe361 --- /dev/null +++ b/docs/source/_autosummary/parallax.rst @@ -0,0 +1,60 @@ +parallax +======== + +.. automodule:: parallax + + + + + + + + + + + + + + + + + + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + parallax.axis_filter + parallax.bundle_adjustment + parallax.calculator + parallax.calibration_camera + parallax.camera + parallax.coords_transformation + parallax.curr_bg_cmp_processor + parallax.curr_prev_cmp_processor + parallax.main_window_wip + parallax.mask_generator + parallax.model + parallax.no_filter + parallax.point_mesh + parallax.probe_calibration + parallax.probe_detect_manager + parallax.probe_detector + parallax.probe_fine_tip_detector + parallax.recording_manager + parallax.reticle_detect_manager + parallax.reticle_detection + parallax.reticle_detection_coords_interests + parallax.reticle_metadata + parallax.screen_coords_mapper + parallax.screen_widget + parallax.stage_controller + parallax.stage_listener + parallax.stage_ui + parallax.stage_widget + parallax.user_setting_manager + parallax.utils + diff --git a/docs/source/_autosummary/parallax.screen_coords_mapper.rst b/docs/source/_autosummary/parallax.screen_coords_mapper.rst new file mode 100644 index 0000000..de947da --- /dev/null +++ b/docs/source/_autosummary/parallax.screen_coords_mapper.rst @@ -0,0 +1,29 @@ +parallax.screen\_coords\_mapper +=============================== + +.. automodule:: parallax.screen_coords_mapper + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ScreenCoordsMapper + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.screen_widget.rst b/docs/source/_autosummary/parallax.screen_widget.rst new file mode 100644 index 0000000..b9c10d3 --- /dev/null +++ b/docs/source/_autosummary/parallax.screen_widget.rst @@ -0,0 +1,30 @@ +parallax.screen\_widget +======================= + +.. automodule:: parallax.screen_widget + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ClickableImage + ScreenWidget + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.stage_controller.rst b/docs/source/_autosummary/parallax.stage_controller.rst new file mode 100644 index 0000000..b17ca61 --- /dev/null +++ b/docs/source/_autosummary/parallax.stage_controller.rst @@ -0,0 +1,29 @@ +parallax.stage\_controller +========================== + +.. automodule:: parallax.stage_controller + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + StageController + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.stage_listener.rst b/docs/source/_autosummary/parallax.stage_listener.rst new file mode 100644 index 0000000..88227c7 --- /dev/null +++ b/docs/source/_autosummary/parallax.stage_listener.rst @@ -0,0 +1,32 @@ +parallax.stage\_listener +======================== + +.. automodule:: parallax.stage_listener + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Stage + StageInfo + StageListener + Worker + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.stage_ui.rst b/docs/source/_autosummary/parallax.stage_ui.rst new file mode 100644 index 0000000..477411e --- /dev/null +++ b/docs/source/_autosummary/parallax.stage_ui.rst @@ -0,0 +1,29 @@ +parallax.stage\_ui +================== + +.. automodule:: parallax.stage_ui + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + StageUI + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.stage_widget.rst b/docs/source/_autosummary/parallax.stage_widget.rst new file mode 100644 index 0000000..10a3d60 --- /dev/null +++ b/docs/source/_autosummary/parallax.stage_widget.rst @@ -0,0 +1,29 @@ +parallax.stage\_widget +====================== + +.. automodule:: parallax.stage_widget + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + StageWidget + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.user_setting_manager.rst b/docs/source/_autosummary/parallax.user_setting_manager.rst new file mode 100644 index 0000000..61c4bd9 --- /dev/null +++ b/docs/source/_autosummary/parallax.user_setting_manager.rst @@ -0,0 +1,29 @@ +parallax.user\_setting\_manager +=============================== + +.. automodule:: parallax.user_setting_manager + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + UserSettingsManager + + + + + + + + + diff --git a/docs/source/_autosummary/parallax.utils.rst b/docs/source/_autosummary/parallax.utils.rst new file mode 100644 index 0000000..8028c2d --- /dev/null +++ b/docs/source/_autosummary/parallax.utils.rst @@ -0,0 +1,30 @@ +parallax.utils +============== + +.. automodule:: parallax.utils + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + UtilsCoords + UtilsCrops + + + + + + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py index 9bac885..9d17941 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,11 +20,13 @@ copyright = f"{current_year}, {INSTITUTE_NAME}" author = INSTITUTE_NAME release = "0.0.1" # Automatically set version from parallax package +autosummary_generate = True # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ + 'sphinx.ext.autosummary', "sphinx.ext.viewcode", "sphinx.ext.autodoc", "sphinx.ext.todo", @@ -34,7 +36,6 @@ templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 39911c0..820ae2b 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -1,5 +1,17 @@ -Modules -======================== +Parallax Modules +================ + +Summary +------- + +.. autosummary:: + :toctree: _autosummary + :recursive: + + parallax + +Detailed Modules +---------------- .. toctree:: :maxdepth: 2 diff --git a/docs/source/parallax.rst b/docs/source/parallax.rst index 05fcbcf..844dc73 100644 --- a/docs/source/parallax.rst +++ b/docs/source/parallax.rst @@ -1,30 +1,8 @@ -Parallax Modules +Module Description ================ -Axis Filter Module ------------------- - -This module handles the filtering of axis data. - -.. automodule:: parallax.axis_filter - :members: - :undoc-members: - :special-members: __init__, filter_data - - -Bundle Adjustment Module ------------------------- - -This module performs bundle adjustment to refine the 3D structure. - -.. automodule:: parallax.bundle_adjustment - :members: - :undoc-members: - :special-members: __init__, adjust - - -Calculator Module ------------------ +Calculator +---------- This module contains a calculator for various mathematical functions needed in the system. @@ -34,8 +12,8 @@ This module contains a calculator for various mathematical functions needed in t :special-members: __init__, calculate -Calibration Camera Module -------------------------- +Calibration Camera +------------------ This module provides camera calibration functionality. @@ -45,8 +23,8 @@ This module provides camera calibration functionality. :special-members: __init__, calibrate -Camera Module -------------- +Camera +------ This module manages camera interactions, such as capturing frames and adjusting settings. @@ -56,8 +34,8 @@ This module manages camera interactions, such as capturing frames and adjusting :special-members: __init__, capture_frame, adjust_exposure -Coordinate Transformation Module --------------------------------- +Coordinate Transformation +------------------------- This module handles transformations between different coordinate systems. @@ -67,8 +45,8 @@ This module handles transformations between different coordinate systems. :special-members: __init__, transform_to_global, transform_to_local -Current Background Comparison Processor Module ----------------------------------------------- +Current Background Comparison Processor +--------------------------------------- This module compares the current background frame with previous frames to detect changes. @@ -78,8 +56,8 @@ This module compares the current background frame with previous frames to detect :special-members: __init__, compare_frames -Current Previous Comparison Processor Module --------------------------------------------- +Current Previous Comparison Processor +------------------------------------- This module compares current frames with previous ones to track changes over time. @@ -89,8 +67,8 @@ This module compares current frames with previous ones to track changes over tim :special-members: __init__, process_comparison -Main Window WIP Module ----------------------- +Main Window WIP +--------------- This module manages the main window user interface components. @@ -100,8 +78,8 @@ This module manages the main window user interface components. :special-members: __init__, show_window -Mask Generator Module ---------------------- +Mask Generator +-------------- This module generates masks for image processing tasks. @@ -111,8 +89,8 @@ This module generates masks for image processing tasks. :special-members: __init__, generate_mask -Model Module ------------- +Model +----- This module defines the core model for the application. @@ -122,8 +100,8 @@ This module defines the core model for the application. :special-members: __init__, update_state -No Filter Module ----------------- +No Filter +--------- This module defines a pass-through filter with no changes. @@ -133,8 +111,30 @@ This module defines a pass-through filter with no changes. :special-members: __init__, apply_filter -Probe Calibration Module ------------------------- +Axis Filter +----------- + +This module handles the filtering of axis data. + +.. automodule:: parallax.axis_filter + :members: + :undoc-members: + :special-members: __init__, filter_data + + +Bundle Adjustment +----------------- + +This module performs bundle adjustment to refine the 3D structure. + +.. automodule:: parallax.bundle_adjustment + :members: + :undoc-members: + :special-members: __init__, adjust + + +Probe Calibration +----------------- This module manages the calibration of the probe. @@ -144,8 +144,8 @@ This module manages the calibration of the probe. :special-members: __init__, calibrate_probe -Probe Detect Manager Module ---------------------------- +Probe Detect Manager +-------------------- This module manages the detection of probes in images. @@ -155,8 +155,8 @@ This module manages the detection of probes in images. :special-members: __init__, detect_probe -Probe Detector Module ---------------------- +Probe Detector +-------------- This module contains methods for detecting probes in the environment. @@ -166,8 +166,8 @@ This module contains methods for detecting probes in the environment. :special-members: __init__, detect_tip -Probe Fine Tip Detector Module ------------------------------- +Probe Fine Tip Detector +----------------------- This module detects fine tips of probes. @@ -177,8 +177,8 @@ This module detects fine tips of probes. :special-members: __init__, detect_fine_tip -Recording Manager Module ------------------------- +Recording Manager +----------------- This module manages the recording of data during the session. @@ -188,8 +188,8 @@ This module manages the recording of data during the session. :special-members: __init__, record_data -Reticle Detect Manager Module ------------------------------ +Reticle Detect Manager +---------------------- This module handles the detection and tracking of reticles. @@ -199,8 +199,8 @@ This module handles the detection and tracking of reticles. :special-members: __init__, detect_reticle -Reticle Detection Module ------------------------- +Reticle Detection +----------------- This module provides the core methods for detecting reticles. @@ -210,8 +210,8 @@ This module provides the core methods for detecting reticles. :special-members: __init__, detect_shape -Reticle Detection Coordinates Interests Module ----------------------------------------------- +Reticle Detection Coordinates Interests +--------------------------------------- This module deals with detecting specific points of interest in reticle coordinates. @@ -221,8 +221,8 @@ This module deals with detecting specific points of interest in reticle coordina :special-members: __init__, find_interests -Screen Widget Module --------------------- +Screen Widget +------------- This module provides screen interaction components. @@ -232,8 +232,8 @@ This module provides screen interaction components. :special-members: __init__, update_screen -Stage Listener Module ---------------------- +Stage Listener +-------------- This module listens for changes in the stage and processes events. @@ -243,8 +243,8 @@ This module listens for changes in the stage and processes events. :special-members: __init__, listen -Stage UI Module ---------------- +Stage UI +-------- This module provides UI components for controlling the stage. @@ -254,8 +254,8 @@ This module provides UI components for controlling the stage. :special-members: __init__, update_ui -Stage Widget Module -------------------- +Stage Widget +------------ This module contains the UI components for the stage. @@ -265,8 +265,8 @@ This module contains the UI components for the stage. :special-members: __init__, update_widget -Utils Module ------------- +Utils +----- This module contains utility functions used across the project. diff --git a/parallax/__init__.py b/parallax/__init__.py index 8fd0679..5429efb 100644 --- a/parallax/__init__.py +++ b/parallax/__init__.py @@ -4,7 +4,7 @@ import os -__version__ = "0.38.14" +__version__ = "0.38.15" # allow multiple OpenMP instances os.environ["KMP_DUPLICATE_LIB_OK"] = "True"