Commit 9ef39a05 authored by Thomas Dowrick's avatar Thomas Dowrick
Browse files

Issue #8: Update docstrings [Closes #8]

parent f4a3c31f
Pipeline #1836 failed with stages
in 67 minutes and 39 seconds
......@@ -139,7 +139,7 @@ class UI(QWidget):
"""Set the opacity for all VTK models
:param opacity_percent: Target opacity value, in %
:type opacity_percent: integer
:type opacity_percent: int
"""
opacity = opacity_percent / 100
......
......@@ -44,10 +44,11 @@ class DuplicateOverlayWindow(OverlayOnVideoFeed):
class MonoViewer(QtWidgets.QWidget):
"""Generates a VTK interactor UI with a video stream as background"""
"""
Generates a VTK interactor UI with a video stream as background
:param video_source: OpenCV compatible video source (int or filename)
"""
def __init__(self, video_source):
super().__init__()
LOGGER.info("Creating Mono Viewer")
......@@ -56,7 +57,11 @@ class MonoViewer(QtWidgets.QWidget):
self.UI = UI(self.overlay_window)
def add_vtk_models(self, models):
"""Add vtk model overlays to the window"""
"""
Add vtk model overlays to the window
:param models: list of vtk models to add
:type models: list of VTKSurfaceModels
"""
self.UI.add_vtk_models(models)
def start(self):
......@@ -98,6 +103,7 @@ class StereoViewerBase(QtWidgets.QWidget):
external monitors are available.
:param output_screens: List of screens on which to put widgets
:type output_screens: List of ints
"""
screen_controller = ScreenController()
self.primary, self.screens = screen_controller.list_of_screens()
......@@ -136,6 +142,9 @@ class StereoViewerBase(QtWidgets.QWidget):
def are_widgets_on_different_screens(self, screens):
"""
Check if each widget has been placed on it's own screen.
:param screens: List of screen numbers corresponding to the screen
each widget is displayed on.
:type screens: list of ints
"""
unique_screens = set(screens)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment