diff --git a/docs/user/ptychography/flomni.md b/docs/user/ptychography/flomni.md index 560abd0..232af8f 100644 --- a/docs/user/ptychography/flomni.md +++ b/docs/user/ptychography/flomni.md @@ -88,6 +88,14 @@ Depending on the tomo mode following parameters can be given to the `flomni.tomo | Golden ratio tomography (sorted in bunches) | projection_number=None | | Equally spaced with golden starting angle | projection_number=None | +### GUI tools + +During operation the BEC GUI will show the relevant cameras or progress information. To manually switch view TAB completion on 'flomni.flomnigui_' will show all options to control the GUI. Most useful +'flomni.flomnigui_show_cameras()' will show the cameras for sample transfer and interior overview +'flomni.flomnigui_show_progress()' will show the measurement progress GUI +'flomnigui_show_xeyealign()' will show the XrayEye alignment GUI + + ## How to setup flOMNI (software) This part of the manual is intended for beamline staff and expert users @@ -218,9 +226,15 @@ Update the values by, example for feyex and in position, To refresh the frame of the xray eye windows software `flomni.xrayeye_update_frame()` +This command can also be called to keep the shutter open and live view active +`flomni.xrayeye_update_frame(keep_shutter_open=True)` + To start the xray eye alignment (and clear any previous alignment) `flomni.xrayeye_alignment_start()` +This command can also be called to keep the shutter open and live view active. Warning: The dose to the sample will be significantly higher. +`flomni.xrayeye_update_frame(keep_shutter_open=True)` + To load the fit parameters from directory _dir_path_ computed by _SPEC_ptycho_align.m_ in Matlab run `flomni.read_alignment_offset(dir_path='')` The loading routine uses default values for the vertical alignment. This behavior can be changed (e.g. for getting new default values) by the parameter `use_vertical_default_values=False`.