Changes for page IDL cheat sheet

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

From 27.1 to 28.1 From 57.1 to 58.1

From version 28.1

edited by fwilde
on 2018/12/18 12:09

Change comment: There is no comment for this version

To version 57.1

edited by fwilde
on 2024/06/13 14:51

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -1,15 +1,13 @@
--This is an overview of the most commonly used commands during a beamtime.
++== {{id name="IDLcheatsheet-eCoordinatesystem"/}}eCoordinate system ==
--== {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
--
  Right-handed coordinate system with y-direction along the x-ray beam.
--\\
--
  [[image:attach:p05_uct.png||width="700"]]
  == {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
++=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
++
  (% class="wrapped fixed-table" %)
  |=(((
  IDL command
@@ -19,7 +19,7 @@
  motion
  )))
  |(((
--s_stage_x/z, 1
++##**s_stage_x/z, 1**##
  )))|(((
  move rotation stage in x/z-direction by 1 mm
  )))|(((
@@ -26,14 +26,14 @@
  relative [ mm ]
  )))
  |(((
--s_pos_z, 1
++##**s_pos_x/y/z, 1**##
  )))|(((
--move sample stage in z-direction by 1 mm,
++move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
  )))|(((
  relative [ mm ]
  )))
  |(((
--s_pos_lateral, 1
++##**s_pos, 1**##
  )))|(((
  move sample stage in x-direction by 1 mm, regardless of position of rotation axis
  )))|(((
@@ -40,39 +40,16 @@
  relative [ mm ]
  )))
  |(((
--s_angle, 90
++##**s_angle, 90**##
  )))|(((
  rotate sample around z axis
  )))|(((
  relative [ deg ]
  )))
--|(((
--s_in
--)))|(((
--move sample to "in" position
--)))|(((
--predefined
--)))
--|(((
--s_out
--)))|(((
--move sample to "out" position
--)))|(((
--predefined
--)))
--|(((
--s_change
--)))|(((
--move sample to "change" position
--)))|(((
--predefined
--)))
--\\
++=== {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
--\\
--
--(% class="relative-table wrapped" style="width: 63.2385%;" %)
++(% class="relative-table wrapped" style="width: 67.0892%;" %)
  |=(((
  IDL command
  )))|=(((
@@ -81,7 +81,7 @@
  motion
  )))
  |(((
--goto_s_stage_x/z, 1
++##**goto_s_stage_x/z, 1**##
  )))|(((
  move rotation stage in x/z-direction to 1 mm
  )))|(((
@@ -88,7 +88,7 @@
  absolute [ mm ]
  )))
  |(((
--goto_s_pos_x/y/z, 1
++##**goto_s_pos_x/y/z, 1**##
  )))|(((
  move sample stage in x/y/z-direction to 1  mm
  )))|(((
@@ -95,14 +95,16 @@
  absolute [ mm ]
  )))
  |(((
--goto_s_angle, 90
++##**goto_s_angle, 90**##
  )))|(((
--rotate sample around z axis to 90°
++rotate sample around z axis to 90° (**alias command: s_rot**)
  )))|(((
  absolute [ deg ]
  )))
--(% class="relative-table wrapped" style="width: 51.477%;" %)
++=== {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
++
++(% class="relative-table wrapped" style="width: 54.0627%;" %)
  |=(((
  IDL command
  )))|=(((
@@ -109,21 +109,76 @@
  description
  )))
  |(((
--pos_s_stage_x/z()
++##**pos_s_stage_x/z()**##
  )))|(((
  return current rotation stage in x/z position
  )))
  |(((
--pos_s_pos_x/y/z()
++##**pos_s_pos_x/y/z()**##
  )))|(((
  return current sample stage in x/y/z position
  )))
  |(((
--pos_s_angle()
++##**pos_s_angle()**##
  )))|(((
  return current rotation stage angle
  )))
++=== {{id name="IDLcheatsheet-Predefinedpositions"/}}Predefined positions ===
++
++(% class="relative-table wrapped" style="width: 55.721%;" %)
++|=(((
++IDL command
++)))|=(((
++description
++)))
++|(((
++##**s_in**##
++)))|(((
++move sample to "in" position
++)))
++|(((
++##**s_out**##
++)))|(((
++move sample to "out" position
++)))
++|(((
++##**s_change**##
++)))|(((
++move sample to "change" position
++)))
++|(((
++##**set_s_in_pos(, 0)**##
++)))|(((
++set s_in position to current stage position, or optionally to e.g. 0.0 mm
++)))
++|(((
++##**set_s_out_dist, 10**##
++)))|(((
++set s_out distance to 10.0 mm
++)))
++
++=== {{id name="IDLcheatsheet-Magnificationsets"/}}Magnification sets ===
++
++(% class="wrapped" %)
++|=(((
++IDL command
++)))|=(((
++description
++)))
++|(((
++##**save_magn_set(, name_add)
++**##
++)))|(((
++save current magnification set, optionally add something to the automatically generated name
++)))
++|(((
++##**restore_magn_set(, name)
++**##
++)))|(((
++restore last magnification set, or optionally load a file with a specific name
++)))
++
  == {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
  (% class="wrapped fixed-table" %)
@@ -135,30 +135,30 @@
  motion
  )))
  |(((
--pressure_on
++##**o_ccd_dist, 5**##
  )))|(((
--enable detector y movement
++move detector in y direction relative by 5 mm
  )))|(((
--\\
++relative [ mm ]
  )))
  |(((
--o_ccd_dist, 5
++##**goto_o_ccd_dist, 30**##
  )))|(((
--move detector in y direction
++move detector in y direction absoilute to 30 mm
  )))|(((
--relative [ mm ]
++\\
  )))
  |(((
--pressure_off
++##**pos_o_ccd_dist()**##
  )))|(((
--disable detector movement
++return current of the camera stage distance
  )))|(((
  \\
  )))
--== {{id name="IDLcheatsheet-Makeimage"/}}Make image ==
++== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
--(% class="wrapped fixed-table" %)
++(% class="wrapped" %)
  |=(((
  IDL command
  )))|=(((
@@ -165,35 +165,136 @@
  description
  )))
  |(((
--i=quick(100) & tv_quick, i & draw_box, [ x1, x2 ,z1 ,z2 ]
++##**slit_oh, rx=1 (rz=1)**##
  )))|(((
--make an image & show image & draw box
++moves oh slit aperture horizontally (vertically) by 1mm
  )))
  |(((
--a=quick_abs(100) & tv_quick, a & draw_box, [ x1, x2 ,z1 ,z2 ]
++##**slit_oh, rdx=1 (rdz=1)**##
  )))|(((
--make an absorption image & show image & draw box
++opens oh the slit aperture horizontally (vertically) by 1 mm
  )))
++|(((
++##**slit_eh2, rx=1 (rz=1)**##
++)))|(((
++moves eh2 slit aperture horizontally (vertically) by 1 mm
++)))
++|(((
++##**slit_eh2, rdx=1 (rdz=1)**##
++)))|(((
++opens eh2 the slit aperture horizontally (vertically) by 1 mm
++)))
++|(((
++##**slit_info**##
++)))|(((
++show all slit positions
++)))
--== {{id name="IDLcheatsheet-Monochromatorpositioning"/}}Monochromator positioning ==
++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)
++== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
++
  (% class="wrapped fixed-table" %)
  |=(((
  IDL command
  )))|=(((
  description
++)))
++|(((
++##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)
++**##
++)))|(((
++make an image & scale image (eg. from 0 to 4096, usually from 0 to maximum value the camera can do)
++)))
++|(((
++##**a=quick_abs(100) & display_image, BYTSCL(a, 0, 2)**##
++)))|(((
++make an absorption image & scale image (usually from 0 to to 2)
++)))
++|(((
++##**write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT**##
++)))|(((
++save i as 16-bit integer tiff in /gpfs/...
++)))
++|(((
++##**write_tiff, '/gpfs/current/raw/test_absorption.tif', a, /FLOAT**##
++)))|(((
++save a as 32-bit float tiff in /gpfs/...
++)))
++
++== {{id name="IDLcheatsheet-Macrosmotion+images"/}}Macros motion  + images ==
++
++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.**
++
++(% class="relative-table wrapped" style="width: 114.69%;" %)
++|=(((
++IDL command
  )))|=(((
--motion
++description
  )))
  |(((
--calc_dcm_energy, 10000, /set
++**{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}**
  )))|(((
--set DCM and undulator to 10 keV
++Quick **transmission** image at the current position. Options: set new exposure time, set new scale for image display,
++)))
++|(((
++**{{code language="none"}}qa (, t=100, scale=[0,2], /ref, /here){{/code}}**
  )))|(((
++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.
++)))
++|(((
++**{{code language="none"}}qp (, t=100, scale=[0,2], /ref, /here){{/code}}**
++)))|(((
++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
++)))
++|(((
++**{{code language="none"}}qr (, t=100, scale=[0,4096]){{/code}}
++**
++)))|(((
++Quick **reference image**. Options: set new exposure time,  set new scale for image display,
++)))
++|(((
++**{{code language="none"}}side, 90 (, t=100, /ref, /rel, /here, imgtype='a') {{/code}}**
++)))|(((
++**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)
++)))
++|(((
++**{{code language="none"}}sshift, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}**
++)))|(((
++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)
++)))
++|(((
++##**sz, 2 (, t=100, /ref, /here, imgtype='a')**##
++)))|(((
++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)
++)))
++|(((
++**{{code language="none"}}zx, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}
++**
++)))|(((
++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)
++)))
++
  \\
++
++{{info title="Monochromator positioning"}}
++ATTENTION: Setting up a Monochromator as well as positioning front end slits is **only** done by the beamline staff!
++
++The commands above may be used by users to realign the beam should it beam profile drift with time.
++{{/info}}
++
++== {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
++
++(% class="wrapped fixed-table" %)
++|=(((
++IDL command
++)))|=(((
++description
++)))|=(((
++motion
  )))
  |(((
--dcm_pitch, 0.00001
++##**dcm_pitch, 0.00001**##
  )))|(((
  move 2nd crystal pitch by 0.00001 deg
  )))|(((
@@ -200,7 +200,7 @@
  relative [ deg ]
  )))
  |(((
--goto_dcm_pitch,  -0.03976
++##**goto_dcm_pitch,  -0.03976**##
  )))|(((
  move 2nd crystal pitch to -0.03976 deg
  )))|(((
@@ -207,37 +207,44 @@
  absolute [ deg ]
  )))
  |(((
--reflex_opt
++##**reflex_opt_single**##
  )))|(((
  move 2nd crystal pitch to optimal flux position
  )))|(((
  \\
  )))
--|(((
--gap, 0.01
--)))|(((
--move undulator gap by 0.01 mm
--)))|(((
--relative [ mm ]
--)))
--== {{id name="IDLcheatsheet-Saveanimageastiff"/}}Save an image as tiff ==
++== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
--(% class="wrapped relative-table" style="width: 60.1204%;" %)
++(% class="fixed-table wrapped" %)
  |=(((
  IDL command
  )))|=(((
--desciption
++description
++)))|=(((
++motion
  )))
  |(((
--write_tiff, '/gpfs/current/raw/test.tif', i, /SHORT
++##**dmm_x2_rot, 0.001**##
  )))|(((
--save i as 16-bit tiff in /gofs/...
++move 2nd crystal pitch by 0.00001 deg
++)))|(((
++relative [ deg ]
  )))
++|(((
++##**goto_dmm_x2_rot,  0.8923
++**##
++)))|(((
++move 2nd crystal pitch to 0.8923 deg
++)))|(((
++absolute [ deg ]
++)))
--== {{id name="IDLcheatsheet-Generalremarks"/}}General remarks ==
++\\
--(% class="wrapped relative-table" style="width: 51.5317%;" %)
++== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
++
++(% class="wrapped relative-table" style="width: 45.5603%;" %)
  |=(((
  Functionality
  )))|=(((
@@ -244,7 +244,7 @@
  IDL syntax
  )))
  |(((
--Chaining commands
++chaining commands
  )))|(((
  command_1 **&** command_2 **&** ...
  )))
@@ -263,3 +263,103 @@
  )))|(((
  **pos_**//motor//()
  )))
++
++== {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
++
++(% class="wrapped relative-table" style="width: 75.0455%;" %)
++|=(((
++IDL command
++)))|=(((
++description
++)))
++|(((
++##**bs_info**##
++)))|(((
++prints an overview of the beamline beamshutter status
++)))
++|(((
++##**bsoh_open / bsoh_close**##
++)))|(((
++opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
++)))
++|(((
++##**bseh1_open / bseh1_close**##
++)))|(((
++opens / closes the EH1 beamshutter. Opening will open the OH beamshutter as well. Closing the OH beamshutter will the EH2 beamshutter as well
++)))
++|(((
++##**bseh2_open / bseh2_close**##
++)))|(((
++opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
++)))
++|(((
++##**ics_info**##
++)))|(((
++prints an overview of the beamline interlock status
++)))
++|(((
++##**oh_break_ics**##
++)))|(((
++closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
++)))
++|(((
++##**eh1_break_ics**##
++)))|(((
++closes EH1 beamshutter (and EH2 beamshutter  if open) and breaks EH1 door interlock
++)))
++|(((
++##**eh2_break_ics**##
++)))|(((
++closes EH2 beshutter and breaks EH2 door interlock
++)))
++
++== {{id name="IDLcheatsheet-Helpermacros"/}}Helper macros ==
++
++The helper macros may help to align a sample quickly. Mainly, these are motion commands which subsequently make an image with predefined values.
++
++(% class="wrapped" %)
++|=(((
++IDL command
++)))|=(((
++description
++)))
++|(((
++helper_object, /info
++)))|(((
++show predefined values
++)))
++|(((
++\\
++)))|(((
++\\
++)))
++|(((
++\\
++)))|(((
++\\
++)))
++|(((
++\\
++)))|(((
++\\
++)))
++|(((
++\\
++)))|(((
++\\
++)))
++|(((
++\\
++)))|(((
++\\
++)))
++|(((
++\\
++)))|(((
++\\
++)))
++|(((
++\\
++)))|(((
++\\
++)))

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--116602080
++365835135

URL

@@ -1,1 +1,1 @@
--https://confluence.desy.de/spaces/P5I/pages/116602080/IDL cheat sheet
++https://confluence.desy.de/spaces/P5I/pages/365835135/IDL cheat sheet

Changes for page IDL cheat sheet

Summary

Details

Applications

Navigation