Skip to content

Commit b5eb676

Browse files
Add ViSR docstrings (#1320)
1 parent dd68923 commit b5eb676

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

src/dodal/beamlines/b01_1.py

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@
4242

4343
@device_factory()
4444
def panda() -> HDFPanda:
45+
"""Provides triggering of the detectors.
46+
47+
Returns:
48+
HDFPanda: The HDF5-based detector trigger device.
49+
"""
4550
return HDFPanda(
4651
f"{PREFIX.beamline_prefix}-MO-PANDA-01:",
4752
path_provider=get_path_provider(),
@@ -54,7 +59,16 @@ def synchrotron() -> Synchrotron:
5459

5560

5661
@device_factory()
57-
def manta() -> AravisDetector:
62+
def oav() -> AravisDetector:
63+
"""The Manta camera for the spectroscopy experiment.
64+
65+
Looks at the spectroscopy screen and visualises light
66+
transmitted through the sample after it has gone through
67+
the diffraction grating.
68+
69+
Returns:
70+
AravisDetector: The spectroscopy camera device.
71+
"""
5872
return AravisDetector(
5973
f"{PREFIX.beamline_prefix}-DI-DCAM-02:",
6074
path_provider=get_path_provider(),
@@ -64,10 +78,13 @@ def manta() -> AravisDetector:
6478

6579

6680
@device_factory()
67-
def mako() -> AravisDetector:
68-
"""
69-
The camera for the imaging experiment,
70-
looking at the on-axis viewing screen
81+
def sample_det() -> AravisDetector:
82+
"""The Mako camera for the imaging experiment.
83+
84+
Looks at the on-axis viewing screen.
85+
86+
Returns:
87+
AravisDetector: The imaging camera device.
7188
"""
7289
return AravisDetector(
7390
f"{PREFIX.beamline_prefix}-DI-DCAM-01:",
@@ -79,6 +96,11 @@ def mako() -> AravisDetector:
7996

8097
@device_factory()
8198
def sample_stage() -> XYZStage:
99+
"""An XYZ stage holding the sample.
100+
101+
Returns:
102+
XYZStage: The XYZ sample stage device.
103+
"""
82104
return XYZStage(
83105
f"{PREFIX.beamline_prefix}-MO-PPMAC-01:",
84106
)

0 commit comments

Comments
 (0)