Skip to Content

Changes for page IDL cheat sheet

Last modified by fwilde on 2025/07/15 17:44
From version 8.1
edited by moosmanj
on 2018/05/28 16:34
Change comment: There is no comment for this version
To version 54.1
edited by fwilde
on 2024/06/13 13:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.moosmanj
1 +XWiki.fwilde
Content
... ... @@ -1,8 +1,14 @@
1 -This is an overview of the most commonly used commands during a beamtime.
1 +== {{id name="IDLcheatsheet-eCoordinatesystem"/}}eCoordinate system ==
2 2  
3 +Right-handed coordinate system with y-direction along the x-ray beam.
4 +
5 +[[image:attach:p05_uct.png||width="700"]]
6 +
3 3  == {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
4 4  
5 -(% class="wrapped" %)
9 +=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10 +
11 +(% class="wrapped fixed-table" %)
6 6  |=(((
7 7  IDL command
8 8  )))|=(((
... ... @@ -11,49 +11,125 @@
11 11  motion
12 12  )))
13 13  |(((
14 -s_stage_x/z
20 +##**s_stage_x/z, 1**##
15 15  )))|(((
16 -move rotation stage in x/z-direction
22 +move rotation stage in x/z-direction by 1 mm
17 17  )))|(((
18 18  relative [ mm ]
19 19  )))
20 20  |(((
21 -s_pos_x/y/z
27 +##**s_pos_x/y/z, 1**##
22 22  )))|(((
23 -move sample stage in x/y/z-direction
29 +move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
24 24  )))|(((
25 25  relative [ mm ]
26 26  )))
27 27  |(((
28 -s_rot, 90
34 +##**s_pos, 1**##
29 29  )))|(((
30 -rotate rotation stage to 90 degrees
36 +move sample stage in x-direction by 1 mm, regardless of position of rotation axis
31 31  )))|(((
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 +)))|(((
32 32  absolute [ deg ]
33 33  )))
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 +)))
34 34  |(((
35 -s_in
89 +##**pos_s_stage_x/z()**##
36 36  )))|(((
37 -move sample to "in" position
91 +return current rotation stage in x/z position
92 +)))
93 +|(((
94 +##**pos_s_pos_x/y/z()**##
38 38  )))|(((
39 -predefined
96 +return current sample stage in x/y/z position
40 40  )))
41 41  |(((
42 -s_out
99 +##**pos_s_angle()**##
43 43  )))|(((
44 -move sample to "out" position
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**##
45 45  )))|(((
46 -predefined
115 +move sample to "in" position
47 47  )))
48 48  |(((
49 -s_change
118 +##**s_out**##
50 50  )))|(((
120 +move sample to "out" position
121 +)))
122 +|(((
123 +##**s_change**##
124 +)))|(((
51 51  move sample to "change" position
126 +)))
127 +|(((
128 +##**set_s_in_pos(, 0)**##
52 52  )))|(((
53 -predefined
130 +set s_in position to current stage position, or optionally to e.g. 0.0 mm
54 54  )))
132 +|(((
133 +##**set_s_out_dist, 10**##
134 +)))|(((
135 +set s_out distance to 10.0 mm
136 +)))
55 55  
56 -== {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
138 +=== {{id name="IDLcheatsheet-Magnificationsets"/}}Magnification sets ===
57 57  
58 58  (% class="wrapped" %)
59 59  |=(((
... ... @@ -60,32 +60,53 @@
60 60  IDL command
61 61  )))|=(((
62 62  description
145 +)))
146 +|(((
147 +##**save_magn_set(, name_add)
148 +**##
149 +)))|(((
150 +save current magnification set, optionally add something to the automatically generated name
151 +)))
152 +|(((
153 +##**restore_magn_set(, name)
154 +**##
155 +)))|(((
156 +restore last magnification set, or optionally load a file with a specific name
157 +)))
158 +
159 +== {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
160 +
161 +(% class="wrapped fixed-table" %)
162 +|=(((
163 +IDL command
63 63  )))|=(((
165 +description
166 +)))|=(((
64 64  motion
65 65  )))
66 66  |(((
67 -pressure_on
170 +##**o_ccd_dist, 5**##
68 68  )))|(((
69 -enable detector y movement
172 +move detector in y direction relative by 5 mm
70 70  )))|(((
71 -\\
174 +relative [ mm ]
72 72  )))
73 73  |(((
74 -o_ccd_dist, 5
177 +##**goto_o_ccd_dist, 30**##
75 75  )))|(((
76 -move detector in y direction
179 +move detector in y direction absoilute to 30 mm
77 77  )))|(((
78 -relative [ mm ]
181 +\\
79 79  )))
80 80  |(((
81 -pressure_off
184 +##**pos_o_ccd_dist()**##
82 82  )))|(((
83 -disable detector movement
186 +return current of the camera stage distance
84 84  )))|(((
85 85  \\
86 86  )))
87 87  
88 -== {{id name="IDLcheatsheet-Makeimage"/}}Make image ==
191 +== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
89 89  
90 90  (% class="wrapped" %)
91 91  |=(((
... ... @@ -94,37 +94,130 @@
94 94  description
95 95  )))
96 96  |(((
97 -i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
200 +##**slit_oh, rx=1 (rz=1)**##
98 98  )))|(((
99 -make an image & show image & draw box
202 +moves oh slit aperture horizontally (vertically) by 1mm
100 100  )))
101 101  |(((
102 -\\
205 +##**slit_oh, rdx=1 (rdz=1)**##
103 103  )))|(((
104 -\\
207 +opens oh the slit aperture horizontally (vertically) by 1 mm
105 105  )))
209 +|(((
210 +##**slit_eh2, rx=1 (rz=1)**##
211 +)))|(((
212 +moves eh2 slit aperture horizontally (vertically) by 1 mm
213 +)))
214 +|(((
215 +##**slit_eh2, rdx=1 (rdz=1)**##
216 +)))|(((
217 +opens eh2 the slit aperture horizontally (vertically) by 1 mm
218 +)))
219 +|(((
220 +##**slit_info**##
221 +)))|(((
222 +show all slit positions
223 +)))
106 106  
107 -\\
225 +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)
108 108  
109 -== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
227 +== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
110 110  
111 -(% class="relative-table wrapped" style="width: 52.0982%;" %)
229 +(% class="wrapped fixed-table" %)
112 112  |=(((
113 113  IDL command
114 114  )))|=(((
115 115  description
234 +)))
235 +|(((
236 +##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)
237 +**##
238 +)))|(((
239 +make an image & scale image (eg. from 0 to 4096, usually from 0 to maximum value the camera can do)
240 +)))
241 +|(((
242 +##**a=quick_abs(100) & display_image, BYTSCL(a, 0, 2)**##
243 +)))|(((
244 +make an absorption image & scale image (usually from 0 to to 2)
245 +)))
246 +|(((
247 +##**write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT**##
248 +)))|(((
249 +save i as 16-bit integer tiff in /gpfs/...
250 +)))
251 +|(((
252 +##**write_tiff, '/gpfs/current/raw/test_absorption.tif', a, /FLOAT**##
253 +)))|(((
254 +save a as 32-bit float tiff in /gpfs/...
255 +)))
256 +
257 +== {{id name="IDLcheatsheet-Macrosmotion+images"/}}Macros motion  + images ==
258 +
259 +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). Use these macros to quickly align you samples.
260 +
261 +(% class="relative-table" style="width: 109.112%;" %)
262 +|=(((
263 +IDL command
116 116  )))|=(((
117 -motion
265 +description
118 118  )))
119 119  |(((
120 -calc_dcm_energy, 10000, /set
268 +**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
121 121  )))|(((
122 -set DCM and undulator to 10 keV
270 +quick transmission image at the current position, optionally set a new exposure time
271 +)))
272 +|(((
273 +**{{code language="none"}}qa (, t=100, scale=[0,2], /ref){{/code}}**
123 123  )))|(((
275 +quick absorption image at the current position, optionally set new exposure time or force to make a new reference image
276 +)))
277 +|(((
278 +**{{code language="none"}}qp (, t=100, scale=[0,2], /ref){{/code}}**
279 +)))|(((
280 +quick phase retreived image at the current position, optionally set new exposure time or for to make a new reference image
281 +)))
282 +|(((
283 +**{{code language="none"}}side, 90 (, t=100, /ref, /rel, imgtype='a') {{/code}}**
284 +)))|(((
285 +move rotation state to absolute angle in degrees (unless /rel is set) and make an imge. Image type can optionally be defined as "a'  (absorption), 't' (transmission) or 'p' (phase). Exposure time is also otional
286 +)))
287 +|(((
288 +**{{code language="none"}}sshift, 2 (, t=100, /ref, imgtype='a'){{/code}}**
289 +)))|(((
290 +move sample stage laterally relative to current position and make an image at the new position. Optionally set exposure time, make flat field, or set image type)
291 +)))
292 +|(((
293 +##**sz, 2 (, t=100, /ref, imgtype='a')**##
294 +)))|(((
295 +move rotation stage up or down relative to current position and make an image at the new position. Optionally set exposure time, make reference image or set the image type.
296 +)))
297 +|(((
298 +**{{code language="none"}}zx, 2 (, t=100, /ref, imgtype='a'){{/code}}
299 +**
300 +)))|(((
301 +move rotation stage left or right relative to current position and make an image at the new position. Optionally set exposure time, make reference image or set the image type.
302 +)))
303 +
124 124  \\
305 +
306 +{{info title="Monochromator positioning"}}
307 +ATTENTION: Setting up a Monochromator as well as positioning front end slits is **only** done by the beamline staff!
308 +
309 +The commands above may be used by users to realign the beam should it beam profile drift with time.
310 +{{/info}}
311 +
312 +== {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
313 +
314 +(% class="wrapped fixed-table" %)
315 +|=(((
316 +IDL command
317 +)))|=(((
318 +description
319 +)))|=(((
320 +motion
125 125  )))
126 126  |(((
127 -dcm_pitch, 0.00001
323 +##**dcm_pitch, 0.00001**##
128 128  )))|(((
129 129  move 2nd crystal pitch by 0.00001 deg
130 130  )))|(((
... ... @@ -131,7 +131,7 @@
131 131  relative [ deg ]
132 132  )))
133 133  |(((
134 -goto_dcm_pitch,  -0.03976
330 +##**goto_dcm_pitch,  -0.03976**##
135 135  )))|(((
136 136  move 2nd crystal pitch to -0.03976 deg
137 137  )))|(((
... ... @@ -138,9 +138,166 @@
138 138  absolute [ deg ]
139 139  )))
140 140  |(((
141 -reflex_opt
337 +##**reflex_opt_single**##
142 142  )))|(((
143 143  move 2nd crystal pitch to optimal flux position
144 144  )))|(((
145 145  \\
146 146  )))
343 +
344 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
345 +
346 +(% class="fixed-table wrapped" %)
347 +|=(((
348 +IDL command
349 +)))|=(((
350 +description
351 +)))|=(((
352 +motion
353 +)))
354 +|(((
355 +##**dmm_x2_rot, 0.001**##
356 +)))|(((
357 +move 2nd crystal pitch by 0.00001 deg
358 +)))|(((
359 +relative [ deg ]
360 +)))
361 +|(((
362 +##**goto_dmm_x2_rot,  0.8923
363 +**##
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="wrapped relative-table" 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="wrapped relative-table" 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 beshutter and breaks EH2 door interlock
448 +)))
449 +
450 +== {{id name="IDLcheatsheet-Helpermacros"/}}Helper macros ==
451 +
452 +The helper macros may help to align a sample quickly. Mainly, these are motion commands which subsequently make an image with predefined values.
453 +
454 +(% class="wrapped" %)
455 +|=(((
456 +IDL command
457 +)))|=(((
458 +description
459 +)))
460 +|(((
461 +helper_object, /info
462 +)))|(((
463 +show predefined values
464 +)))
465 +|(((
466 +\\
467 +)))|(((
468 +\\
469 +)))
470 +|(((
471 +\\
472 +)))|(((
473 +\\
474 +)))
475 +|(((
476 +\\
477 +)))|(((
478 +\\
479 +)))
480 +|(((
481 +\\
482 +)))|(((
483 +\\
484 +)))
485 +|(((
486 +\\
487 +)))|(((
488 +\\
489 +)))
490 +|(((
491 +\\
492 +)))|(((
493 +\\
494 +)))
495 +|(((
496 +\\
497 +)))|(((
498 +\\
499 +)))
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -94155739
1 +365835076
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/94155739/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/365835076/IDL cheat sheet