microscope.gui Namespace Reference

Classes
class	_DataQueue
class	_Imager
class	CameraWidget
class	ControllerWidget
class	DeformableMirrorWidget
class	DeviceSettingsWidget
class	FilterWheelWidget
class	LightSourceWidget
class	MainWindow
class	StageWidget

Functions
QtWidgets.QWidget	_guess_device_widget (device)
int	main (typing.Sequence[str] argv)
int	_setuptools_entry_point ()

Variables
	_logger = logging.getLogger(__name__)
	SERIALIZER

Function Documentation

_guess_device_widget()

QtWidgets.QWidget microscope.gui._guess_device_widget ( device )

protected

Definition at line 468 of file gui.py.

def _guess_device_widget(device) -> QtWidgets.QWidget:
    if hasattr(device, "axes"):
        return StageWidget
    elif hasattr(device, "devices"):
        return ControllerWidget
    elif hasattr(device, "n_positions"):
        return FilterWheelWidget
    elif hasattr(device, "power"):
        return LightSourceWidget
    elif hasattr(device, "n_actuators"):
        return DeformableMirrorWidget
    elif hasattr(device, "get_sensor_shape"):
        return CameraWidget
    elif hasattr(device, "get_all_settings"):
        return DeviceSettingsWidget
    else:
        raise TypeError("device is not a Microscope Device")
 
 

_setuptools_entry_point()

int microscope.gui._setuptools_entry_point ( )

protected

Definition at line 538 of file gui.py.

def _setuptools_entry_point() -> int:
    # The setuptools entry point must be a function, we can't simply
    # name this module even if this module does work as a script.  We
    # also do not want to set the default of main() to sys.argv
    # because when the documentation is generated (with Sphinx's
    # autodoc extension), then sys.argv gets replaced with the
    # sys.argv value at the time docs were generated (see
    # https://stackoverflow.com/a/12087750 )
    return main(sys.argv)
 
 

main()

int microscope.gui.main

(

typing.Sequence[str]

argv

)

Definition at line 487 of file gui.py.

def main(argv: typing.Sequence[str]) -> int:
    app = QtWidgets.QApplication(argv)
    app.setApplicationName("Microscope GUI")
    app.setOrganizationDomain("python-microscope.org")
 
    type_to_widget = {
        "Camera": CameraWidget,
        "Controller": ControllerWidget,
        "DeformableMirror": DeformableMirrorWidget,
        "DeviceSettings": DeviceSettingsWidget,
        "FilterWheel": FilterWheelWidget,
        "LightSourceWidget": LightSourceWidget,
        "Stage": StageWidget,
    }
 
    parser = argparse.ArgumentParser(prog="microscope-gui")
 
    # Although we have a function that can guess the device type from
    # the attributes on the proxy this is still useful.  For example,
    # to display the device settings instead of the device UI.  Or
    # maybe we're dealing with a device that implements more than one
    # interface (earlier iterations of aurox Clarity were both a
    # camera and a filterwheel).  This option provides a way to force
    # a specific widget.
    parser.add_argument(
        "type",
        action="store",
        type=str,
        metavar="DEVICE-TYPE",
        choices=type_to_widget.keys(),
        help="Type of device/widget to show",
    )
 
    parser.add_argument(
        "uri",
        action="store",
        type=str,
        metavar="DEVICE-URI",
        help="URI for device",
    )
    args = parser.parse_args(app.arguments()[1:])
 
    device = Pyro4.Proxy(args.uri)
    widget_cls = type_to_widget[args.type]
    widget = widget_cls(device)
    window = MainWindow(widget)
    window.show()
 
    return app.exec_()
 
 

Variable Documentation

_logger

microscope.gui._logger = logging.getLogger(__name__)

protected

Definition at line 47 of file gui.py.

SERIALIZER

microscope.gui.SERIALIZER

Definition at line 53 of file gui.py.