@@ -84,20 +84,19 @@ def start_spectrum(
84
84
"""Start the procedure. Called by the queue_model.
85
85
86
86
Args:
87
- integration_time: Inregration time [s].
88
- data_dir: Directory to save the data (full path).
89
- archive_dir: Directory to save the archive data (full path).
90
- prefix: File prefix
91
- session_id: Session ID number (from ISpyB)
92
- blsample_id: Sample ID number (from ISpyB)
93
- cpos: The centred position motors and their values.
87
+ integration_time (float) : Inregration time [s].
88
+ data_dir (str) : Directory to save the data (full path).
89
+ archive_dir (str) : Directory to save the archive data (full path).
90
+ prefix (str) : File prefix.
91
+ session_id (int) : Session ID number (from ISpyB).
92
+ blsample_id (int) : Sample ID number (from ISpyB).
93
+ cpos (dict) : The centred position motors and their values.
94
94
"""
95
95
self .cpos = cpos
96
96
self .spectrum_info_dict = {"sessionId" : session_id , "blSampleId" : blsample_id }
97
97
integration_time = integration_time or self .default_integration_time
98
98
self .spectrum_info_dict ["exposureTime" ] = integration_time
99
99
self .spectrum_info_dict ["filename" ] = ""
100
-
101
100
# Create the data and the archive directory (if needed) and files
102
101
if data_dir :
103
102
if not self .create_directory (data_dir ):
@@ -135,8 +134,8 @@ def execute_spectrum(
135
134
"""Do the acquisition.
136
135
137
136
Args:
138
- integration_time: MCA integration time [s].
139
- filename: Data file (full path).
137
+ integration_time (float) : MCA integration time [s].
138
+ filename (str) : Data file (full path).
140
139
Raises:
141
140
RuntimeError: Cannot acquire data.
142
141
"""
@@ -166,7 +165,7 @@ def _execute_spectrum(
166
165
def create_directory (self , directory : str ) -> bool :
167
166
"""Create a directory, if needed.
168
167
Args:
169
- directory: Directory to save the data (full path).
168
+ directory (str) : Directory to save the data (full path).
170
169
Returns:
171
170
``True`` if directory created or already exists, ``False`` if error.
172
171
"""
0 commit comments