Skip to Content

Wiki source code of IDL cheat sheet

Version 60.2 by fwilde on 2025/07/15 10:47
Hide last authors
fwilde 59.1 1 == {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
fwilde 22.1 2
fwilde 23.1 3 Right-handed coordinate system with y-direction along the x-ray beam.
4
fwilde 25.1 5 [[image:attach:p05_uct.png||width="700"]]
6
moosmanj 6.1 7 == {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
8
fwilde 31.1 9 === {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10
fwilde 59.2 11 (% class="fixed-table wrapped" %)
fwilde 1.1 12 |=(((
13 IDL command
14 )))|=(((
15 description
fwilde 3.1 16 )))|=(((
17 motion
fwilde 1.1 18 )))
19 |(((
fwilde 46.1 20 ##**s_stage_x/z, 1**##
fwilde 1.1 21 )))|(((
fwilde 15.1 22 move rotation stage in x/z-direction by 1 mm
fwilde 3.1 23 )))|(((
24 relative [ mm ]
fwilde 1.1 25 )))
26 |(((
fwilde 46.1 27 ##**s_pos_x/y/z, 1**##
fwilde 1.1 28 )))|(((
fwilde 45.1 29 move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
fwilde 3.1 30 )))|(((
31 relative [ mm ]
fwilde 1.1 32 )))
33 |(((
fwilde 52.1 34 ##**s_pos, 1**##
fwilde 18.1 35 )))|(((
36 move sample stage in x-direction by 1 mm, regardless of position of rotation axis
37 )))|(((
38 relative [ mm ]
39 )))
40 |(((
fwilde 46.1 41 ##**s_angle, 90**##
fwilde 3.1 42 )))|(((
moosmanj 9.1 43 rotate sample around z axis
fwilde 3.1 44 )))|(((
moosmanj 9.1 45 relative [ deg ]
fwilde 3.1 46 )))
moosmanj 6.1 47
fwilde 31.1 48 === {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
49
fwilde 59.2 50 (% class="relative-table wrapped" style="width:67.0892%" %)
fwilde 15.1 51 |=(((
52 IDL command
53 )))|=(((
54 description
55 )))|=(((
56 motion
57 )))
58 |(((
fwilde 46.1 59 ##**goto_s_stage_x/z, 1**##
fwilde 15.1 60 )))|(((
61 move rotation stage in x/z-direction to 1 mm
62 )))|(((
63 absolute [ mm ]
64 )))
65 |(((
fwilde 46.1 66 ##**goto_s_pos_x/y/z, 1**##
fwilde 15.1 67 )))|(((
fwilde 45.1 68 move sample stage in x/y/z-direction to 1  mm
fwilde 15.1 69 )))|(((
70 absolute [ mm ]
71 )))
72 |(((
fwilde 46.1 73 ##**goto_s_angle, 90**##
fwilde 15.1 74 )))|(((
fwilde 46.1 75 rotate sample around z axis to 90° (**alias command: s_rot**)
fwilde 15.1 76 )))|(((
77 absolute [ deg ]
78 )))
79
fwilde 32.1 80 === {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
fwilde 31.1 81
fwilde 59.2 82 (% class="relative-table wrapped" style="width:54.0627%" %)
fwilde 15.1 83 |=(((
84 IDL command
85 )))|=(((
86 description
87 )))
88 |(((
fwilde 46.1 89 ##**pos_s_stage_x/z()**##
fwilde 15.1 90 )))|(((
91 return current rotation stage in x/z position
92 )))
93 |(((
fwilde 46.1 94 ##**pos_s_pos_x/y/z()**##
fwilde 15.1 95 )))|(((
fwilde 45.1 96 return current sample stage in x/y/z position
fwilde 15.1 97 )))
98 |(((
fwilde 46.1 99 ##**pos_s_angle()**##
fwilde 15.1 100 )))|(((
101 return current rotation stage angle
102 )))
103
fwilde 31.1 104 === {{id name="IDLcheatsheet-Predefinedpositions"/}}Predefined positions ===
105
fwilde 59.2 106 (% class="relative-table wrapped" style="width:55.721%" %)
fwilde 31.1 107 |=(((
108 IDL command
109 )))|=(((
110 description
111 )))
112 |(((
fwilde 46.1 113 ##**s_in**##
fwilde 31.1 114 )))|(((
115 move sample to "in" position
116 )))
117 |(((
fwilde 46.1 118 ##**s_out**##
fwilde 31.1 119 )))|(((
120 move sample to "out" position
121 )))
122 |(((
fwilde 46.1 123 ##**s_change**##
fwilde 31.1 124 )))|(((
125 move sample to "change" position
126 )))
127 |(((
fwilde 53.1 128 ##**set_s_in_pos(, 0)**##
fwilde 31.1 129 )))|(((
fwilde 53.1 130 set s_in position to current stage position, or optionally to e.g. 0.0 mm
fwilde 31.1 131 )))
132 |(((
fwilde 46.1 133 ##**set_s_out_dist, 10**##
fwilde 31.1 134 )))|(((
135 set s_out distance to 10.0 mm
136 )))
137
fwilde 45.1 138 === {{id name="IDLcheatsheet-Magnificationsets"/}}Magnification sets ===
139
140 (% class="wrapped" %)
141 |=(((
142 IDL command
143 )))|=(((
144 description
145 )))
146 |(((
fwilde 59.2 147 ##**save_magn_set(, name_add)**##
fwilde 45.1 148 )))|(((
fwilde 51.1 149 save current magnification set, optionally add something to the automatically generated name
fwilde 45.1 150 )))
151 |(((
fwilde 59.2 152 ##**restore_magn_set(, name)**##
fwilde 45.1 153 )))|(((
fwilde 51.1 154 restore last magnification set, or optionally load a file with a specific name
fwilde 45.1 155 )))
156
moosmanj 6.1 157 == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
158
fwilde 59.2 159 (% class="fixed-table wrapped" %)
moosmanj 6.1 160 |=(((
moosmanj 7.1 161 IDL command
moosmanj 6.1 162 )))|=(((
163 description
164 )))|=(((
165 motion
166 )))
fwilde 3.1 167 |(((
fwilde 50.1 168 ##**o_ccd_dist, 5**##
fwilde 1.1 169 )))|(((
fwilde 50.1 170 move detector in y direction relative by 5 mm
moosmanj 6.1 171 )))|(((
fwilde 50.1 172 relative [ mm ]
moosmanj 6.1 173 )))
174 |(((
fwilde 50.1 175 ##**goto_o_ccd_dist, 30**##
fwilde 3.1 176 )))|(((
fwilde 50.1 177 move detector in y direction absoilute to 30 mm
moosmanj 6.1 178 )))|(((
fwilde 59.2 179
moosmanj 6.1 180 )))
181 |(((
fwilde 50.1 182 ##**pos_o_ccd_dist()**##
moosmanj 6.1 183 )))|(((
fwilde 50.1 184 return current of the camera stage distance
moosmanj 6.1 185 )))|(((
fwilde 59.2 186
fwilde 1.1 187 )))
fwilde 3.1 188
fwilde 45.1 189 == {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
190
191 (% class="wrapped" %)
192 |=(((
193 IDL command
194 )))|=(((
195 description
196 )))
197 |(((
fwilde 47.1 198 ##**slit_oh, rx=1 (rz=1)**##
199 )))|(((
200 moves oh slit aperture horizontally (vertically) by 1mm
201 )))
202 |(((
203 ##**slit_oh, rdx=1 (rdz=1)**##
204 )))|(((
205 opens oh the slit aperture horizontally (vertically) by 1 mm
206 )))
207 |(((
fwilde 46.1 208 ##**slit_eh2, rx=1 (rz=1)**##
fwilde 45.1 209 )))|(((
fwilde 47.1 210 moves eh2 slit aperture horizontally (vertically) by 1 mm
fwilde 45.1 211 )))
212 |(((
fwilde 47.1 213 ##**slit_eh2, rdx=1 (rdz=1)**##
fwilde 45.1 214 )))|(((
fwilde 47.1 215 opens eh2 the slit aperture horizontally (vertically) by 1 mm
fwilde 45.1 216 )))
217 |(((
fwilde 46.1 218 ##**slit_info**##
fwilde 45.1 219 )))|(((
220 show all slit positions
221 )))
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)
224
fwilde 47.1 225 == {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
moosmanj 7.1 226
fwilde 59.2 227 (% class="fixed-table wrapped" %)
moosmanj 7.1 228 |=(((
229 IDL command
230 )))|=(((
231 description
232 )))
233 |(((
fwilde 59.2 234 ##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)**##
moosmanj 7.1 235 )))|(((
fwilde 47.1 236 make an image & scale image (eg. from 0 to 4096, usually from 0 to maximum value the camera can do)
moosmanj 7.1 237 )))
238 |(((
fwilde 47.1 239 ##**a=quick_abs(100) & display_image, BYTSCL(a, 0, 2)**##
moosmanj 7.1 240 )))|(((
fwilde 47.1 241 make an absorption image & scale image (usually from 0 to to 2)
moosmanj 7.1 242 )))
fwilde 34.1 243 |(((
fwilde 47.1 244 ##**write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT**##
fwilde 34.1 245 )))|(((
fwilde 47.1 246 save i as 16-bit integer tiff in /gpfs/...
fwilde 34.1 247 )))
fwilde 47.1 248 |(((
249 ##**write_tiff, '/gpfs/current/raw/test_absorption.tif', a, /FLOAT**##
250 )))|(((
251 save a as 32-bit float tiff in /gpfs/...
252 )))
moosmanj 7.1 253
fwilde 54.1 254 == {{id name="IDLcheatsheet-Macrosmotion+images"/}}Macros motion  + images ==
fwilde 49.1 255
fwilde 58.1 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.**
fwilde 54.1 257
fwilde 59.2 258 (% class="relative-table wrapped" style="width:114.69%" %)
fwilde 54.1 259 |=(((
260 IDL command
261 )))|=(((
262 description
263 )))
264 |(((
265 **{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
266 )))|(((
fwilde 57.1 267 Quick **transmission** image at the current position. Options: set new exposure time, set new scale for image display,
fwilde 54.1 268 )))
269 |(((
fwilde 55.1 270 **{{code language="none"}}qa (, t=100, scale=[0,2], /ref, /here){{/code}}**
fwilde 54.1 271 )))|(((
fwilde 57.1 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.
fwilde 54.1 273 )))
274 |(((
fwilde 55.1 275 **{{code language="none"}}qp (, t=100, scale=[0,2], /ref, /here){{/code}}**
fwilde 54.1 276 )))|(((
fwilde 57.1 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
fwilde 54.1 278 )))
279 |(((
fwilde 59.2 280 **{{code language="none"}}qr (, t=100, scale=[0,4096]){{/code}}**
fwilde 57.1 281 )))|(((
282 Quick **reference image**. Options: set new exposure time,  set new scale for image display,
283 )))
284 |(((
fwilde 55.1 285 **{{code language="none"}}side, 90 (, t=100, /ref, /rel, /here, imgtype='a') {{/code}}**
fwilde 54.1 286 )))|(((
fwilde 56.1 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)
fwilde 54.1 288 )))
289 |(((
fwilde 55.1 290 **{{code language="none"}}sshift, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}**
fwilde 54.1 291 )))|(((
fwilde 56.1 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)
fwilde 54.1 293 )))
294 |(((
fwilde 55.1 295 ##**sz, 2 (, t=100, /ref, /here, imgtype='a')**##
fwilde 54.1 296 )))|(((
fwilde 56.1 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)
fwilde 54.1 298 )))
299 |(((
fwilde 59.2 300 **{{code language="none"}}zx, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}**
fwilde 54.1 301 )))|(((
fwilde 56.1 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)
fwilde 54.1 303 )))
304
fwilde 60.2 305 {{info title="
fwilde 49.1 306
fwilde 59.2 307 Monochromator positioning"}}
fwilde 49.1 308 ATTENTION: Setting up a Monochromator as well as positioning front end slits is **only** done by the beamline staff!
309
310 The commands above may be used by users to realign the beam should it beam profile drift with time.
311 {{/info}}
312
fwilde 47.1 313 == {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
moosmanj 6.1 314
fwilde 59.2 315 (% class="fixed-table wrapped" %)
fwilde 3.1 316 |=(((
317 IDL command
318 )))|=(((
319 description
320 )))|=(((
321 motion
322 )))
fwilde 1.1 323 |(((
fwilde 46.1 324 ##**dcm_pitch, 0.00001**##
fwilde 1.1 325 )))|(((
fwilde 4.1 326 move 2nd crystal pitch by 0.00001 deg
fwilde 3.1 327 )))|(((
fwilde 4.1 328 relative [ deg ]
fwilde 3.1 329 )))
330 |(((
fwilde 46.1 331 ##**goto_dcm_pitch,  -0.03976**##
fwilde 3.1 332 )))|(((
fwilde 4.1 333 move 2nd crystal pitch to -0.03976 deg
fwilde 3.1 334 )))|(((
fwilde 4.1 335 absolute [ deg ]
fwilde 1.1 336 )))
fwilde 3.1 337 |(((
fwilde 51.1 338 ##**reflex_opt_single**##
fwilde 3.1 339 )))|(((
fwilde 4.1 340 move 2nd crystal pitch to optimal flux position
fwilde 3.1 341 )))|(((
fwilde 59.2 342
fwilde 3.1 343 )))
fwilde 47.1 344
345 == {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
346
fwilde 48.1 347 (% class="fixed-table wrapped" %)
fwilde 47.1 348 |=(((
349 IDL command
350 )))|=(((
351 description
352 )))|=(((
353 motion
354 )))
fwilde 26.1 355 |(((
fwilde 47.1 356 ##**dmm_x2_rot, 0.001**##
357 )))|(((
358 move 2nd crystal pitch by 0.00001 deg
359 )))|(((
360 relative [ deg ]
361 )))
362 |(((
fwilde 59.2 363 ##**goto_dmm_x2_rot,  0.8923**##
fwilde 47.1 364 )))|(((
365 move 2nd crystal pitch to 0.8923 deg
366 )))|(((
367 absolute [ deg ]
368 )))
fwilde 14.1 369
fwilde 47.1 370
fwilde 59.2 371
fwilde 35.1 372 == {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
fwilde 27.1 373
fwilde 59.2 374 (% class="relative-table wrapped" style="width:45.5603%" %)
fwilde 27.1 375 |=(((
376 Functionality
377 )))|=(((
378 IDL syntax
379 )))
380 |(((
fwilde 46.1 381 chaining commands
fwilde 27.1 382 )))|(((
383 command_1 **&** command_2 **&** ...
384 )))
385 |(((
386 absolute movement
387 )))|(((
388 **goto_**//motor//, position
389 )))
390 |(((
391 relative movement
392 )))|(((
393 //motor//, position
394 )))
395 |(((
396 current motor position
397 )))|(((
398 **pos_**//motor//()
399 )))
fwilde 45.1 400
401 == {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
402
fwilde 59.2 403 (% class="relative-table wrapped" style="width:75.0455%" %)
fwilde 45.1 404 |=(((
405 IDL command
406 )))|=(((
407 description
408 )))
409 |(((
fwilde 46.1 410 ##**bs_info**##
fwilde 45.1 411 )))|(((
412 prints an overview of the beamline beamshutter status
413 )))
414 |(((
fwilde 46.1 415 ##**bsoh_open / bsoh_close**##
fwilde 45.1 416 )))|(((
417 opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
418 )))
419 |(((
fwilde 46.1 420 ##**bseh1_open / bseh1_close**##
fwilde 45.1 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 |(((
fwilde 46.1 425 ##**bseh2_open / bseh2_close**##
fwilde 45.1 426 )))|(((
427 opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
428 )))
429 |(((
fwilde 46.1 430 ##**ics_info**##
fwilde 45.1 431 )))|(((
432 prints an overview of the beamline interlock status
433 )))
434 |(((
fwilde 51.1 435 ##**oh_break_ics**##
fwilde 45.1 436 )))|(((
437 closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
438 )))
439 |(((
fwilde 51.1 440 ##**eh1_break_ics**##
fwilde 45.1 441 )))|(((
442 closes EH1 beamshutter (and EH2 beamshutter  if open) and breaks EH1 door interlock
443 )))
444 |(((
fwilde 51.1 445 ##**eh2_break_ics**##
fwilde 45.1 446 )))|(((
fwilde 59.2 447 closes EH2 beamshutter and breaks EH2 door interlock
fwilde 45.1 448 )))
fwilde 59.2 449
fwilde 60.2 450 == Serialscan Macros ==
fwilde 59.2 451
fwilde 59.27 452 General remarks: The serialscan macros save
fwilde 59.20 453
fwilde 59.3 454 |=IDL command|=Description
fwilde 59.5 455 |##**ss_init**##|reset table
fwilde 59.10 456 |**##ss_info##**|print current stage positions and scan parameters
fwilde 60.1 457 |**##ss_pos, nr, name, dist, sz, sx, sy, dz, ndz, /fetch, /force, /all, /prot##**|Modify sample parameters
458 |**##ss_insert, nr, /nosamplechanger##**|Insert sample with settings from table
fwilde 60.2 459 |**ss_rem,ove**|
fwilde 59.3 460
fwilde 59.2 461