Changes for page IDL cheat sheet

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

From version 38.1
edited by fwilde
on 2019/04/01 18:21
Change comment: There is no comment for this version
To version 56.1
edited by fwilde
on 2024/06/13 14:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,4 @@
1 -== {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
1 +== {{id name="IDLcheatsheet-eCoordinatesystem"/}}eCoordinate system ==
2 2  
3 3  Right-handed coordinate system with y-direction along the x-ray beam.
4 4  
... ... @@ -17,7 +17,7 @@
17 17  motion
18 18  )))
19 19  |(((
20 -s_stage_x/z, 1
20 +##**s_stage_x/z, 1**##
21 21  )))|(((
22 22  move rotation stage in x/z-direction by 1 mm
23 23  )))|(((
... ... @@ -24,7 +24,7 @@
24 24  relative [ mm ]
25 25  )))
26 26  |(((
27 -s_pos_x/y/z, 1
27 +##**s_pos_x/y/z, 1**##
28 28  )))|(((
29 29  move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
30 30  )))|(((
... ... @@ -31,7 +31,7 @@
31 31  relative [ mm ]
32 32  )))
33 33  |(((
34 -s_pos_lateral, 1
34 +##**s_pos, 1**##
35 35  )))|(((
36 36  move sample stage in x-direction by 1 mm, regardless of position of rotation axis
37 37  )))|(((
... ... @@ -38,7 +38,7 @@
38 38  relative [ mm ]
39 39  )))
40 40  |(((
41 -s_angle, 90
41 +##**s_angle, 90**##
42 42  )))|(((
43 43  rotate sample around z axis
44 44  )))|(((
... ... @@ -47,7 +47,7 @@
47 47  
48 48  === {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
49 49  
50 -(% class="relative-table wrapped" style="width: 63.4026%;" %)
50 +(% class="relative-table wrapped" style="width: 67.0892%;" %)
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
59 +##**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
66 +##**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,9 +70,9 @@
70 70  absolute [ mm ]
71 71  )))
72 72  |(((
73 -goto_s_angle, 90
73 +##**goto_s_angle, 90**##
74 74  )))|(((
75 -rotate sample around z axis to 90° (alias command: s_rot)
75 +rotate sample around z axis to 90° (**alias command: s_rot**)
76 76  )))|(((
77 77  absolute [ deg ]
78 78  )))
... ... @@ -79,7 +79,7 @@
79 79  
80 80  === {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
81 81  
82 -(% class="relative-table wrapped" style="width: 51.477%;" %)
82 +(% class="relative-table wrapped" style="width: 54.0627%;" %)
83 83  |=(((
84 84  IDL command
85 85  )))|=(((
... ... @@ -86,17 +86,17 @@
86 86  description
87 87  )))
88 88  |(((
89 -pos_s_stage_x/z()
89 +##**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()
94 +##**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()
99 +##**pos_s_angle()**##
100 100  )))|(((
101 101  return current rotation stage angle
102 102  )))
... ... @@ -103,7 +103,7 @@
103 103  
104 104  === {{id name="IDLcheatsheet-Predefinedpositions"/}}Predefined positions ===
105 105  
106 -(% class="relative-table wrapped" style="width: 52.0241%;" %)
106 +(% class="relative-table wrapped" style="width: 55.721%;" %)
107 107  |=(((
108 108  IDL command
109 109  )))|=(((
... ... @@ -110,31 +110,52 @@
110 110  description
111 111  )))
112 112  |(((
113 -s_in
113 +##**s_in**##
114 114  )))|(((
115 115  move sample to "in" position
116 116  )))
117 117  |(((
118 -s_out
118 +##**s_out**##
119 119  )))|(((
120 120  move sample to "out" position
121 121  )))
122 122  |(((
123 -s_change
123 +##**s_change**##
124 124  )))|(((
125 125  move sample to "change" position
126 126  )))
127 127  |(((
128 -set_s_in_pos, 0
128 +##**set_s_in_pos(, 0)**##
129 129  )))|(((
130 -set s_in position to 0.0 mm
130 +set s_in position to current stage position, or optionally to e.g. 0.0 mm
131 131  )))
132 132  |(((
133 -set_s_out_dist, 10
133 +##**set_s_out_dist, 10**##
134 134  )))|(((
135 135  set s_out distance to 10.0 mm
136 136  )))
137 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 +
138 138  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
139 139  
140 140  (% class="wrapped fixed-table" %)
... ... @@ -146,23 +146,23 @@
146 146  motion
147 147  )))
148 148  |(((
149 -pressure_on
170 +##**o_ccd_dist, 5**##
150 150  )))|(((
151 -enable detector y movement
172 +move detector in y direction relative by 5 mm
152 152  )))|(((
153 -\\
174 +relative [ mm ]
154 154  )))
155 155  |(((
156 -o_ccd_dist, 5
177 +##**goto_o_ccd_dist, 30**##
157 157  )))|(((
158 -move detector in y direction
179 +move detector in y direction absoilute to 30 mm
159 159  )))|(((
160 -relative [ mm ]
181 +\\
161 161  )))
162 162  |(((
163 -pressure_off
184 +##**pos_o_ccd_dist()**##
164 164  )))|(((
165 -disable detector movement
186 +return current of the camera stage distance
166 166  )))|(((
167 167  \\
168 168  )))
... ... @@ -169,6 +169,7 @@
169 169  
170 170  == {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
171 171  
193 +(% class="wrapped" %)
172 172  |=(((
173 173  IDL command
174 174  )))|=(((
... ... @@ -175,24 +175,34 @@
175 175  description
176 176  )))
177 177  |(((
178 -slit_eh2, rx=1 (rz=1)
200 +##**slit_oh, rx=1 (rz=1)**##
179 179  )))|(((
180 -moves eh2 slit aperture horizontally (vertically) by 1mm , **works analoguous for slit_oh and slit_ps2**
202 +moves oh slit aperture horizontally (vertically) by 1mm
181 181  )))
182 182  |(((
183 -slit_eh2, rdz=1 (rdz=1)
205 +##**slit_oh, rdx=1 (rdz=1)**##
184 184  )))|(((
185 -opens eh2 the slit aperture horizontally (vertically) by 1 mm, **works analoguous for slit_oh and slit_ps2**
207 +opens oh the slit aperture horizontally (vertically) by 1 mm
186 186  )))
187 187  |(((
188 -slit_info
210 +##**slit_eh2, rx=1 (rz=1)**##
189 189  )))|(((
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 +)))|(((
190 190  show all slit positions
191 191  )))
192 192  
193 -rx, rdx, rz and rdz can be concatenated in one command.
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)
194 194  
195 -== {{id name="IDLcheatsheet-Makeimages"/}}Make images ==
227 +== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
196 196  
197 197  (% class="wrapped fixed-table" %)
198 198  |=(((
... ... @@ -201,40 +201,94 @@
201 201  description
202 202  )))
203 203  |(((
204 -i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
236 +##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)
237 +**##
205 205  )))|(((
206 -make an image & show image & draw box
239 +make an image & scale image (eg. from 0 to 4096, usually from 0 to maximum value the camera can do)
207 207  )))
208 208  |(((
209 -a=quick_abs(100) & tv_quick, a & draw_box, [ x1, x2 ,z1 ,z2 ]
242 +##**a=quick_abs(100) & display_image, BYTSCL(a, 0, 2)**##
210 210  )))|(((
211 -make an absorption image & show image & draw box
244 +make an absorption image & scale image (usually from 0 to to 2)
212 212  )))
213 213  |(((
214 -write_tiff, '/gpfs/current/raw/test.tif', i, /SHORT
247 +##**write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT**##
215 215  )))|(((
216 -save i as 16-bit tiff in /gpfs/...
249 +save i as 16-bit integer tiff in /gpfs/...
217 217  )))
251 +|(((
252 +##**write_tiff, '/gpfs/current/raw/test_absorption.tif', a, /FLOAT**##
253 +)))|(((
254 +save a as 32-bit float tiff in /gpfs/...
255 +)))
218 218  
219 -== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
257 +== {{id name="IDLcheatsheet-Macrosmotion+images"/}}Macros motion  + images ==
220 220  
221 -(% class="wrapped fixed-table" %)
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 wrapped" style="width: 114.69%;" %)
222 222  |=(((
223 223  IDL command
224 224  )))|=(((
225 225  description
226 -)))|=(((
227 -motion
228 228  )))
229 229  |(((
230 -calc_dcm_energy, 10000, /set
268 +**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
231 231  )))|(((
232 -set DCM and undulator to 10 keV
270 +Quick **transmission** image at the current position. Options: set new exposure time.
271 +)))
272 +|(((
273 +**{{code language="none"}}qa (, t=100, scale=[0,2], /ref, /here){{/code}}**
233 233  )))|(((
275 +Quick **absorption** image at s_in position. Options: set new exposure time, 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, make new reference image, make image at current position
281 +)))
282 +|(((
283 +**{{code language="none"}}side, 90 (, t=100, /ref, /rel, /here, imgtype='a') {{/code}}**
284 +)))|(((
285 +**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)
286 +)))
287 +|(((
288 +**{{code language="none"}}sshift, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}**
289 +)))|(((
290 +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)
291 +)))
292 +|(((
293 +##**sz, 2 (, t=100, /ref, /here, imgtype='a')**##
294 +)))|(((
295 +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)
296 +)))
297 +|(((
298 +**{{code language="none"}}zx, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}
299 +**
300 +)))|(((
301 +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)
302 +)))
303 +
234 234  \\
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
235 235  )))
236 236  |(((
237 -dcm_pitch, 0.00001
323 +##**dcm_pitch, 0.00001**##
238 238  )))|(((
239 239  move 2nd crystal pitch by 0.00001 deg
240 240  )))|(((
... ... @@ -241,7 +241,7 @@
241 241  relative [ deg ]
242 242  )))
243 243  |(((
244 -goto_dcm_pitch,  -0.03976
330 +##**goto_dcm_pitch,  -0.03976**##
245 245  )))|(((
246 246  move 2nd crystal pitch to -0.03976 deg
247 247  )))|(((
... ... @@ -248,23 +248,44 @@
248 248  absolute [ deg ]
249 249  )))
250 250  |(((
251 -reflex_opt
337 +##**reflex_opt_single**##
252 252  )))|(((
253 253  move 2nd crystal pitch to optimal flux position
254 254  )))|(((
255 255  \\
256 256  )))
343 +
344 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
345 +
346 +(% class="fixed-table wrapped" %)
347 +|=(((
348 +IDL command
349 +)))|=(((
350 +description
351 +)))|=(((
352 +motion
353 +)))
257 257  |(((
258 -gap, 0.01
355 +##**dmm_x2_rot, 0.001**##
259 259  )))|(((
260 -move undulator gap by 0.01 mm
357 +move 2nd crystal pitch by 0.00001 deg
261 261  )))|(((
262 -relative [ mm ]
359 +relative [ deg ]
263 263  )))
361 +|(((
362 +##**goto_dmm_x2_rot,  0.8923
363 +**##
364 +)))|(((
365 +move 2nd crystal pitch to 0.8923 deg
366 +)))|(((
367 +absolute [ deg ]
368 +)))
264 264  
370 +\\
371 +
265 265  == {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
266 266  
267 -(% class="wrapped relative-table" style="width: 51.5317%;" %)
374 +(% class="wrapped relative-table" style="width: 45.5603%;" %)
268 268  |=(((
269 269  Functionality
270 270  )))|=(((
... ... @@ -271,7 +271,7 @@
271 271  IDL syntax
272 272  )))
273 273  |(((
274 -Chaining commands
381 +chaining commands
275 275  )))|(((
276 276  command_1 **&** command_2 **&** ...
277 277  )))
... ... @@ -290,3 +290,103 @@
290 290  )))|(((
291 291  **pos_**//motor//()
292 292  )))
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 -127042833
1 +365835132
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/127042833/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/365835132/IDL cheat sheet