Skip to Content

Changes for page IDL cheat sheet

Last modified by fwilde on 2025/07/15 17:44
From version 3.1
edited by fwilde
on 2018/04/09 10:00
Change comment: There is no comment for this version
To version 59.1
edited by fwilde
on 2024/06/13 14:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +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 -(% class="wrapped" %)
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="wrapped fixed-table" %)
4 4  |=(((
5 5  IDL command
6 6  )))|=(((
... ... @@ -9,35 +9,37 @@
9 9  motion
10 10  )))
11 11  |(((
12 -s_stage_x/y/z
20 +##**s_stage_x/z, 1**##
13 13  )))|(((
14 -move rotation stage in x/y/z-direction
22 +move rotation stage in x/z-direction by 1 mm
15 15  )))|(((
16 16  relative [ mm ]
17 17  )))
18 18  |(((
19 -s_pos_x/y/z
27 +##**s_pos_x/y/z, 1**##
20 20  )))|(((
21 -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)
22 22  )))|(((
23 23  relative [ mm ]
24 24  )))
25 25  |(((
26 -s_angle
34 +##**s_pos, 1**##
27 27  )))|(((
28 -rotate rotation stage
36 +move sample stage in x-direction by 1 mm, regardless of position of rotation axis
29 29  )))|(((
30 -relative [ deg ]
38 +relative [ mm ]
31 31  )))
32 32  |(((
33 -\\
41 +##**s_angle, 90**##
34 34  )))|(((
35 -\\
43 +rotate sample around z axis
36 36  )))|(((
37 -\\
45 +relative [ deg ]
38 38  )))
39 39  
40 -(% class="relative-table" style="width: 52.0982%;" %)
48 +=== {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
49 +
50 +(% class="relative-table wrapped" style="width: 67.0892%;" %)
41 41  |=(((
42 42  IDL command
43 43  )))|=(((
... ... @@ -46,30 +46,399 @@
46 46  motion
47 47  )))
48 48  |(((
49 -calc_dcm_energy, 10000, /set
59 +##**goto_s_stage_x/z, 1**##
50 50  )))|(((
51 -set DCM and undulator to 10 keV
61 +move rotation stage in x/z-direction to 1 mm
52 52  )))|(((
53 -\\
63 +absolute [ mm ]
54 54  )))
55 55  |(((
56 -dcm_pitch, 0.00001
66 +##**goto_s_pos_x/y/z, 1**##
57 57  )))|(((
58 -move 2nd crystal pitch
68 +move sample stage in x/y/z-direction to 1  mm
59 59  )))|(((
60 -relative [ mm ]
70 +absolute [ mm ]
61 61  )))
62 62  |(((
63 -\\
73 +##**goto_s_angle, 90**##
64 64  )))|(((
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 +)))|(((
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
164 +)))|=(((
165 +description
166 +)))|=(((
167 +motion
168 +)))
169 +|(((
170 +##**o_ccd_dist, 5**##
171 +)))|(((
172 +move detector in y direction relative by 5 mm
173 +)))|(((
174 +relative [ mm ]
175 +)))
176 +|(((
177 +##**goto_o_ccd_dist, 30**##
178 +)))|(((
179 +move detector in y direction absoilute to 30 mm
180 +)))|(((
65 65  \\
182 +)))
183 +|(((
184 +##**pos_o_ccd_dist()**##
66 66  )))|(((
186 +return current of the camera stage distance
187 +)))|(((
67 67  \\
68 68  )))
190 +
191 +== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
192 +
193 +(% class="wrapped" %)
194 +|=(((
195 +IDL command
196 +)))|=(((
197 +description
198 +)))
69 69  |(((
200 +##**slit_oh, rx=1 (rz=1)**##
201 +)))|(((
202 +moves oh slit aperture horizontally (vertically) by 1mm
203 +)))
204 +|(((
205 +##**slit_oh, rdx=1 (rdz=1)**##
206 +)))|(((
207 +opens oh the slit aperture horizontally (vertically) by 1 mm
208 +)))
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 +)))
224 +
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)
226 +
227 +== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
228 +
229 +(% class="wrapped fixed-table" %)
230 +|=(((
231 +IDL command
232 +)))|=(((
233 +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). **You may use these macros to quickly align samples.**
260 +
261 +(% class="relative-table wrapped" style="width: 114.69%;" %)
262 +|=(((
263 +IDL command
264 +)))|=(((
265 +description
266 +)))
267 +|(((
268 +**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
269 +)))|(((
270 +Quick **transmission** image at the current position. Options: set new exposure time, set new scale for image display,
271 +)))
272 +|(((
273 +**{{code language="none"}}qa (, t=100, scale=[0,2], /ref, /here){{/code}}**
274 +)))|(((
275 +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.
276 +)))
277 +|(((
278 +**{{code language="none"}}qp (, t=100, scale=[0,2], /ref, /here){{/code}}**
279 +)))|(((
280 +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
281 +)))
282 +|(((
283 +**{{code language="none"}}qr (, t=100, scale=[0,4096]){{/code}}
284 +**
285 +)))|(((
286 +Quick **reference image**. Options: set new exposure time,  set new scale for image display,
287 +)))
288 +|(((
289 +**{{code language="none"}}side, 90 (, t=100, /ref, /rel, /here, imgtype='a') {{/code}}**
290 +)))|(((
291 +**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)
292 +)))
293 +|(((
294 +**{{code language="none"}}sshift, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}**
295 +)))|(((
296 +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)
297 +)))
298 +|(((
299 +##**sz, 2 (, t=100, /ref, /here, imgtype='a')**##
300 +)))|(((
301 +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)
302 +)))
303 +|(((
304 +**{{code language="none"}}zx, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}
305 +**
306 +)))|(((
307 +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)
308 +)))
309 +
70 70  \\
311 +
312 +{{info title="Monochromator positioning"}}
313 +ATTENTION: Setting up a Monochromator as well as positioning front end slits is **only** done by the beamline staff!
314 +
315 +The commands above may be used by users to realign the beam should it beam profile drift with time.
316 +{{/info}}
317 +
318 +== {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
319 +
320 +(% class="wrapped fixed-table" %)
321 +|=(((
322 +IDL command
323 +)))|=(((
324 +description
325 +)))|=(((
326 +motion
327 +)))
328 +|(((
329 +##**dcm_pitch, 0.00001**##
71 71  )))|(((
331 +move 2nd crystal pitch by 0.00001 deg
332 +)))|(((
333 +relative [ deg ]
334 +)))
335 +|(((
336 +##**goto_dcm_pitch,  -0.03976**##
337 +)))|(((
338 +move 2nd crystal pitch to -0.03976 deg
339 +)))|(((
340 +absolute [ deg ]
341 +)))
342 +|(((
343 +##**reflex_opt_single**##
344 +)))|(((
345 +move 2nd crystal pitch to optimal flux position
346 +)))|(((
72 72  \\
348 +)))
349 +
350 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
351 +
352 +(% class="fixed-table wrapped" %)
353 +|=(((
354 +IDL command
355 +)))|=(((
356 +description
357 +)))|=(((
358 +motion
359 +)))
360 +|(((
361 +##**dmm_x2_rot, 0.001**##
73 73  )))|(((
363 +move 2nd crystal pitch by 0.00001 deg
364 +)))|(((
365 +relative [ deg ]
366 +)))
367 +|(((
368 +##**goto_dmm_x2_rot,  0.8923
369 +**##
370 +)))|(((
371 +move 2nd crystal pitch to 0.8923 deg
372 +)))|(((
373 +absolute [ deg ]
374 +)))
375 +
74 74  \\
377 +
378 +== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
379 +
380 +(% class="wrapped relative-table" style="width: 45.5603%;" %)
381 +|=(((
382 +Functionality
383 +)))|=(((
384 +IDL syntax
75 75  )))
386 +|(((
387 +chaining commands
388 +)))|(((
389 +command_1 **&** command_2 **&** ...
390 +)))
391 +|(((
392 +absolute movement
393 +)))|(((
394 +**goto_**//motor//, position
395 +)))
396 +|(((
397 +relative movement
398 +)))|(((
399 +//motor//, position
400 +)))
401 +|(((
402 +current motor position
403 +)))|(((
404 +**pos_**//motor//()
405 +)))
406 +
407 +== {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
408 +
409 +(% class="wrapped relative-table" style="width: 75.0455%;" %)
410 +|=(((
411 +IDL command
412 +)))|=(((
413 +description
414 +)))
415 +|(((
416 +##**bs_info**##
417 +)))|(((
418 +prints an overview of the beamline beamshutter status
419 +)))
420 +|(((
421 +##**bsoh_open / bsoh_close**##
422 +)))|(((
423 +opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
424 +)))
425 +|(((
426 +##**bseh1_open / bseh1_close**##
427 +)))|(((
428 +opens / closes the EH1 beamshutter. Opening will open the OH beamshutter as well. Closing the OH beamshutter will the EH2 beamshutter as well
429 +)))
430 +|(((
431 +##**bseh2_open / bseh2_close**##
432 +)))|(((
433 +opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
434 +)))
435 +|(((
436 +##**ics_info**##
437 +)))|(((
438 +prints an overview of the beamline interlock status
439 +)))
440 +|(((
441 +##**oh_break_ics**##
442 +)))|(((
443 +closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
444 +)))
445 +|(((
446 +##**eh1_break_ics**##
447 +)))|(((
448 +closes EH1 beamshutter (and EH2 beamshutter  if open) and breaks EH1 door interlock
449 +)))
450 +|(((
451 +##**eh2_break_ics**##
452 +)))|(((
453 +closes EH2 beshutter and breaks EH2 door interlock
454 +)))
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 -87353286
1 +87353119
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/87353286/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/87353119/IDL cheat sheet