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 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,11 +3,13 @@
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 +=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
10 +
9 9  (% class="wrapped fixed-table" %)
10 10  |=(((
11 11  IDL command
... ... @@ -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_lateral, 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,21 +101,76 @@
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 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 +
119 119  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
120 120  
121 121  (% class="wrapped fixed-table" %)
... ... @@ -127,30 +127,30 @@
127 127  motion
128 128  )))
129 129  |(((
130 -pressure_on
170 +##**o_ccd_dist, 5**##
131 131  )))|(((
132 -enable detector y movement
172 +move detector in y direction relative by 5 mm
133 133  )))|(((
134 -\\
174 +relative [ mm ]
135 135  )))
136 136  |(((
137 -o_ccd_dist, 5
177 +##**goto_o_ccd_dist, 30**##
138 138  )))|(((
139 -move detector in y direction
179 +move detector in y direction absoilute to 30 mm
140 140  )))|(((
141 -relative [ mm ]
181 +\\
142 142  )))
143 143  |(((
144 -pressure_off
184 +##**pos_o_ccd_dist()**##
145 145  )))|(((
146 -disable detector movement
186 +return current of the camera stage distance
147 147  )))|(((
148 148  \\
149 149  )))
150 150  
151 -== {{id name="IDLcheatsheet-Makeimage"/}}Make image ==
191 +== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
152 152  
153 -(% class="wrapped fixed-table" %)
193 +(% class="wrapped" %)
154 154  |=(((
155 155  IDL command
156 156  )))|=(((
... ... @@ -157,35 +157,85 @@
157 157  description
158 158  )))
159 159  |(((
160 -i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
200 +##**slit_oh, rx=1 (rz=1)**##
161 161  )))|(((
162 -make an image & show image & draw box
202 +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 ]
205 +##**slit_oh, rdx=1 (rdz=1)**##
166 166  )))|(((
167 -make an absorption image & show image & draw box
207 +opens oh the slit aperture horizontally (vertically) by 1 mm
168 168  )))
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 +)))
169 169  
170 -== {{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)
171 171  
227 +== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
228 +
172 172  (% class="wrapped fixed-table" %)
173 173  |=(((
174 174  IDL command
175 175  )))|=(((
176 176  description
177 -)))|=(((
178 -motion
179 179  )))
180 180  |(((
181 -calc_dcm_energy, 10000, /set
236 +##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)
237 +**##
182 182  )))|(((
183 -set DCM and undulator to 10 keV
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)**##
184 184  )))|(((
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 +
185 185  \\
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
186 186  )))
187 187  |(((
188 -dcm_pitch, 0.00001
278 +##**dcm_pitch, 0.00001**##
189 189  )))|(((
190 190  move 2nd crystal pitch by 0.00001 deg
191 191  )))|(((
... ... @@ -192,7 +192,7 @@
192 192  relative [ deg ]
193 193  )))
194 194  |(((
195 -goto_dcm_pitch,  -0.03976
285 +##**goto_dcm_pitch,  -0.03976**##
196 196  )))|(((
197 197  move 2nd crystal pitch to -0.03976 deg
198 198  )))|(((
... ... @@ -199,7 +199,7 @@
199 199  absolute [ deg ]
200 200  )))
201 201  |(((
202 -reflex_opt
292 +##**reflex_opt_single**##
203 203  )))|(((
204 204  move 2nd crystal pitch to optimal flux position
205 205  )))|(((
... ... @@ -206,16 +206,108 @@
206 206  \\
207 207  )))
208 208  
209 -== {{id name="IDLcheatsheet-Saveanimageastiff"/}}Save an image as tiff ==
299 +== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
210 210  
211 -(% class="wrapped" %)
301 +(% class="fixed-table wrapped" %)
212 212  |=(((
213 213  IDL command
214 214  )))|=(((
215 -desciption
305 +description
306 +)))|=(((
307 +motion
216 216  )))
217 217  |(((
218 -write_tiff, '/gpfs/current/raw/test.tif', i, /SHORT
310 +##**dmm_x2_rot, 0.001**##
219 219  )))|(((
220 -save i as 16-bit tiff in /gofs/...
312 +move 2nd crystal pitch by 0.00001 deg
313 +)))|(((
314 +relative [ deg ]
221 221  )))
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 -109167004
1 +297508007
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/297508007/IDL cheat sheet