File tree Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Original file line number Diff line number Diff line change 100100
101101
102102class Clarity (microscope .devices .ControllerDevice , microscope .devices .FilterWheelBase ):
103+ """Adds support for Aurox Clarity
104+
105+ Acts as a ControllerDevice providing the camera attached to the Clarity.
106+ """
103107 _slide_to_sectioning = {__SLDPOS0 : 'bypass' ,
104108 __SLDPOS1 : 'low' ,
105109 __SLDPOS2 : 'mid' ,
@@ -115,6 +119,14 @@ class Clarity(microscope.devices.ControllerDevice, microscope.devices.FilterWhee
115119
116120
117121 def __init__ (self , camera = None , ** kwargs ) -> None :
122+ """Create a Clarity instance controlling an optional Camera device.
123+
124+ :param camera: a class to control the connected camera
125+ :param kwargs: Provide camera parameters as keyword arguments:
126+ 'camera.some_parameter'
127+ The 'camera.' prefix will be stripped, and
128+ 'some_parameter' passed to the camera's constructor.
129+ """
118130 # Extract kwargs for camera device.
119131 cam_kw_keys = [k for k in kwargs if k .startswith ("camera." )]
120132 cam_kwargs = {}
You can’t perform that action at this time.
0 commit comments