diff --git a/PixelatorControllerSettings.md b/PixelatorControllerSettings.md index db135f4..27c88b3 100644 --- a/PixelatorControllerSettings.md +++ b/PixelatorControllerSettings.md @@ -11,148 +11,150 @@ The file format is [JSON](http://www.json.org/) Every scan creates a hdf5 file. The directory they are stored in is: _base directory/YYYY-mm-dd/_ -**NeXusBaseDirectory**:: -- base directory to save scan files +**NeXusBaseDirectory**::
+ base directory to save scan files - **NeXusLocalBaseDirectory**::
- base directory used when '''Save local''' is active +**NeXusLocalBaseDirectory**::
+ base directory used when **Save local** is active - **defaultSaveLocal**::
- Save local setting on startup.
- "yes": use '''NeXusLocalBaseDirectory''' directory
- anything else: use '''NeXusBaseDirectory''' directory +**defaultSaveLocal**::
+ Save local setting on startup.
+ "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. - NeXusDiscardSubDirectory:: - sub directory for files not archived + **NeXusDiscardSubDirectory**::
+ sub directory for files not archived -The '''''ScanType''_Archive_Default''' options define a default archive flag for each scan type. -They are used when '''''ScanType''_Archive''' is missing. +The **ScanType_Archive_Default** options define a default archive flag for each scan type. +They are used when **ScanType_Archive** is missing. - Sample_Archive_Default:: - Focus_Archive_Default:: - OSA_Archive_Default:: - OSA Focus_Archive_Default:: - Detector_Archive_Default:: - Motor_Archive_Default:: - Motor2D_Archive_Default:: - "yes": files are archived \\ - "no": files are put in the discard sub directory \\ - "locked": as yes, but users cannot toggle the archive flag for this scan type \\ - '''Default''': "locked" + **Sample_Archive_Default**::
+ **Focus_Archive_Default**::
+ **OSA_Archive_Default**::
+ **OSA Focus_Archive_Default**::
+ **Detector_Archive_Default**::
+ **Motor_Archive_Default**::
+ **Motor2D_Archive_Default**::
+ "yes": files are archived
+ "no": files are put in the discard sub directory
+ "locked": as yes, but users cannot toggle the archive flag for this scan type
+ **Default**: "locked" Users can toggle the archive flag for a scan type (unless locked). -When they do so, '''''ScanType''_Archive''' is added or updated. +When they do so, **ScanType_Archive** is added or updated. - Sample_Archive:: - Focus_Archive:: - OSA_Archive:: - OSA Focus_Archive:: - Detector_Archive:: - Motor_Archive:: - Motor2D_Archive:: - "yes": files are archived \\ - "no": files are put in the discard sub directory \\ - '''Default''': '''''ScanType''_Archive_Default''' + Sample_Archive::
+ Focus_Archive::
+ OSA_Archive::
+ OSA Focus_Archive::
+ Detector_Archive::
+ Motor_Archive::
+ Motor2D_Archive::
+ "yes": files are archived
+ "no": files are put in the discard sub directory
+ **Default**: **ScanType_Archive_Default** ### Scan Files The name of the file is: -''ScanType''_''YYYY-mm-dd''_''ScanNumber''.hdf5 +_ScanType_YYYY-mm-dd_ScanNumber_.hdf5 For Sample scans, the spatial type -- _Point -- _Line -- _Image -- _Stack -is added after ''ScanType''. +- _Point_ +- _Line_ +- _Image_ +- _Stack_ + +is added after _ScanType_. ScanNumber is a three digit number, starting with 001 every day. - NeXusScanNumber:: - ScanNumber counter \\ - Updated every time a new scan file is created (beginning of the scan). \\ - '''Default''': 0 +**NeXusScanNumber**::
+ ScanNumber counter
+ Updated every time a new scan file is created (beginning of the scan).
+ **Default**: 0 - compression:: - "LZW": Use LZW compression in hdf5 file \\ - "NONE": No compression \\ - '''Default''': "NONE" + **compression**::
+ "LZW": Use LZW compression in hdf5 file
+ "NONE": No compression
+ **Default**: "NONE" - beamline:: - String value that is written into the scan file at ''/entry*/collection/beamline'' + **beamline**::
+ String value that is written into the scan file at _/entry*/collection/beamline_ ### scripts - changeUserScript:: - name of the script that is run on startup and whenever the user is changed \\ - '''Optional''': no script is run when this setting is missing + **changeUserScript**::
+ name of the script that is run on startup and whenever the user is changed
+ **Optional**: no script is run when this setting is missing - defaultUsername:: - username set on startup + **defaultUsername**::
+ username set on startup - endOfScanScript:: - name of the script that is run on the controller at the end of every scan \\ - '''Optional''': no script is run when this setting is missing + **endOfScanScript**::
+ name of the script that is run on the controller at the end of every scan
+ **Optional**: no script is run when this setting is missing ### ZeroMQ Ports - publisherPort:: - TCP port used to publish messages + **publisherPort**::
+ TCP port used to publish messages - requestPort:: - TCP port used to listen for requests + **requestPort**::
+ TCP port used to listen for requests ### missing data check At the end of a point by point line, some data of asynchronous detectors may be missing. They are read until no more data is missing. - missingDataCheckInterval:: - interval (in seconds) at which missing data is read \\ - '''Default''': 0.1 seconds + **missingDataCheckInterval**::
+ interval (in seconds) at which missing data is read
+ **Default**: 0.1 seconds - missingDataCheckMaxChecks:: - maximum number of times missing data is read - '''Default''': 5 + **missingDataCheckMaxChecks**::
+ maximum number of times missing data is read
+ **Default**: 5 ### settings files names The following settings define the name of additional settings files. Each of these settings files is described in a section below. - axisConfigFileName:: - [#Axis Axis] - controllerConfigFileName:: - [#Controller Controller] + **axisConfigFileName**::
+ [Axis](#Axis) - detectorConfigFileName:: - [#Detector Detector] + **controllerConfigFileName**::
+ [#Controller Controller] - epicsConfigFileName:: - [#Epics Epics] + **detectorConfigFileName**::
+ [Detector](#Detector) - instrumentConfigFileName:: - [#Instrument Instrument] + **epicsConfigFileName**::
+ [Epics](#Epics) - log4cppPropertiesFileName:: - [#Log4cppProperties Log4cpp Properties] + **instrumentConfigFileName**::
+ [Instrument](#Instrument) - microscopeControlConfigFileName:: - [#MicroscopeControl Microscope Control] + **log4cppPropertiesFileName**::
+ [Log4cpp Properties](#Log4cppProperties) - pixelClockConfigFileName:: - [#PixelClock Pixel Clock] + **microscopeControlConfigFileName**::
+ [Microscope Control](#MicroscopeControl) - polarizationConfigFileName:: - [#Polarization Polarization] + **pixelClockConfigFileName**::
+ [Pixel Clock](#PixelClock) - positionerConfigFileName:: - [#Positioner Positioner] + **polarizationConfigFileName**::
+ [Polarization](#Polarization) - topupConfigFileName:: - '''Optional''': no topup handling when this setting is missing or the file cannot be read. \\ - [#Topup Topup] + **positionerConfigFileName**::
+ [Positioner](#Positioner) - zonePlateConfigFileName:: + **topupConfigFileName**::
+ '''Optional''': no topup handling when this setting is missing or the file cannot be read.
+ [Topup](#Topup) + + **zonePlateConfigFileName**:: [#ZonePlate Zone Plate] ## Axis