Changes for page IDL cheat sheet

Last modified by fwilde on 2025/03/28 19:55

From version 22.1
edited by fwilde
on 2018/11/28 17:53
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
Content
... ... @@ -1,12 +3,14 @@
1 -This is an overview of the most commonly used commands during a beamtime.
2 -
3 3  == {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
4 4  
5 -[[image:attach:P5I.Instrumentation.P05 experimental hutch 2.Micro Tomography setup overview.WebHome@eh2_setup_povray_labeled.png||height="400"]]
3 +Right-handed coordinate system with y-direction along the x-ray beam.
6 6  
5 +[[image:attach:p05_uct.png||width="700"]]
6 +
7 7  == {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
8 8  
9 -(% class="wrapped fixed-table" %)
9 +=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10 +
11 +(% class="fixed-table wrapped" %)
10 10  |=(((
11 11  IDL command
12 12  )))|=(((
... ... @@ -15,7 +15,7 @@
15 15  motion
16 16  )))
17 17  |(((
18 -s_stage_x/z, 1
20 +##**s_stage_x/z, 1**##
19 19  )))|(((
20 20  move rotation stage in x/z-direction by 1 mm
21 21  )))|(((
... ... @@ -22,14 +22,14 @@
22 22  relative [ mm ]
23 23  )))
24 24  |(((
25 -s_pos_z, 1
27 +##**s_pos_x/y/z, 1**##
26 26  )))|(((
27 -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)
28 28  )))|(((
29 29  relative [ mm ]
30 30  )))
31 31  |(((
32 -s_pos_lateral, 1
34 +##**s_pos, 1**##
33 33  )))|(((
34 34  move sample stage in x-direction by 1 mm, regardless of position of rotation axis
35 35  )))|(((
... ... @@ -36,35 +36,16 @@
36 36  relative [ mm ]
37 37  )))
38 38  |(((
39 -s_angle, 90
41 +##**s_angle, 90**##
40 40  )))|(((
41 41  rotate sample around z axis
42 42  )))|(((
43 43  relative [ deg ]
44 44  )))
45 -|(((
46 -s_in
47 -)))|(((
48 -move sample to "in" position
49 -)))|(((
50 -predefined
51 -)))
52 -|(((
53 -s_out
54 -)))|(((
55 -move sample to "out" position
56 -)))|(((
57 -predefined
58 -)))
59 -|(((
60 -s_change
61 -)))|(((
62 -move sample to "change" position
63 -)))|(((
64 -predefined
65 -)))
66 66  
67 -(% 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%" %)
68 68  |=(((
69 69  IDL command
70 70  )))|=(((
... ... @@ -73,7 +73,7 @@
73 73  motion
74 74  )))
75 75  |(((
76 -goto_s_stage_x/z, 1
59 +##**goto_s_stage_x/z, 1**##
77 77  )))|(((
78 78  move rotation stage in x/z-direction to 1 mm
79 79  )))|(((
... ... @@ -80,7 +80,7 @@
80 80  absolute [ mm ]
81 81  )))
82 82  |(((
83 -goto_s_pos_x/y/z, 1
66 +##**goto_s_pos_x/y/z, 1**##
84 84  )))|(((
85 85  move sample stage in x/y/z-direction to 1  mm
86 86  )))|(((
... ... @@ -87,14 +87,16 @@
87 87  absolute [ mm ]
88 88  )))
89 89  |(((
90 -goto_s_angle, 90
73 +##**goto_s_angle, 90**##
91 91  )))|(((
92 -rotate sample around z axis to 90°
75 +rotate sample around z axis to 90° (**alias command: s_rot**)
93 93  )))|(((
94 94  absolute [ deg ]
95 95  )))
96 96  
97 -(% 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%" %)
98 98  |=(((
99 99  IDL command
100 100  )))|=(((
... ... @@ -101,24 +101,77 @@
101 101  description
102 102  )))
103 103  |(((
104 -pos_s_stage_x/z()
89 +##**pos_s_stage_x/z()**##
105 105  )))|(((
106 106  return current rotation stage in x/z position
107 107  )))
108 108  |(((
109 -pos_s_pos_x/y/z()
94 +##**pos_s_pos_x/y/z()**##
110 110  )))|(((
111 111  return current sample stage in x/y/z position
112 112  )))
113 113  |(((
114 -pos_s_angle()
99 +##**pos_s_angle()**##
115 115  )))|(((
116 116  return current rotation stage angle
117 117  )))
118 118  
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 +
119 119  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
120 120  
121 -(% class="wrapped fixed-table" %)
159 +(% class="fixed-table wrapped" %)
122 122  |=(((
123 123  IDL command
124 124  )))|=(((
... ... @@ -127,30 +127,30 @@
127 127  motion
128 128  )))
129 129  |(((
130 -pressure_on
168 +##**o_ccd_dist, 5**##
131 131  )))|(((
132 -enable detector y movement
170 +move detector in y direction relative by 5 mm
133 133  )))|(((
134 -\\
172 +relative [ mm ]
135 135  )))
136 136  |(((
137 -o_ccd_dist, 5
175 +##**goto_o_ccd_dist, 30**##
138 138  )))|(((
139 -move detector in y direction
177 +move detector in y direction absoilute to 30 mm
140 140  )))|(((
141 -relative [ mm ]
179 +
142 142  )))
143 143  |(((
144 -pressure_off
182 +##**pos_o_ccd_dist()**##
145 145  )))|(((
146 -disable detector movement
184 +return current of the camera stage distance
147 147  )))|(((
148 -\\
186 +
149 149  )))
150 150  
151 -== {{id name="IDLcheatsheet-Makeimage"/}}Make image ==
189 +== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
152 152  
153 -(% class="wrapped fixed-table" %)
191 +(% class="wrapped" %)
154 154  |=(((
155 155  IDL command
156 156  )))|=(((
... ... @@ -157,42 +157,141 @@
157 157  description
158 158  )))
159 159  |(((
160 -i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
198 +##**slit_oh, rx=1 (rz=1)**##
161 161  )))|(((
162 -make an image & show image & draw box
200 +moves oh slit aperture horizontally (vertically) by 1mm
163 163  )))
164 164  |(((
165 -a=quick_abs(100) & tv_quick, a & draw_box, [ x1, x2 ,z1 ,z2 ]
203 +##**slit_oh, rdx=1 (rdz=1)**##
166 166  )))|(((
167 -make an absorption image & show image & draw box
205 +opens oh the slit aperture horizontally (vertically) by 1 mm
168 168  )))
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 +)))
169 169  
170 -== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
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)
171 171  
172 -(% class="wrapped fixed-table" %)
225 +== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
226 +
227 +(% class="fixed-table wrapped" %)
173 173  |=(((
174 174  IDL command
175 175  )))|=(((
176 176  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
177 177  )))|=(((
178 -motion
262 +description
179 179  )))
180 180  |(((
181 -calc_dcm_energy, 10000, /set
265 +**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
182 182  )))|(((
183 -set DCM and undulator to 10 keV
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}}**
184 184  )))|(((
185 -\\
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.
186 186  )))
187 187  |(((
188 -dcm_pitch, 0.00001
275 +**{{code language="none"}}qp (, t=100, scale=[0,2], /ref, /here){{/code}}**
189 189  )))|(((
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 +)))|(((
190 190  move 2nd crystal pitch by 0.00001 deg
191 191  )))|(((
192 192  relative [ deg ]
193 193  )))
194 194  |(((
195 -goto_dcm_pitch,  -0.03976
332 +##**goto_dcm_pitch,  -0.03976**##
196 196  )))|(((
197 197  move 2nd crystal pitch to -0.03976 deg
198 198  )))|(((
... ... @@ -199,23 +199,122 @@
199 199  absolute [ deg ]
200 200  )))
201 201  |(((
202 -reflex_opt
339 +##**reflex_opt_single**##
203 203  )))|(((
204 204  move 2nd crystal pitch to optimal flux position
205 205  )))|(((
206 -\\
343 +
207 207  )))
208 208  
209 -== {{id name="IDLcheatsheet-Saveanimageastiff"/}}Save an image as tiff ==
346 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
210 210  
211 -(% class="wrapped" %)
348 +(% class="fixed-table wrapped" %)
212 212  |=(((
213 213  IDL command
214 214  )))|=(((
215 -desciption
352 +description
353 +)))|=(((
354 +motion
216 216  )))
217 217  |(((
218 -write_tiff, '/gpfs/current/raw/test.tif', i, /SHORT
357 +##**dmm_x2_rot, 0.001**##
219 219  )))|(((
220 -save i as 16-bit tiff in /gofs/...
359 +move 2nd crystal pitch by 0.00001 deg
360 +)))|(((
361 +relative [ deg ]
221 221  )))
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 -109167004
1 +87353119
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/109167004/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/87353119/IDL cheat sheet