From 65bddefa04dd2826e4407ced0f960724e93d33cb Mon Sep 17 00:00:00 2001 From: watts Date: Wed, 26 Oct 2022 11:20:36 +0200 Subject: [PATCH] Update PixelatorControllerSettings --- PixelatorControllerSettings.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/PixelatorControllerSettings.md b/PixelatorControllerSettings.md index 7bc3240..b07c2ed 100644 --- a/PixelatorControllerSettings.md +++ b/PixelatorControllerSettings.md @@ -10,7 +10,7 @@ Some options affect data recorded in the HDF5 files produced by Pixelator scans, # Settings ## Scan Files: Directory -Every scan creates a hdf5 file. The directory they are stored in is: +Every scan creates an hdf5 file. Thus, all scan data is recorded and the following parameters indicate where the scan file is written. The directory that the scan files are stored in is: _base directory/YYYY-mm-dd/_ **NeXusBaseDirectory**::
@@ -24,9 +24,7 @@ _base directory/YYYY-mm-dd/_  "yes": use **NeXusLocalBaseDirectory** directory
 anything else: use **NeXusBaseDirectory** directory -Depending on the scan type, the files are archived or not. -The archived ones are put in that date directory. -The others in a discard sub directory of the date directory. +Files are initially written to a "discard" subdirectory. Once the scan has completed, the file may be moved out of this subdirectory if the scan type is set to be "archived". **NeXusDiscardSubDirectory**::
 Sub directory for files not archived. A scan in progress is recorded into a file in this subdirectory and then may be moved to the parent directory, depending on the ScanType_Archive status (see below). @@ -41,8 +39,8 @@ They are used when **ScanType_Archive** is missing. **Detector_Archive_Default**::
**Motor_Archive_Default**::
**Motor2D_Archive_Default**::
- "yes": files are archived
- "no": files are put in the discard sub directory
+ "yes": files are archived (moved out of the "discard" subdirectory)
+ "no": files are left in the "discard" subdirectory
 "locked": as yes, but users cannot toggle the archive flag for this scan type
 **Default**: "locked" @@ -106,7 +104,7 @@ ScanNumber is a three digit number, starting with 001 every day. ### ZeroMQ Ports **publisherPort**::
- TCP port used to publish messages + TCP port used by _PixelatorController_ to publish messages to the various user interfaces, e.g. _PixelatorGUI_ **requestPort**::
 TCP port used to listen for requests