MicroSpectro/Pixelator
Private
Public Access
11
1
Wiki

Update PixelatorControllerSettings

watts
2022-10-06 17:23:06 +02:00
parent 59f9f825b7
commit 7f18fe6d08
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
PixelatorControllerSettings.md

@@ -5,6 +5,8 @@ one section per file.
The file format is [JSON](http://www.json.org/)
Some options affect data recorded in the HDF5 files produced by Pixelator scans, which are based on the [NXstxm](https://doi.org/10.1063/1.4937536) application definition of the [NeXus](https://www.nexusformat.org/) data format.
# Settings
## Scan Files: Directory
@@ -87,7 +89,7 @@ ScanNumber is a three digit number, starting with 001 every day.
### scripts
**changeUserScript**::<BR>
&emsp;name of the script that is run on startup and whenever the user is changed<BR>
&emsp;name of the script that is run on startup and whenever the user is changed (not really used yet - placeholder for future features)<BR>
&emsp;**Optional**: no script is run when this setting is missing
**defaultUsername**::<BR>
@@ -197,8 +199,7 @@ See source: trunk/PixelatorController/config/epics.json for an example.
## Instrument
This file defines the content of the NXinstrument group of the scan file (hdf5).
It is a json object with as many entries as needed. One group is made inside the NXinstrument group
per entry of this settings file, with the key used as group name.
It is a json object with as many entries as needed. One group is made inside the NXinstrument group per entry of this settings file, with the key used as group name.
See source:trunk/PixelatorController/config/instrument.json for an example.
@@ -347,27 +348,27 @@ The following settings are available for all types of positioners:
&emsp;**Default**: "n"
**positionOffset**::<BR>
&emsp;Double value defines . <BR>
&emsp;Double value defines shift of coordinates between those communicated with the hardware controller and the user. <BR>
&emsp;**Default**: 0.0
**upperSoftLimit**::<BR>
&emsp;Double value defines . <BR>
&emsp;Double value defines largest value allowed to be requested to move to. <BR>
&emsp;**Default**: 0.0
**lowerSoftLimit**::<BR>
&emsp;Double value defines .<BR>
&emsp;Double value defines lowest value allowed to be requested to move to.<BR>
&emsp;**Default**: 0.0
**coarsePositioner**::<BR>
&emsp;String value defines .<BR>
&emsp;String value defines cooperating positioner that will handle large movements.<BR>
&emsp;**Default**: "" (empty string)
**finePositioner**::<BR>
&emsp;String value defines .<BR>
&emsp;String value defines cooperating positioner that will handle fine movements.<BR>
&emsp;**Default**: "" (empty string)
**maxVelocity**::<BR>
&emsp;Double value defines . <BR>
&emsp;Double value defines maximum rate of movement. <BR>
&emsp;**Default**: 0.0
**readOnly**::<BR>
@@ -397,7 +398,7 @@ The following settings are available for all types of positioners:
**beamlineControlPosition**::<BR>
&emsp;Unsigned integer value defines . <BR>
&emsp;Unsigned integer value defines inclusion of (value greater than zero), and position of a positioner control in the GUI. <BR>
&emsp;**Default**: 0
**epsilon**::<BR>