Skip to Content

Wiki source code of IDL cheat sheet

Last modified by fwilde on 2025/07/15 17:44
Show last authors
1 == {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
2
3 Right-handed coordinate system with y-direction along the x-ray beam.
4
5 [[image:attach:p05_uct.png||width="700"]]
6
7 == {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
8
9 === {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10
11 (% class="fixed-table wrapped" %)
12 |=(((
13 IDL command
14 )))|=(((
15 description
16 )))|=(((
17 motion
18 )))
19 |(((
20 ##**s_stage_x/z, 1**##
21 )))|(((
22 move rotation stage in x/z-direction by 1 mm
23 )))|(((
24 relative [ mm ]
25 )))
26 |(((
27 ##**s_pos_x/y/z, 1**##
28 )))|(((
29 move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
30 )))|(((
31 relative [ mm ]
32 )))
33 |(((
34 ##**s_pos, 1**##
35 )))|(((
36 move sample stage in x-direction by 1 mm, regardless of position of rotation axis
37 )))|(((
38 relative [ mm ]
39 )))
40 |(((
41 ##**s_angle, 90**##
42 )))|(((
43 rotate sample around z axis
44 )))|(((
45 relative [ deg ]
46 )))
47
48 === {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
49
50 (% class="relative-table wrapped" style="width:67.0892%" %)
51 |=(((
52 IDL command
53 )))|=(((
54 description
55 )))|=(((
56 motion
57 )))
58 |(((
59 ##**goto_s_stage_x/z, 1**##
60 )))|(((
61 move rotation stage in x/z-direction to 1 mm
62 )))|(((
63 absolute [ mm ]
64 )))
65 |(((
66 ##**goto_s_pos_x/y/z, 1**##
67 )))|(((
68 move sample stage in x/y/z-direction to 1  mm
69 )))|(((
70 absolute [ mm ]
71 )))
72 |(((
73 ##**goto_s_angle, 90**##
74 )))|(((
75 rotate sample around z axis to 90° (**alias command: s_rot**)
76 )))|(((
77 absolute [ deg ]
78 )))
79
80 === {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
81
82 (% class="relative-table wrapped" style="width:54.0627%" %)
83 |=(((
84 IDL command
85 )))|=(((
86 description
87 )))
88 |(((
89 ##**pos_s_stage_x/z()**##
90 )))|(((
91 return current rotation stage in x/z position
92 )))
93 |(((
94 ##**pos_s_pos_x/y/z()**##
95 )))|(((
96 return current sample stage in x/y/z position
97 )))
98 |(((
99 ##**pos_s_angle()**##
100 )))|(((
101 return current rotation stage angle
102 )))
103
104 === {{id name="IDLcheatsheet-Predefinedpositions"/}}Predefined positions ===
105
106 (% class="relative-table wrapped" style="width:55.721%" %)
107 |=(((
108 IDL command
109 )))|=(((
110 description
111 )))
112 |(((
113 ##**s_in**##
114 )))|(((
115 move sample to "in" position
116 )))
117 |(((
118 ##**s_out**##
119 )))|(((
120 move sample to "out" position
121 )))
122 |(((
123 ##**s_change**##
124 )))|(((
125 move sample to "change" position
126 )))
127 |(((
128 ##**set_s_in_pos(, 0)**##
129 )))|(((
130 set s_in position to current stage position, or optionally to e.g. 0.0 mm
131 )))
132 |(((
133 ##**set_s_out_dist, 10**##
134 )))|(((
135 set s_out distance to 10.0 mm
136 )))
137
138 === {{id name="IDLcheatsheet-Magnificationsets"/}}Magnification sets ===
139
140 (% class="wrapped" %)
141 |=(((
142 IDL command
143 )))|=(((
144 description
145 )))
146 |(((
147 ##**save_magn_set(, name_add)**##
148 )))|(((
149 save current magnification set, optionally add something to the automatically generated name
150 )))
151 |(((
152 ##**restore_magn_set(, name)**##
153 )))|(((
154 restore last magnification set, or optionally load a file with a specific name
155 )))
156
157 == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
158
159 (% class="fixed-table wrapped" %)
160 |=(((
161 IDL command
162 )))|=(((
163 description
164 )))|=(((
165 motion
166 )))
167 |(((
168 ##**o_ccd_dist, 5**##
169 )))|(((
170 move detector in y direction relative by 5 mm
171 )))|(((
172 relative [ mm ]
173 )))
174 |(((
175 ##**goto_o_ccd_dist, 30**##
176 )))|(((
177 move detector in y direction absoilute to 30 mm
178 )))|(((
179
180 )))
181 |(((
182 ##**pos_o_ccd_dist()**##
183 )))|(((
184 return current of the camera stage distance
185 )))|(((
186
187 )))
188
189 == {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
190
191 (% class="wrapped" %)
192 |=(((
193 IDL command
194 )))|=(((
195 description
196 )))
197 |(((
198 ##**slit_oh, rx=1 (rz=1)**##
199 )))|(((
200 moves oh slit aperture horizontally (vertically) by 1mm
201 )))
202 |(((
203 ##**slit_oh, rdx=1 (rdz=1)**##
204 )))|(((
205 opens oh the slit aperture horizontally (vertically) by 1 mm
206 )))
207 |(((
208 ##**slit_eh2, rx=1 (rz=1)**##
209 )))|(((
210 moves eh2 slit aperture horizontally (vertically) by 1 mm
211 )))
212 |(((
213 ##**slit_eh2, rdx=1 (rdz=1)**##
214 )))|(((
215 opens eh2 the slit aperture horizontally (vertically) by 1 mm
216 )))
217 |(((
218 ##**slit_info**##
219 )))|(((
220 show all slit positions
221 )))
222
223 rx, rdx, rz and rdz can be concatenated in one command (e.g. slit_oh, rx=1, rz=-2, rdx=0.5, rdz=0.5)
224
225 == {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
226
227 (% class="fixed-table wrapped" %)
228 |=(((
229 IDL command
230 )))|=(((
231 description
232 )))
233 |(((
234 ##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)**##
235 )))|(((
236 make an image & scale image (eg. from 0 to 4096, usually from 0 to maximum value the camera can do)
237 )))
238 |(((
239 ##**a=quick_abs(100) & display_image, BYTSCL(a, 0, 2)**##
240 )))|(((
241 make an absorption image & scale image (usually from 0 to to 2)
242 )))
243 |(((
244 ##**write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT**##
245 )))|(((
246 save i as 16-bit integer tiff in /gpfs/...
247 )))
248 |(((
249 ##**write_tiff, '/gpfs/current/raw/test_absorption.tif', a, /FLOAT**##
250 )))|(((
251 save a as 32-bit float tiff in /gpfs/...
252 )))
253
254 == {{id name="IDLcheatsheet-Macrosmotion+images"/}}Macros motion  + images ==
255
256 These macros make images with predefined and internally saved values (like exposure time or display scale). Some move an axis first and then make an image (again with internally saved options likeexposure time, and image type). **You may use these macros to quickly align samples.**
257
258 (% class="relative-table wrapped" style="width:114.69%" %)
259 |=(((
260 IDL command
261 )))|=(((
262 description
263 )))
264 |(((
265 **{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
266 )))|(((
267 Quick **transmission** image at the current position. Options: set new exposure time, set new scale for image display,
268 )))
269 |(((
270 **{{code language="none"}}qa (, t=100, scale=[0,2], /ref, /here){{/code}}**
271 )))|(((
272 Quick **absorption** image at s_in position. Options: set new exposure time, set new scale for image display, make new reference image, make image at current position.
273 )))
274 |(((
275 **{{code language="none"}}qp (, t=100, scale=[0,2], /ref, /here){{/code}}**
276 )))|(((
277 Quick **phase** image at s_in position. Options: set new exposure time, set new scale for image display, make new reference image, make image at current position
278 )))
279 |(((
280 **{{code language="none"}}qr (, t=100, scale=[0,4096]){{/code}}**
281 )))|(((
282 Quick **reference image**. Options: set new exposure time,  set new scale for image display,
283 )))
284 |(((
285 **{{code language="none"}}side, 90 (, t=100, /ref, /rel, /here, imgtype='a') {{/code}}**
286 )))|(((
287 **Rotate** (absolute degrees) and make an image at the new position. Options: set new exposure time, make new reference image, make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
288 )))
289 |(((
290 **{{code language="none"}}sshift, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}**
291 )))|(((
292 Move **sample stage laterally** (relative, mm) and make an image at the new position. Options: set exposure time, make new reference image, , make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
293 )))
294 |(((
295 ##**sz, 2 (, t=100, /ref, /here, imgtype='a')**##
296 )))|(((
297 Move **rotation stage up or down** (relative, mm) and make an image at the new position. Options: set exposure time, make reference image, make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
298 )))
299 |(((
300 **{{code language="none"}}zx, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}**
301 )))|(((
302 Move **rotation stage left or right** (relative, mm) and make an image at the new position. Options: set exposure time, make reference image, make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
303 )))
304
305 {{info title="
306
307 Monochromator positioning"}}
308 ATTENTION: Setting up a Monochromator as well as positioning front end slits is **only** done by the beamline staff!
309
310 The commands above may be used by users to realign the beam should it beam profile drift with time.
311 {{/info}}
312
313 == {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
314
315 (% class="fixed-table wrapped" %)
316 |=(((
317 IDL command
318 )))|=(((
319 description
320 )))|=(((
321 motion
322 )))
323 |(((
324 ##**dcm_pitch, 0.00001**##
325 )))|(((
326 move 2nd crystal pitch by 0.00001 deg
327 )))|(((
328 relative [ deg ]
329 )))
330 |(((
331 ##**goto_dcm_pitch,  -0.03976**##
332 )))|(((
333 move 2nd crystal pitch to -0.03976 deg
334 )))|(((
335 absolute [ deg ]
336 )))
337 |(((
338 ##**reflex_opt_single**##
339 )))|(((
340 move 2nd crystal pitch to optimal flux position
341 )))|(((
342
343 )))
344
345 == {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
346
347 (% class="fixed-table wrapped" %)
348 |=(((
349 IDL command
350 )))|=(((
351 description
352 )))|=(((
353 motion
354 )))
355 |(((
356 ##**dmm_x2_rot, 0.001**##
357 )))|(((
358 move 2nd crystal pitch by 0.00001 deg
359 )))|(((
360 relative [ deg ]
361 )))
362 |(((
363 ##**goto_dmm_x2_rot,  0.8923**##
364 )))|(((
365 move 2nd crystal pitch to 0.8923 deg
366 )))|(((
367 absolute [ deg ]
368 )))
369
370
371
372 == {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
373
374 (% class="relative-table wrapped" style="width:45.5603%" %)
375 |=(((
376 Functionality
377 )))|=(((
378 IDL syntax
379 )))
380 |(((
381 chaining commands
382 )))|(((
383 command_1 **&** command_2 **&** ...
384 )))
385 |(((
386 absolute movement
387 )))|(((
388 **goto_**//motor//, position
389 )))
390 |(((
391 relative movement
392 )))|(((
393 //motor//, position
394 )))
395 |(((
396 current motor position
397 )))|(((
398 **pos_**//motor//()
399 )))
400
401 == {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
402
403 (% class="relative-table wrapped" style="width:75.0455%" %)
404 |=(((
405 IDL command
406 )))|=(((
407 description
408 )))
409 |(((
410 ##**bs_info**##
411 )))|(((
412 prints an overview of the beamline beamshutter status
413 )))
414 |(((
415 ##**bsoh_open / bsoh_close**##
416 )))|(((
417 opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
418 )))
419 |(((
420 ##**bseh1_open / bseh1_close**##
421 )))|(((
422 opens / closes the EH1 beamshutter. Opening will open the OH beamshutter as well. Closing the OH beamshutter will the EH2 beamshutter as well
423 )))
424 |(((
425 ##**bseh2_open / bseh2_close**##
426 )))|(((
427 opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
428 )))
429 |(((
430 ##**ics_info**##
431 )))|(((
432 prints an overview of the beamline interlock status
433 )))
434 |(((
435 ##**oh_break_ics**##
436 )))|(((
437 closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
438 )))
439 |(((
440 ##**eh1_break_ics**##
441 )))|(((
442 closes EH1 beamshutter (and EH2 beamshutter  if open) and breaks EH1 door interlock
443 )))
444 |(((
445 ##**eh2_break_ics**##
446 )))|(((
447 closes EH2 beamshutter and breaks EH2 door interlock
448 )))
449
450 == Serialscan Macros ==
451
452 General remarks: The serialscan macros save
453
454 |=IDL command|=Description
455 |(%%)(% style="font-family:Courier New,Courier,monospace" %)##**ss_init**##|Reset table and scan settings
456 |(%%)(% style="font-family:Courier New,Courier,monospace" %)**##ss_info##**|Print current stage positions and scan parameters
457 |(%%)(% style="font-family:Courier New,Courier,monospace" %)**##ss_pos, nr, name, dist, sz, sx, sy, dz, ndz, /fetch, /force, /all, /prot##**|Modify sample parameters
458 |(%%)(% style="font-family:Courier New,Courier,monospace" %)**##ss_insert, nr, /nosamplechanger##**|Insert sample with settings from table
459 |(%%)(% style="font-family:Courier New,Courier,monospace" %)**ss_remove**|Remove sample with sample changer
460 |(%%)(% style="font-family:Courier New,Courier,monospace" %)**ss_save, name**|Save the table to disk under "name".
461 |(%%)(% style="font-family:Courier New,Courier,monospace" %)**ss_scan, [1,2,3]**|Scan sbample position list, e.g. [1,2,3]. Respects the order, i.e. [2,3,1] will scan in this order.
462 |ss_scanparam,|
463
464