Changes for page IDL cheat sheet

Last modified by fwilde on 2025/03/28 19:55
From version 54.1
edited by fwilde
on 2024/06/13 13:58
Change comment: There is no comment for this version
To version 27.1
edited by fwilde
on 2018/12/18 12:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,13 +1,15 @@
1 -== {{id name="IDLcheatsheet-eCoordinatesystem"/}}eCoordinate system ==
1 +This is an overview of the most commonly used commands during a beamtime.
2 2  
3 +== {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
4 +
3 3  Right-handed coordinate system with y-direction along the x-ray beam.
4 4  
7 +\\
8 +
5 5  [[image:attach:p05_uct.png||width="700"]]
6 6  
7 7  == {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
8 8  
9 -=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10 -
11 11  (% class="wrapped fixed-table" %)
12 12  |=(((
13 13  IDL command
... ... @@ -17,7 +17,7 @@
17 17  motion
18 18  )))
19 19  |(((
20 -##**s_stage_x/z, 1**##
22 +s_stage_x/z, 1
21 21  )))|(((
22 22  move rotation stage in x/z-direction by 1 mm
23 23  )))|(((
... ... @@ -24,14 +24,14 @@
24 24  relative [ mm ]
25 25  )))
26 26  |(((
27 -##**s_pos_x/y/z, 1**##
29 +s_pos_z, 1
28 28  )))|(((
29 -move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
31 +move sample stage in z-direction by 1 mm,
30 30  )))|(((
31 31  relative [ mm ]
32 32  )))
33 33  |(((
34 -##**s_pos, 1**##
36 +s_pos_lateral, 1
35 35  )))|(((
36 36  move sample stage in x-direction by 1 mm, regardless of position of rotation axis
37 37  )))|(((
... ... @@ -38,16 +38,39 @@
38 38  relative [ mm ]
39 39  )))
40 40  |(((
41 -##**s_angle, 90**##
43 +s_angle, 90
42 42  )))|(((
43 43  rotate sample around z axis
44 44  )))|(((
45 45  relative [ deg ]
46 46  )))
49 +|(((
50 +s_in
51 +)))|(((
52 +move sample to "in" position
53 +)))|(((
54 +predefined
55 +)))
56 +|(((
57 +s_out
58 +)))|(((
59 +move sample to "out" position
60 +)))|(((
61 +predefined
62 +)))
63 +|(((
64 +s_change
65 +)))|(((
66 +move sample to "change" position
67 +)))|(((
68 +predefined
69 +)))
47 47  
48 -=== {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
71 +\\
49 49  
50 -(% class="relative-table wrapped" style="width: 67.0892%;" %)
73 +\\
74 +
75 +(% class="relative-table wrapped" style="width: 72.9307%;" %)
51 51  |=(((
52 52  IDL command
53 53  )))|=(((
... ... @@ -56,7 +56,7 @@
56 56  motion
57 57  )))
58 58  |(((
59 -##**goto_s_stage_x/z, 1**##
84 +goto_s_stage_x/z, 1
60 60  )))|(((
61 61  move rotation stage in x/z-direction to 1 mm
62 62  )))|(((
... ... @@ -63,7 +63,7 @@
63 63  absolute [ mm ]
64 64  )))
65 65  |(((
66 -##**goto_s_pos_x/y/z, 1**##
91 +goto_s_pos_x/y/z, 1
67 67  )))|(((
68 68  move sample stage in x/y/z-direction to 1  mm
69 69  )))|(((
... ... @@ -70,16 +70,14 @@
70 70  absolute [ mm ]
71 71  )))
72 72  |(((
73 -##**goto_s_angle, 90**##
98 +goto_s_angle, 90
74 74  )))|(((
75 -rotate sample around z axis to 90° (**alias command: s_rot**)
100 +rotate sample around z axis to 90°
76 76  )))|(((
77 77  absolute [ deg ]
78 78  )))
79 79  
80 -=== {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
81 -
82 -(% class="relative-table wrapped" style="width: 54.0627%;" %)
105 +(% class="relative-table wrapped" style="width: 67.1421%;" %)
83 83  |=(((
84 84  IDL command
85 85  )))|=(((
... ... @@ -86,76 +86,21 @@
86 86  description
87 87  )))
88 88  |(((
89 -##**pos_s_stage_x/z()**##
112 +pos_s_stage_x/z()
90 90  )))|(((
91 91  return current rotation stage in x/z position
92 92  )))
93 93  |(((
94 -##**pos_s_pos_x/y/z()**##
117 +pos_s_pos_x/y/z()
95 95  )))|(((
96 96  return current sample stage in x/y/z position
97 97  )))
98 98  |(((
99 -##**pos_s_angle()**##
122 +pos_s_angle()
100 100  )))|(((
101 101  return current rotation stage angle
102 102  )))
103 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 159  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
160 160  
161 161  (% class="wrapped fixed-table" %)
... ... @@ -167,30 +167,30 @@
167 167  motion
168 168  )))
169 169  |(((
170 -##**o_ccd_dist, 5**##
138 +pressure_on
171 171  )))|(((
172 -move detector in y direction relative by 5 mm
140 +enable detector y movement
173 173  )))|(((
174 -relative [ mm ]
142 +\\
175 175  )))
176 176  |(((
177 -##**goto_o_ccd_dist, 30**##
145 +o_ccd_dist, 5
178 178  )))|(((
179 -move detector in y direction absoilute to 30 mm
147 +move detector in y direction
180 180  )))|(((
181 -\\
149 +relative [ mm ]
182 182  )))
183 183  |(((
184 -##**pos_o_ccd_dist()**##
152 +pressure_off
185 185  )))|(((
186 -return current of the camera stage distance
154 +disable detector movement
187 187  )))|(((
188 188  \\
189 189  )))
190 190  
191 -== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
159 +== {{id name="IDLcheatsheet-Makeimage"/}}Make image ==
192 192  
193 -(% class="wrapped" %)
161 +(% class="wrapped fixed-table" %)
194 194  |=(((
195 195  IDL command
196 196  )))|=(((
... ... @@ -197,130 +197,35 @@
197 197  description
198 198  )))
199 199  |(((
200 -##**slit_oh, rx=1 (rz=1)**##
168 +i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
201 201  )))|(((
202 -moves oh slit aperture horizontally (vertically) by 1mm
170 +make an image & show image & draw box
203 203  )))
204 204  |(((
205 -##**slit_oh, rdx=1 (rdz=1)**##
173 +a=quick_abs(100) & tv_quick, a & draw_box, [ x1, x2 ,z1 ,z2 ]
206 206  )))|(((
207 -opens oh the slit aperture horizontally (vertically) by 1 mm
175 +make an absorption image & show image & draw box
208 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 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)
178 +== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
226 226  
227 -== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
228 -
229 229  (% class="wrapped fixed-table" %)
230 230  |=(((
231 231  IDL command
232 232  )))|=(((
233 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). Use these macros to quickly align you samples.
260 -
261 -(% class="relative-table" style="width: 109.112%;" %)
262 -|=(((
263 -IDL command
264 264  )))|=(((
265 -description
186 +motion
266 266  )))
267 267  |(((
268 -**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
189 +calc_dcm_energy, 10000, /set
269 269  )))|(((
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}}**
191 +set DCM and undulator to 10 keV
274 274  )))|(((
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 -
304 304  \\
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
321 321  )))
322 322  |(((
323 -##**dcm_pitch, 0.00001**##
196 +dcm_pitch, 0.00001
324 324  )))|(((
325 325  move 2nd crystal pitch by 0.00001 deg
326 326  )))|(((
... ... @@ -327,7 +327,7 @@
327 327  relative [ deg ]
328 328  )))
329 329  |(((
330 -##**goto_dcm_pitch,  -0.03976**##
203 +goto_dcm_pitch,  -0.03976
331 331  )))|(((
332 332  move 2nd crystal pitch to -0.03976 deg
333 333  )))|(((
... ... @@ -334,44 +334,36 @@
334 334  absolute [ deg ]
335 335  )))
336 336  |(((
337 -##**reflex_opt_single**##
210 +reflex_opt
338 338  )))|(((
339 339  move 2nd crystal pitch to optimal flux position
340 340  )))|(((
341 341  \\
342 342  )))
216 +|(((
217 +gap, 0.01
218 +)))|(((
219 +move undulator gap by 0.01 mm
220 +)))|(((
221 +relative [ mm ]
222 +)))
343 343  
344 -== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
224 +== {{id name="IDLcheatsheet-Saveanimageastiff"/}}Save an image as tiff ==
345 345  
346 -(% class="fixed-table wrapped" %)
226 +(% class="wrapped" %)
347 347  |=(((
348 348  IDL command
349 349  )))|=(((
350 -description
351 -)))|=(((
352 -motion
230 +desciption
353 353  )))
354 354  |(((
355 -##**dmm_x2_rot, 0.001**##
233 +write_tiff, '/gpfs/current/raw/test.tif', i, /SHORT
356 356  )))|(((
357 -move 2nd crystal pitch by 0.00001 deg
358 -)))|(((
359 -relative [ deg ]
235 +save i as 16-bit tiff in /gofs/...
360 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 369  
370 -\\
238 +== {{id name="IDLcheatsheet-Generalremarks"/}}General remarks ==
371 371  
372 -== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
373 -
374 -(% class="wrapped relative-table" style="width: 45.5603%;" %)
375 375  |=(((
376 376  Functionality
377 377  )))|=(((
... ... @@ -378,7 +378,7 @@
378 378  IDL syntax
379 379  )))
380 380  |(((
381 -chaining commands
246 +Chaining commands
382 382  )))|(((
383 383  command_1 **&** command_2 **&** ...
384 384  )))
... ... @@ -397,103 +397,3 @@
397 397  )))|(((
398 398  **pos_**//motor//()
399 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 -365835076
1 +116602076
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/365835076/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/116602076/IDL cheat sheet