| 1 |
Online mode |
| 2 |
=========== |
| 3 |
|
| 4 |
**WARNING:** The manual is current several versions out of date. While it may |
| 5 |
still be useful for some users, please refer to the tutorial for the most |
| 6 |
up-to-date information. |
| 7 |
|
| 8 |
.. _onlinemode: |
| 9 |
|
| 10 |
RAW has an online mode that will watch a folder, and automatically load any |
| 11 |
files placed in the folder that RAW can read. This is typically used to |
| 12 |
automatically load in data as it is being collected at the beamline. This |
| 13 |
is distinct from the :ref:`automatic update feature <secautoupdate>` of the |
| 14 |
SEC Control panel, and both features can be active at once. |
| 15 |
|
| 16 |
|
| 17 |
Turning on/off online mode |
| 18 |
-------------------------- |
| 19 |
|
| 20 |
In order to turn on online mode, go to the Options->Online Mode menu and |
| 21 |
click the “Online” option. When you go online, a file browser will open |
| 22 |
and you will pick a folder. This folder (and only this folder, online mode |
| 23 |
does not recurse into subfolders) will be monitored by RAW. Every time a |
| 24 |
file is added (or updated) in the folder, RAW checks to see whether it can |
| 25 |
load the file. If it can, it will be loaded into RAW (for example, detector |
| 26 |
images will be integrated and loaded into the Manipulation panel and Main plot). |
| 27 |
|
| 28 |
To disable online mode, go to the Options->Online Mode menu and click the “Offline” option. |
| 29 |
|
| 30 |
**Note:** The online status of RAW is indicated in the status bar at the bottom of the |
| 31 |
main RAW window. On the right side, it says “Mode: <status>” where <status> is OFFLINE |
| 32 |
or ONLINE. This is only toggled by this online mode, not the automatic update feature of |
| 33 |
the SEC panel. |
| 34 |
|
| 35 |
|
| 36 |
Changing directories in online mode |
| 37 |
----------------------------------- |
| 38 |
|
| 39 |
If you wish to change the directory that RAW is monitoring in online mode, go |
| 40 |
to the Options->Online Mode menu and click the “Change Directory” option. A file |
| 41 |
browser will appear, and you will use that to select the new folder for the Online mode. |
| 42 |
|
| 43 |
|
| 44 |
Online mode filter |
| 45 |
------------------ |
| 46 |
|
| 47 |
In some cases, you may not want every file that enters the directory (that can be read |
| 48 |
by RAW) to be loaded into RAW. In this case, it is possible to set a filter so that |
| 49 |
only certainly files can be loaded into RAW. The filter can consist of any number of |
| 50 |
individual items, which are set as follows. First, chose whether an item is include (open |
| 51 |
only if) or exclude (don’t open if). Then provide a string for RAW to match in the file name. |
| 52 |
Then specify where in the filename RAW should match the string (start, end, anywhere). This |
| 53 |
filter can be set in the :ref:`options window <onlinefilter>`. |
| 54 |
|