Changes for page IDL cheat sheet

Last modified by fwilde on 2025/03/28 19:55
From version 59.2
edited by fwilde
on 2025/03/28 19:31
Change comment: There is no comment for this version
To version 26.1
edited by fwilde
on 2018/12/18 11:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,14 +1,16 @@
1 +This is an overview of the most commonly used commands during a beamtime.
2 +
1 1  == {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
2 2  
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 -(% class="fixed-table wrapped" %)
13 +(% class="wrapped fixed-table" %)
12 12  |=(((
13 13  IDL command
14 14  )))|=(((
... ... @@ -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,77 +86,24 @@
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 -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 157  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
158 158  
159 -(% class="fixed-table wrapped" %)
129 +(% class="wrapped fixed-table" %)
160 160  |=(((
161 161  IDL command
162 162  )))|=(((
... ... @@ -165,30 +165,30 @@
165 165  motion
166 166  )))
167 167  |(((
168 -##**o_ccd_dist, 5**##
138 +pressure_on
169 169  )))|(((
170 -move detector in y direction relative by 5 mm
140 +enable detector y movement
171 171  )))|(((
172 -relative [ mm ]
142 +\\
173 173  )))
174 174  |(((
175 -##**goto_o_ccd_dist, 30**##
145 +o_ccd_dist, 5
176 176  )))|(((
177 -move detector in y direction absoilute to 30 mm
147 +move detector in y direction
178 178  )))|(((
179 -
149 +relative [ mm ]
180 180  )))
181 181  |(((
182 -##**pos_o_ccd_dist()**##
152 +pressure_off
183 183  )))|(((
184 -return current of the camera stage distance
154 +disable detector movement
185 185  )))|(((
186 -
156 +\\
187 187  )))
188 188  
189 -== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
159 +== {{id name="IDLcheatsheet-Makeimage"/}}Make image ==
190 190  
191 -(% class="wrapped" %)
161 +(% class="wrapped fixed-table" %)
192 192  |=(((
193 193  IDL command
194 194  )))|=(((
... ... @@ -195,141 +195,42 @@
195 195  description
196 196  )))
197 197  |(((
198 -##**slit_oh, rx=1 (rz=1)**##
168 +i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
199 199  )))|(((
200 -moves oh slit aperture horizontally (vertically) by 1mm
170 +make an image & show image & draw box
201 201  )))
202 202  |(((
203 -##**slit_oh, rdx=1 (rdz=1)**##
173 +a=quick_abs(100) & tv_quick, a & draw_box, [ x1, x2 ,z1 ,z2 ]
204 204  )))|(((
205 -opens oh the slit aperture horizontally (vertically) by 1 mm
175 +make an absorption image & show image & draw box
206 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 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)
178 +== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
224 224  
225 -== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
226 -
227 -(% class="fixed-table wrapped" %)
180 +(% class="wrapped fixed-table" %)
228 228  |=(((
229 229  IDL command
230 230  )))|=(((
231 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 261  )))|=(((
262 -description
186 +motion
263 263  )))
264 264  |(((
265 -**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
189 +calc_dcm_energy, 10000, /set
266 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}}**
191 +set DCM and undulator to 10 keV
271 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.
193 +\\
273 273  )))
274 274  |(((
275 -**{{code language="none"}}qp (, t=100, scale=[0,2], /ref, /here){{/code}}**
196 +dcm_pitch, 0.00001
276 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 -)))|(((
327 327  move 2nd crystal pitch by 0.00001 deg
328 328  )))|(((
329 329  relative [ deg ]
330 330  )))
331 331  |(((
332 -##**goto_dcm_pitch,  -0.03976**##
203 +goto_dcm_pitch,  -0.03976
333 333  )))|(((
334 334  move 2nd crystal pitch to -0.03976 deg
335 335  )))|(((
... ... @@ -336,118 +336,30 @@
336 336  absolute [ deg ]
337 337  )))
338 338  |(((
339 -##**reflex_opt_single**##
210 +reflex_opt
340 340  )))|(((
341 341  move 2nd crystal pitch to optimal flux position
342 342  )))|(((
343 -
214 +\\
344 344  )))
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 356  |(((
357 -##**dmm_x2_rot, 0.001**##
217 +gap, 0.01
358 358  )))|(((
359 -move 2nd crystal pitch by 0.00001 deg
219 +move undulator gap by 0.01 mm
360 360  )))|(((
361 -relative [ deg ]
221 +relative [ mm ]
362 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 370  
224 +== {{id name="IDLcheatsheet-Saveanimageastiff"/}}Save an image as tiff ==
371 371  
372 -
373 -== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
374 -
375 -(% class="relative-table wrapped" style="width:45.5603%" %)
226 +(% class="wrapped" %)
376 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 406  IDL command
407 407  )))|=(((
408 -description
230 +desciption
409 409  )))
410 410  |(((
411 -##**bs_info**##
233 +write_tiff, '/gpfs/current/raw/test.tif', i, /SHORT
412 412  )))|(((
413 -prints an overview of the beamline beamshutter status
235 +save i as 16-bit tiff in /gofs/...
414 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 -
p05_uct.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.fwilde
Size
... ... @@ -1,1 +1,0 @@
1 -1022.2 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -87353119
1 +116602071
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/87353119/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/116602071/IDL cheat sheet