Changes for page IDL cheat sheet

Last modified by fwilde on 2025/03/28 19:55
From version 21.1
edited by fwilde
on 2018/11/28 17:51
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,7 +1,13 @@
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  
9 +=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10 +
5 5  (% class="wrapped fixed-table" %)
6 6  |=(((
7 7  IDL command
... ... @@ -11,7 +11,7 @@
11 11  motion
12 12  )))
13 13  |(((
14 -s_stage_x/z, 1
20 +##**s_stage_x/z, 1**##
15 15  )))|(((
16 16  move rotation stage in x/z-direction by 1 mm
17 17  )))|(((
... ... @@ -18,14 +18,14 @@
18 18  relative [ mm ]
19 19  )))
20 20  |(((
21 -s_pos_z, 1
27 +##**s_pos_x/y/z, 1**##
22 22  )))|(((
23 -move sample stage in z-direction by 1 mm,
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_pos_lateral, 1
34 +##**s_pos, 1**##
29 29  )))|(((
30 30  move sample stage in x-direction by 1 mm, regardless of position of rotation axis
31 31  )))|(((
... ... @@ -32,35 +32,16 @@
32 32  relative [ mm ]
33 33  )))
34 34  |(((
35 -s_angle, 90
41 +##**s_angle, 90**##
36 36  )))|(((
37 37  rotate sample around z axis
38 38  )))|(((
39 39  relative [ deg ]
40 40  )))
41 -|(((
42 -s_in
43 -)))|(((
44 -move sample to "in" position
45 -)))|(((
46 -predefined
47 -)))
48 -|(((
49 -s_out
50 -)))|(((
51 -move sample to "out" position
52 -)))|(((
53 -predefined
54 -)))
55 -|(((
56 -s_change
57 -)))|(((
58 -move sample to "change" position
59 -)))|(((
60 -predefined
61 -)))
62 62  
63 -(% class="relative-table wrapped" style="width: 72.9307%;" %)
48 +=== {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
49 +
50 +(% class="relative-table wrapped" style="width: 67.0892%;" %)
64 64  |=(((
65 65  IDL command
66 66  )))|=(((
... ... @@ -69,7 +69,7 @@
69 69  motion
70 70  )))
71 71  |(((
72 -goto_s_stage_x/z, 1
59 +##**goto_s_stage_x/z, 1**##
73 73  )))|(((
74 74  move rotation stage in x/z-direction to 1 mm
75 75  )))|(((
... ... @@ -76,7 +76,7 @@
76 76  absolute [ mm ]
77 77  )))
78 78  |(((
79 -goto_s_pos_x/y/z, 1
66 +##**goto_s_pos_x/y/z, 1**##
80 80  )))|(((
81 81  move sample stage in x/y/z-direction to 1  mm
82 82  )))|(((
... ... @@ -83,14 +83,16 @@
83 83  absolute [ mm ]
84 84  )))
85 85  |(((
86 -goto_s_angle, 90
73 +##**goto_s_angle, 90**##
87 87  )))|(((
88 -rotate sample around z axis to 90°
75 +rotate sample around z axis to 90° (**alias command: s_rot**)
89 89  )))|(((
90 90  absolute [ deg ]
91 91  )))
92 92  
93 -(% class="relative-table wrapped" style="width: 67.1421%;" %)
80 +=== {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
81 +
82 +(% class="relative-table wrapped" style="width: 54.0627%;" %)
94 94  |=(((
95 95  IDL command
96 96  )))|=(((
... ... @@ -97,21 +97,76 @@
97 97  description
98 98  )))
99 99  |(((
100 -pos_s_stage_x/z()
89 +##**pos_s_stage_x/z()**##
101 101  )))|(((
102 102  return current rotation stage in x/z position
103 103  )))
104 104  |(((
105 -pos_s_pos_x/y/z()
94 +##**pos_s_pos_x/y/z()**##
106 106  )))|(((
107 107  return current sample stage in x/y/z position
108 108  )))
109 109  |(((
110 -pos_s_angle()
99 +##**pos_s_angle()**##
111 111  )))|(((
112 112  return current rotation stage angle
113 113  )))
114 114  
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 +
115 115  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
116 116  
117 117  (% class="wrapped fixed-table" %)
... ... @@ -123,30 +123,30 @@
123 123  motion
124 124  )))
125 125  |(((
126 -pressure_on
170 +##**o_ccd_dist, 5**##
127 127  )))|(((
128 -enable detector y movement
172 +move detector in y direction relative by 5 mm
129 129  )))|(((
130 -\\
174 +relative [ mm ]
131 131  )))
132 132  |(((
133 -o_ccd_dist, 5
177 +##**goto_o_ccd_dist, 30**##
134 134  )))|(((
135 -move detector in y direction
179 +move detector in y direction absoilute to 30 mm
136 136  )))|(((
137 -relative [ mm ]
181 +\\
138 138  )))
139 139  |(((
140 -pressure_off
184 +##**pos_o_ccd_dist()**##
141 141  )))|(((
142 -disable detector movement
186 +return current of the camera stage distance
143 143  )))|(((
144 144  \\
145 145  )))
146 146  
147 -== {{id name="IDLcheatsheet-Makeimage"/}}Make image ==
191 +== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
148 148  
149 -(% class="wrapped fixed-table" %)
193 +(% class="wrapped" %)
150 150  |=(((
151 151  IDL command
152 152  )))|=(((
... ... @@ -153,35 +153,136 @@
153 153  description
154 154  )))
155 155  |(((
156 -i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
200 +##**slit_oh, rx=1 (rz=1)**##
157 157  )))|(((
158 -make an image & show image & draw box
202 +moves oh slit aperture horizontally (vertically) by 1mm
159 159  )))
160 160  |(((
161 -a=quick_abs(100) & tv_quick, a & draw_box, [ x1, x2 ,z1 ,z2 ]
205 +##**slit_oh, rdx=1 (rdz=1)**##
162 162  )))|(((
163 -make an absorption image & show image & draw box
207 +opens oh the slit aperture horizontally (vertically) by 1 mm
164 164  )))
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 +)))
165 165  
166 -== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
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)
167 167  
227 +== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
228 +
168 168  (% class="wrapped fixed-table" %)
169 169  |=(((
170 170  IDL command
171 171  )))|=(((
172 172  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
173 173  )))|=(((
174 -motion
265 +description
175 175  )))
176 176  |(((
177 -calc_dcm_energy, 10000, /set
268 +**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
178 178  )))|(((
179 -set DCM and undulator to 10 keV
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}}**
180 180  )))|(((
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 +
181 181  \\
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
182 182  )))
183 183  |(((
184 -dcm_pitch, 0.00001
329 +##**dcm_pitch, 0.00001**##
185 185  )))|(((
186 186  move 2nd crystal pitch by 0.00001 deg
187 187  )))|(((
... ... @@ -188,7 +188,7 @@
188 188  relative [ deg ]
189 189  )))
190 190  |(((
191 -goto_dcm_pitch,  -0.03976
336 +##**goto_dcm_pitch,  -0.03976**##
192 192  )))|(((
193 193  move 2nd crystal pitch to -0.03976 deg
194 194  )))|(((
... ... @@ -195,7 +195,7 @@
195 195  absolute [ deg ]
196 196  )))
197 197  |(((
198 -reflex_opt
343 +##**reflex_opt_single**##
199 199  )))|(((
200 200  move 2nd crystal pitch to optimal flux position
201 201  )))|(((
... ... @@ -202,16 +202,108 @@
202 202  \\
203 203  )))
204 204  
205 -== {{id name="IDLcheatsheet-Saveanimageastiff"/}}Save an image as tiff ==
350 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
206 206  
207 -(% class="wrapped" %)
352 +(% class="fixed-table wrapped" %)
208 208  |=(((
209 209  IDL command
210 210  )))|=(((
211 -desciption
356 +description
357 +)))|=(((
358 +motion
212 212  )))
213 213  |(((
214 -write_tiff, '/gpfs/current/raw/test.tif', i, /SHORT
361 +##**dmm_x2_rot, 0.001**##
215 215  )))|(((
216 -save i as 16-bit tiff in /gofs/...
363 +move 2nd crystal pitch by 0.00001 deg
364 +)))|(((
365 +relative [ deg ]
217 217  )))
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 +
376 +\\
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
385 +)))
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 -109167001
1 +87353119
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/109167001/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/87353119/IDL cheat sheet