Skip to content

Commit 93ac499

Browse files
authored
Add missing docstrings, remove unused enum class (#822)
* Add missing docstrings, remove unused enum class * Add missing classes to __all__ to satisfy doc build
1 parent 5e564f0 commit 93ac499

File tree

4 files changed

+19
-11
lines changed

4 files changed

+19
-11
lines changed
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
from ._kinetix import KinetixDetector
22
from ._kinetix_controller import KinetixController
3-
from ._kinetix_io import KinetixDriverIO, KinetixTriggerMode
3+
from ._kinetix_io import KinetixDriverIO, KinetixReadoutMode, KinetixTriggerMode
44

55
__all__ = [
66
"KinetixDetector",
77
"KinetixController",
88
"KinetixDriverIO",
99
"KinetixTriggerMode",
10+
"KinetixReadoutMode",
1011
]

src/ophyd_async/epics/adkinetix/_kinetix_io.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ class KinetixTriggerMode(StrictEnum):
1414

1515

1616
class KinetixReadoutMode(StrictEnum):
17+
"""Readout mode for ADKinetix detector."""
18+
1719
SENSITIVITY = 1
1820
SPEED = 2
1921
DYNAMIC_RANGE = 3
Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
from ._vimba import VimbaDetector
22
from ._vimba_controller import VimbaController
3-
from ._vimba_io import VimbaDriverIO, VimbaExposeOutMode, VimbaOnOff, VimbaTriggerSource
3+
from ._vimba_io import (
4+
VimbaConvertFormat,
5+
VimbaDriverIO,
6+
VimbaExposeOutMode,
7+
VimbaOnOff,
8+
VimbaOverlap,
9+
VimbaTriggerSource,
10+
)
411

512
__all__ = [
613
"VimbaDetector",
@@ -9,4 +16,6 @@
916
"VimbaExposeOutMode",
1017
"VimbaOnOff",
1118
"VimbaTriggerSource",
19+
"VimbaOverlap",
20+
"VimbaConvertFormat",
1221
]

src/ophyd_async/epics/advimba/_vimba_io.py

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,9 @@
55
from ophyd_async.epics.core import PvSuffix
66

77

8-
class VimbaPixelFormat(StrictEnum):
9-
INTERNAL = "Mono8"
10-
EXT_ENABLE = "Mono12"
11-
EXT_TRIGGER = "Ext. Trigger"
12-
MULT_TRIGGER = "Mult. Trigger"
13-
ALIGNMENT = "Alignment"
14-
15-
168
class VimbaConvertFormat(StrictEnum):
9+
"""Convert pixel format for the Vimba detector."""
10+
1711
NONE = "None"
1812
MONO8 = "Mono8"
1913
MONO16 = "Mono16"
@@ -34,6 +28,8 @@ class VimbaTriggerSource(StrictEnum):
3428

3529

3630
class VimbaOverlap(StrictEnum):
31+
"""Overlap modes for the Vimba detector."""
32+
3733
OFF = "Off"
3834
PREV_FRAME = "PreviousFrame"
3935

@@ -46,7 +42,7 @@ class VimbaOnOff(StrictEnum):
4642

4743

4844
class VimbaExposeOutMode(StrictEnum):
49-
"""Modes for exposure on the Vimba detector."""
45+
"""Exposure control modes for Vimba detectors."""
5046

5147
TIMED = "Timed" # Use ExposureTime PV
5248
TRIGGER_WIDTH = "TriggerWidth" # Expose for length of high signal

0 commit comments

Comments
 (0)