Skip to Content

Changes for page IDL cheat sheet

Last modified by fwilde on 2025/07/15 17:44
From version 6.1
edited by moosmanj
on 2018/05/28 16:16
Change comment: There is no comment for this version
To version 59.4
edited by fwilde
on 2025/03/28 19:34
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-Coordinatesystem"/}}Coordinate 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="fixed-table wrapped" %)
6 6  |=(((
7 7  IDL command
8 8  )))|=(((
... ... @@ -11,31 +11,148 @@
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  )))
34 34  
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 +
35 35  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
36 36  
159 +(% class="fixed-table wrapped" %)
37 37  |=(((
38 -IDL comman
161 +IDL command
39 39  )))|=(((
40 40  description
41 41  )))|=(((
... ... @@ -42,53 +42,171 @@
42 42  motion
43 43  )))
44 44  |(((
45 -pressure_on
168 +##**o_ccd_dist, 5**##
46 46  )))|(((
47 -enable detector y movement
170 +move detector in y direction relative by 5 mm
48 48  )))|(((
49 -\\
172 +relative [ mm ]
50 50  )))
51 51  |(((
52 -o_ccd_dist, 5
175 +##**goto_o_ccd_dist, 30**##
53 53  )))|(((
54 -move detector in y direction
177 +move detector in y direction absoilute to 30 mm
55 55  )))|(((
56 -relative [ mm ]
179 +
57 57  )))
58 58  |(((
59 -pressure_off
182 +##**pos_o_ccd_dist()**##
60 60  )))|(((
61 -disable detector movement
184 +return current of the camera stage distance
62 62  )))|(((
63 -\\
186 +
64 64  )))
65 65  
66 -== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
189 +== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
67 67  
68 -(% class="relative-table wrapped" style="width: 52.0982%;" %)
191 +(% class="wrapped" %)
69 69  |=(((
70 70  IDL command
71 71  )))|=(((
72 72  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
73 73  )))|=(((
74 -motion
231 +description
75 75  )))
76 76  |(((
77 -calc_dcm_energy, 10000, /set
234 +##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)**##
78 78  )))|(((
79 -set DCM and undulator to 10 keV
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)**##
80 80  )))|(((
81 -\\
241 +make an absorption image & scale image (usually from 0 to to 2)
82 82  )))
83 83  |(((
84 -dcm_pitch, 0.00001
244 +##**write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT**##
85 85  )))|(((
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 +
308 +Monochromator positioning"}}
309 +ATTENTION: Setting up a Monochromator as well as positioning front end slits is **only** done by the beamline staff!
310 +
311 +The commands above may be used by users to realign the beam should it beam profile drift with time.
312 +{{/info}}
313 +
314 +== {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
315 +
316 +(% class="fixed-table wrapped" %)
317 +|=(((
318 +IDL command
319 +)))|=(((
320 +description
321 +)))|=(((
322 +motion
323 +)))
324 +|(((
325 +##**dcm_pitch, 0.00001**##
326 +)))|(((
86 86  move 2nd crystal pitch by 0.00001 deg
87 87  )))|(((
88 88  relative [ deg ]
89 89  )))
90 90  |(((
91 -goto_dcm_pitch,  -0.03976
332 +##**goto_dcm_pitch,  -0.03976**##
92 92  )))|(((
93 93  move 2nd crystal pitch to -0.03976 deg
94 94  )))|(((
... ... @@ -95,9 +95,122 @@
95 95  absolute [ deg ]
96 96  )))
97 97  |(((
98 -reflex_opt
339 +##**reflex_opt_single**##
99 99  )))|(((
100 100  move 2nd crystal pitch to optimal flux position
101 101  )))|(((
102 -\\
343 +
103 103  )))
345 +
346 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
347 +
348 +(% class="fixed-table wrapped" %)
349 +|=(((
350 +IDL command
351 +)))|=(((
352 +description
353 +)))|=(((
354 +motion
355 +)))
356 +|(((
357 +##**dmm_x2_rot, 0.001**##
358 +)))|(((
359 +move 2nd crystal pitch by 0.00001 deg
360 +)))|(((
361 +relative [ deg ]
362 +)))
363 +|(((
364 +##**goto_dmm_x2_rot,  0.8923**##
365 +)))|(((
366 +move 2nd crystal pitch to 0.8923 deg
367 +)))|(((
368 +absolute [ deg ]
369 +)))
370 +
371 +
372 +
373 +== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
374 +
375 +(% class="relative-table wrapped" style="width:45.5603%" %)
376 +|=(((
377 +Functionality
378 +)))|=(((
379 +IDL syntax
380 +)))
381 +|(((
382 +chaining commands
383 +)))|(((
384 +command_1 **&** command_2 **&** ...
385 +)))
386 +|(((
387 +absolute movement
388 +)))|(((
389 +**goto_**//motor//, position
390 +)))
391 +|(((
392 +relative movement
393 +)))|(((
394 +//motor//, position
395 +)))
396 +|(((
397 +current motor position
398 +)))|(((
399 +**pos_**//motor//()
400 +)))
401 +
402 +== {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
403 +
404 +(% class="relative-table wrapped" style="width:75.0455%" %)
405 +|=(((
406 +IDL command
407 +)))|=(((
408 +description
409 +)))
410 +|(((
411 +##**bs_info**##
412 +)))|(((
413 +prints an overview of the beamline beamshutter status
414 +)))
415 +|(((
416 +##**bsoh_open / bsoh_close**##
417 +)))|(((
418 +opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
419 +)))
420 +|(((
421 +##**bseh1_open / bseh1_close**##
422 +)))|(((
423 +opens / closes the EH1 beamshutter. Opening will open the OH beamshutter as well. Closing the OH beamshutter will the EH2 beamshutter as well
424 +)))
425 +|(((
426 +##**bseh2_open / bseh2_close**##
427 +)))|(((
428 +opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
429 +)))
430 +|(((
431 +##**ics_info**##
432 +)))|(((
433 +prints an overview of the beamline interlock status
434 +)))
435 +|(((
436 +##**oh_break_ics**##
437 +)))|(((
438 +closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
439 +)))
440 +|(((
441 +##**eh1_break_ics**##
442 +)))|(((
443 +closes EH1 beamshutter (and EH2 beamshutter  if open) and breaks EH1 door interlock
444 +)))
445 +|(((
446 +##**eh2_break_ics**##
447 +)))|(((
448 +closes EH2 beamshutter and breaks EH2 door interlock
449 +)))
450 +
451 +== Sample Changer Macros ==
452 +
453 +|=IDL command|=Description
454 +|##**ss_init**##|reset
455 +| |
456 +
457 +
p05_uct.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.fwilde
Size
... ... @@ -1,0 +1,1 @@
1 +1022.2 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -94155732
1 +87353119
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/94155732/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/87353119/IDL cheat sheet