Skip to content

Commit 7e5e723

Browse files
jwlodektacaswell
authored andcommitted
Update docstring for ADTriggerStatus
1 parent b36932b commit 7e5e723

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

ophyd/areadetector/trigger_mixins.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,12 @@ class ADTriggerStatus(DeviceStatus):
2424
A Status for AreaDetector triggers
2525
2626
A special status object that notifies watches (progress bars)
27-
based on comparing device.cam.array_counter to device.cam.num_images.
27+
based on comparing the two signal values counter_signal and
28+
target_signal passed to the object instance at __init__. Once the
29+
value of counter_signal reaches target_signal, the operation is considered done.
30+
If these two signals are passed in as None or not passed in at all (default),
31+
then the standard device.cam.array_counter signal is used as the
32+
progress indicator, and device.cam.num_images is used as the target.
2833
"""
2934

3035
def __init__(self, *args, counter_signal = None, target_signal = None, **kwargs):

0 commit comments

Comments
 (0)