Skip to Content

Changes for page IDL cheat sheet

Last modified by fwilde on 2025/07/15 17:44
From version 4.1
edited by fwilde
on 2018/04/09 10:32
Change comment: There is no comment for this version
To version 51.1
edited by fwilde
on 2023/02/21 18:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,14 @@
1 -This is an overview of the most commonly used commands during a beamtime.
1 +== {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
2 2  
3 -(% class="wrapped" %)
3 +Right-handed coordinate system with y-direction along the x-ray beam.
4 +
5 +[[image:attach:p05_uct.png||width="700"]]
6 +
7 +== {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
8 +
9 +=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10 +
11 +(% class="wrapped fixed-table" %)
4 4  |=(((
5 5  IDL command
6 6  )))|=(((
... ... @@ -9,58 +9,272 @@
9 9  motion
10 10  )))
11 11  |(((
12 -s_stage_x/y/z
20 +##**s_stage_x/z, 1**##
13 13  )))|(((
14 -move rotation stage in x/y/z-direction
22 +move rotation stage in x/z-direction by 1 mm
15 15  )))|(((
16 16  relative [ mm ]
17 17  )))
18 18  |(((
19 -s_pos_x/y/z
27 +##**s_pos_x/y/z, 1**##
20 20  )))|(((
21 -move sample stage in x/y/z-direction
29 +move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
22 22  )))|(((
23 23  relative [ mm ]
24 24  )))
25 25  |(((
26 -s_angle, 90
34 +##**s_pos_lateral, 1**##
27 27  )))|(((
28 -rotate rotation stage by 90 degrees
36 +move sample stage in x-direction by 1 mm, regardless of position of rotation axis
29 29  )))|(((
38 +relative [ mm ]
39 +)))
40 +|(((
41 +##**s_angle, 90**##
42 +)))|(((
43 +rotate sample around z axis
44 +)))|(((
30 30  relative [ deg ]
31 31  )))
47 +
48 +=== {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
49 +
50 +(% class="relative-table wrapped" style="width: 67.0892%;" %)
51 +|=(((
52 +IDL command
53 +)))|=(((
54 +description
55 +)))|=(((
56 +motion
57 +)))
32 32  |(((
33 -goto_s_angle, 0
59 +##**goto_s_stage_x/z, 1**##
34 34  )))|(((
35 -rotation
61 +move rotation stage in x/z-direction to 1 mm
36 36  )))|(((
37 -\\
63 +absolute [ mm ]
38 38  )))
65 +|(((
66 +##**goto_s_pos_x/y/z, 1**##
67 +)))|(((
68 +move sample stage in x/y/z-direction to 1  mm
69 +)))|(((
70 +absolute [ mm ]
71 +)))
72 +|(((
73 +##**goto_s_angle, 90**##
74 +)))|(((
75 +rotate sample around z axis to 90° (**alias command: s_rot**)
76 +)))|(((
77 +absolute [ deg ]
78 +)))
39 39  
40 -(% class="relative-table wrapped" style="width: 52.0982%;" %)
80 +=== {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
81 +
82 +(% class="relative-table wrapped" style="width: 54.0627%;" %)
41 41  |=(((
42 42  IDL command
43 43  )))|=(((
44 44  description
87 +)))
88 +|(((
89 +##**pos_s_stage_x/z()**##
90 +)))|(((
91 +return current rotation stage in x/z position
92 +)))
93 +|(((
94 +##**pos_s_pos_x/y/z()**##
95 +)))|(((
96 +return current sample stage in x/y/z position
97 +)))
98 +|(((
99 +##**pos_s_angle()**##
100 +)))|(((
101 +return current rotation stage angle
102 +)))
103 +
104 +=== {{id name="IDLcheatsheet-Predefinedpositions"/}}Predefined positions ===
105 +
106 +(% class="relative-table wrapped" style="width: 55.721%;" %)
107 +|=(((
108 +IDL command
45 45  )))|=(((
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 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 +
159 +== {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
160 +
161 +(% class="wrapped fixed-table" %)
162 +|=(((
163 +IDL command
164 +)))|=(((
165 +description
166 +)))|=(((
46 46  motion
47 47  )))
48 48  |(((
49 -calc_dcm_energy, 10000, /set
170 +##**o_ccd_dist, 5**##
50 50  )))|(((
51 -set DCM and undulator to 10 keV
172 +move detector in y direction relative by 5 mm
52 52  )))|(((
174 +relative [ mm ]
175 +)))
176 +|(((
177 +##**goto_o_ccd_dist, 30**##
178 +)))|(((
179 +move detector in y direction absoilute to 30 mm
180 +)))|(((
53 53  \\
54 54  )))
55 55  |(((
56 -dcm_pitch, 0.00001
184 +##**pos_o_ccd_dist()**##
57 57  )))|(((
186 +return current of the camera stage distance
187 +)))|(((
188 +\\
189 +)))
190 +
191 +== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
192 +
193 +(% class="wrapped" %)
194 +|=(((
195 +IDL command
196 +)))|=(((
197 +description
198 +)))
199 +|(((
200 +##**slit_oh, rx=1 (rz=1)**##
201 +)))|(((
202 +moves oh slit aperture horizontally (vertically) by 1mm
203 +)))
204 +|(((
205 +##**slit_oh, rdx=1 (rdz=1)**##
206 +)))|(((
207 +opens oh the slit aperture horizontally (vertically) by 1 mm
208 +)))
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 +)))
224 +
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)
226 +
227 +== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
228 +
229 +(% class="wrapped fixed-table" %)
230 +|=(((
231 +IDL command
232 +)))|=(((
233 +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 +\\
258 +
259 +\\
260 +
261 +{{info title="Monochromator positioning"}}
262 +ATTENTION: Setting up a Monochromator as well as positioning front end slits is **only** done by the beamline staff!
263 +
264 +The commands above may be used by users to realign the beam should it beam profile drift with time.
265 +{{/info}}
266 +
267 +== {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
268 +
269 +(% class="wrapped fixed-table" %)
270 +|=(((
271 +IDL command
272 +)))|=(((
273 +description
274 +)))|=(((
275 +motion
276 +)))
277 +|(((
278 +##**dcm_pitch, 0.00001**##
279 +)))|(((
58 58  move 2nd crystal pitch by 0.00001 deg
59 59  )))|(((
60 60  relative [ deg ]
61 61  )))
62 62  |(((
63 -goto_dcm_pitch,  -0.03976
285 +##**goto_dcm_pitch,  -0.03976**##
64 64  )))|(((
65 65  move 2nd crystal pitch to -0.03976 deg
66 66  )))|(((
... ... @@ -67,9 +67,115 @@
67 67  absolute [ deg ]
68 68  )))
69 69  |(((
70 -reflex_opt
292 +##**reflex_opt_single**##
71 71  )))|(((
72 72  move 2nd crystal pitch to optimal flux position
73 73  )))|(((
74 74  \\
75 75  )))
298 +
299 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
300 +
301 +(% class="fixed-table wrapped" %)
302 +|=(((
303 +IDL command
304 +)))|=(((
305 +description
306 +)))|=(((
307 +motion
308 +)))
309 +|(((
310 +##**dmm_x2_rot, 0.001**##
311 +)))|(((
312 +move 2nd crystal pitch by 0.00001 deg
313 +)))|(((
314 +relative [ deg ]
315 +)))
316 +|(((
317 +##**goto_dmm_x2_rot,  0.8923
318 +**##
319 +)))|(((
320 +move 2nd crystal pitch to 0.8923 deg
321 +)))|(((
322 +absolute [ deg ]
323 +)))
324 +
325 +\\
326 +
327 +== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
328 +
329 +(% class="wrapped relative-table" style="width: 45.5603%;" %)
330 +|=(((
331 +Functionality
332 +)))|=(((
333 +IDL syntax
334 +)))
335 +|(((
336 +chaining commands
337 +)))|(((
338 +command_1 **&** command_2 **&** ...
339 +)))
340 +|(((
341 +absolute movement
342 +)))|(((
343 +**goto_**//motor//, position
344 +)))
345 +|(((
346 +relative movement
347 +)))|(((
348 +//motor//, position
349 +)))
350 +|(((
351 +current motor position
352 +)))|(((
353 +**pos_**//motor//()
354 +)))
355 +
356 +== {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
357 +
358 +(% class="wrapped relative-table" style="width: 75.0455%;" %)
359 +|=(((
360 +IDL command
361 +)))|=(((
362 +description
363 +)))
364 +|(((
365 +##**bs_info**##
366 +)))|(((
367 +prints an overview of the beamline beamshutter status
368 +)))
369 +|(((
370 +##**bsoh_open / bsoh_close**##
371 +)))|(((
372 +opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
373 +)))
374 +|(((
375 +##**bseh1_open / bseh1_close**##
376 +)))|(((
377 +opens / closes the EH1 beamshutter. Opening will open the OH beamshutter as well. Closing the OH beamshutter will the EH2 beamshutter as well
378 +)))
379 +|(((
380 +##**bseh2_open / bseh2_close**##
381 +)))|(((
382 +opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
383 +)))
384 +|(((
385 +##**ics_info**##
386 +)))|(((
387 +prints an overview of the beamline interlock status
388 +)))
389 +|(((
390 +##**oh_break_ics**##
391 +)))|(((
392 +closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
393 +)))
394 +|(((
395 +##**eh1_break_ics**##
396 +)))|(((
397 +closes EH1 beamshutter (and EH2 beamshutter  if open) and breaks EH1 door interlock
398 +)))
399 +|(((
400 +##**eh2_break_ics**##
401 +)))|(((
402 +closes EH2 beshutter and breaks EH2 door interlock
403 +)))
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -92838481
1 +297508007
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/P5I/pages/92838481/IDL cheat sheet
1 +https://confluence.desy.de/spaces/P5I/pages/297508007/IDL cheat sheet