Table of Contents
Arms a counter device. In the case of a detector, it starts accumulating. This command is similar to count, but without a preset. Since we do not wait for the armed device, the state machine does not become BUSY.
Device is the device to count.
Counts is the number the device is going to count.
sets a counter device Tim device that will timeout after a number of counts reaches Tim counts. If Tim device timeouts, counting will be interrupted and counter Device will be disarmed.
allows to specify the device that will be armed before counting begins. This device will be disarmed after counting is finished.
instructs the server to print values of all counter devices in the system after counting.
See also: CountAndPrint, CT
Performs count using the given counter device followed by printing of values of all counters.
Device is the device to count.
Counts is the number the device is going to count.
sets a counter device Tim device that will timeout after a number of counts reaches Tim counts. If Tim device timeouts, counting will be interrupted and counter Device will be disarmed.
allows to specify the device that will be armed before counting begins. This device will be disarmed after counting is finished.
Writes a single data point to the current data file. This information includes current positions of all devices and values of counters.
The following commands can be used to do manipulations on devices.
Device Action
Device Add
Device Arm
Device Busy
Device Components
Device Configure
Device Destroy
Device Disarm
Device Enable
Device Fix
Device Free
Device GetDirection
Device GetHard
Device GetLimits
Device GetOverhead
Device GetParam
Device GetParent
Device GetPreset
Device GetRaw
Device GetSwitch
Device GetTolerance
Device GetZero
Device MoveHard
Device Preset
Device Read
Device Reset
Device Roi
Device Set
Device SetHard
Device SetLowerLimit
Device SetOverhead
Device SetParam
Device SetProperty
Device SetRaw
Device SetTolerance
Device SetUpperLimit
Device SetZero
Adds a DALI representation of a device. When adding an Alias, the parent device must also be supplied.
Sets the dummy flag for the device. If set, the device will be a dummy.
Determines whether the device is read when busy for status updates. Note that the system will still only check the hardware at most once in BusyUpdate seconds.
Sets the busy polling rate for the device.
Sets the polling rate for the device when idle. Note that only special devices such as environment controllers will be polled when idle.
Sets the tofile attribute on the device. If toFile is set, some output formats, including those used for triple axis instruments, will include the device in the per-point data.
Arms the device. In the case of a counter, it would start counting. In the case of a detector, it would start accumulating. The state machine does not become BUSY.
Pre-calculates positions of devices which will move if a given device moves to a certain position.
Device is the device which will move.
Position is the destination to which the device will move.
Fixes a device. When a device is fixed, it cannot be moved during a scan. When not in a scan, the fixed device can still be moved.
Returns the value of the time overhead, in seconds, constant currently set for the device. If the device is an alias, the overhead for the device which it aliases will be returned.
Adjusts zero of a given device so that its current software position is equal to a specified value.
For a given device sets the hardware to a given value. The zero does not change and the software position will change.
Sets the time overhead constant, in seconds, for a device. The time overhead constant is used to calculate how long scans involving the device will run. If the device is an alias, the overhead for the device which it aliases will be returned.
Performs an increment scan assuming that we count against Monitor and measure the Detector counts.
Device is a device selected for the scan.
Start range is the beginning of the interval in which Device will be moved during the scan.
End range is the end of the interval in which Device will be moved during the scan.
Monitor is the number of monitor counts until which data is gathered at every scan point.
Step is the amount by which Device is to be changed at each scan point.
The following commands can be used to view and modify experiment properties.
Expt Get
Expt Info
Expt Set
Expt SetComment
Expt SetDetails
Expt SetName
Expt SetParticipants
Returns a message with the experiment description including its ID, name, participants, details, and comments.
Changes the experiment ID and clears the name, participants, details, comments, and other experiment-related properties of the instrument such as user directory.
The following commands can be used to manipulate files.
File Copy
File Delete
File Dir
File Get
File Move
Filename is a name ((including special directory)) of the file which content will be retrieved.
Scans a device over a given range to find device position at which maximum intensity is reached. A number of options can be specified to facilitate curve fitting to data and device positioning at the center of the fit.
Device is a device selected for the scan.
Range is the device range centered at current device position. Option -start allows to specify a range using two values Start range and Stop range corresponding to the beginning and end of the range, respectively.
Step size is the length between two adjacent device positions in the scan. The number of points in the scan will be set to Range/Step size.
Counter allows to select Time or Monitor as a device for which Preset counts are measured.
Preset is a duration in seconds (if Time is a counter) or a number of counts (if Monitor is a counter) till which count is performed at every device position.
Monitor allows to select Monitor or Detector as a device which values are used to determine the fit.
allows the range to be supplied using two numeric values Start range and Stop range, for the start and the end points of the interval.
Deprecated replaced by CorrectLattice Calculates d-spacing of the sample as a product of fit result and a given correction. If correction is not specified, 1 is used by default. Use command AcceptLattice to redefine sample lattice parameters using calculated value.
instructs the server to automatically drive the selected device to the position where maximum intensity is reached, after the scan is completed.
specifies tolerance of the target device position. This option can be given only with -accept option.
specifies a valid flipper.
specifies flipper off value.
specifies the function type that will be fitted to the scan data. Possible functions: Gauss, GaussLinear, GaussQuadratic, POLY, POLY0, POLY1, POLY2, POLY3 (0-, 1-, 2-, 3-degree polynomial). By default, Gaussian curve is fitted.
specifies a bragg motor that moves together with the device [Device] with a step size half of that of [Step size].
specifies an hkl position to calculate the peak around. With this option, instead of using the current instrument state as a starting point to rock the specified motor, the system uses the instrument state specified by the hkl coordinates specified.
is a column-separated list of additional scan parameters and values.
FindPeak A3 5 0.1 Time 100 Detector -accept
Performs a scan of angle A3 around its current position. Counts will be measured for 5 degrees in both directions with a step size of 0.1. At each point it will count for 100 seconds and use detector counts to determine the fit. The -accept option causes the instrument to drive A3 to the fitted peak position after the scan is finished.
FindPeak A4 5 0.1 Time 100 Detector -bragg A3 -lattice
Performs a theta-2theta scan and calculates d-spacing using the peak position.
Selected device is not a part of current instrument configuration. Check the spelling of device name. Use Device Add command to add device to the instrument.
For a device used in last FindPeak command, changes zero so that current software position of that device is equal to the fitted peak position.
Fixes or frees a device. When a device is fixed, it cannot be moved as a part of scan. Note that the fixed device can still be moved using move command.
Removes all commands from the stack. Note that execution of the current command is not affected.
Causes the server to wait a given number of seconds before proceeding to the next command.
Time is a number of seconds the system will wait before proceeding to the next command in the queue.
The following commands can be used to view and modify instrument state.
Instrument AddGroupEntry
Instrument DelGroups
Instrument DelGroupEntry
Instrument GetAliases
Instrument GetCounters
Instrument GetEnvs
Instrument GetGroups
Instrument Getmotors
Instrument GetVirtuals
Instrument ListDevices
Instrument ListEnvs
Instrument ListInterfaces
Instrument Print
Instrument ReadZeros
Instrument SetGroup
Instrument Status
Instrument WriteZeros
Adds a specified device to a specific group at a given position. If position is not given, the device will be appended to the end of the group.
Device is a name of the device to be added to the device group.
Group is a name of the group used to define the list of devices.
Returns a list of all available environment controller drivers for this instrument.
Reads the device zeros and limits from a file and applies these values to all devices on the instrument.
Saves zeros and software limits to a file that can later be used to re-align the instrument.
Moves a given device to a specified position. Several devices can be moved in parallel.
Device is a name of a device to be moved.
Position is a value that the selected device will be moved to.
Move A4 56.5
Drives angle A4 to 56.5 degrees. Units of destination are device-specific.
Move A4 2.5 -relative
Drives angle A4 2.5 degrees in a positive direction from its current position.
Move Ei 14.7 Ef 14.8
Moves incident energy to 14.7 meV and final energy to 14.8 meV.
Move HKL [1,0,0]
Drives angles A3 and A4 to Q-vector (1, 0, 0). Note that lattice and orientation parameters and energy transfer are determined by previously executed Sample, Move and Scan commands.
Move Temp 150
Changes temperature to 150 degrees (Kelvin or Celcius depending on the settings of the temperature controller).
Puts the system in the PAUSE state in which currently armed counters will be paused and the user signal to resume will be required to proceed to the next point in the scan or the next command.
Device is a name of the device to be printed.
Angles prints software and hardware positions of all devices.
SoftAngles prints software positions of all devices.
HardAngles prints hardware positions of all devices.
Limits prints limits of all devices.
Zeros prints zero points of all devices.
Counters prints values of all counter devices.
Measures the monitor rate. ICE will store the measured monitor rate and the value of an instrument-specific device (A2 on triple-axes) at the time of the measurement. This command must be executed before estimating the duration of scans or sequences.
Registers a user and stores all relevant information that is later used to determine user permissions.
Estimates the time it will take to run a sequence file. Four command types are assessed for time: Scans, Moves, Counts, and Waits. Scans are assessed using the scan howlong command. Moves are assessed using the overhead for the devices being moved or the overhead provided with the -o option (see below).
The Rate command should be run before running Sequence Howlong if a monitor count is being assessed. If it has not been run when Scan Howlong is run, it will be run automatically before a result is given, unless a scan is in progress, in which case the command will fail.
Filename is the name of a sequence file in the experiment directory. The filename should contain the full extension .seq.txt.
indicates that the results should be returned in seconds (the default is hours).
tells ICE to use the specified overhead as a minimum overhead per point for instrument movement. The overhead is in seconds. If a device is set with a larger overhead, then that overhead will be used.
The following commands can be used to view and modify user settings.
Settings GetDataDir
Settings Print
Settings SetDataDir
Settings SetStatusFreq
Settings SetVerbose
The following commands can be used to do manipulations on command queue.
Stack AppendFile
Stack DeleteID
Stack DeleteIndex
Stack DryRun
Stack Flush
Stack Howlong
Stack Insert
Stack InsertIndex
Stack Move
Filename is a name of the file (including special directory) content of which will be appended to the command queue.
Deletes the command with a given index from the command queue.
This command is deprecated. Use Stack DeleteID instead.
Filename is a name of the file (including special directory) for which content the dry run will be performed.
Clear all commands from the command queue. Note that this will not affect the currently executing command.
Estimates the time it will take to run the commands in the command queue. Four command types are assessed for time: Scans, Moves, Counts, and Waits. Scans are assessed using the scan howlong command. Moves are assessed using the overhead for the devices being moved or the overhead provided with the -o option (see below).
Inserts a command in the command queue so that it will be executed just before the command with a specified ID.
ID is the identifier of the command before which the new command should be inserted.
Command is a command which is to be inserted.
Inserts a given command at a specified index in the command queue.
This command is deprecated. Use Stack Insert instead.
Re-arranges command queue by moving a set of commands to be executed just before the command with a specified ID.
Returns the state of the instrument computer. The state BUSY indicates that the instrument is moving or counting, PAUSE indicates that the instrument was paused by the user, and IDLE indicates that the instrument is awaiting further instructions from the user.
Filename is a file name that includes any special directory path. Filename containing spaces should be enclosed in double quotes ("").
Content is the content of the file enclosed in double quotes ("").
Indicates whether flipper can be set for a specified device. In current implementation, ValidFlipper is true only for Ei and Ef devices.
Prints version information for the ICE server currently running. This information includes Subversion version number, last modification time, and the user who committed the last modification.
Causes the server to wait a given number of seconds before proceeding to the next command.
Time is a number of seconds the system will wait before proceeding to the next command in the queue.