Table of Contents
The Change Experiment Panel is designed to start a new experiment with a given experiment ID. This ID would override the ID which was loaded by ICE on startup. Depending on the instrument, administrator rights may be required to change experiment.
Proposal ID
The purpose of the proposal ID is to associate a unique identifier with a new experiment. A text field is used to enter the proposal ID. This value must be a positive number (for BT7 and MACS) or a string without spaces and special characters (for NG3 and NG7).
Ok
Selecting the "Ok" button allows the user to start a new experiment with the given value entered for the proposal ID. A directory is also created for all of the experiments files. Use Experiment Configuration( Sample Environment, Experiment Details, Device Details) window to change other experiment-related information.
Cancel
The "Cancel" button closes the Change Experiment Panel with no changes to the proposal ID.
The Console panel allows you to directly interact with the server by typing commands and directly viewing the server's responses.
The console panel gives a summary of the instrument status at the top, text display of server communications in the middle of the panel, and an Input box to send commands directly to the server at the bottom.
Text in the tabs can be copied and pasted into the Input box using key commands (Ctrl-C for copyl Ctrl-V for paste).
Components of the Console Panel
Instrument Status. This section lists key aspects of the state of the instrument.
Instrument Status. Gives the name of the instrument and its current status.
Current Experiment. Gives the number set for the current experiment.
Current Operation. Gives the operation currently being run by the server.
Instrument Time. Gives the current value for server time.
Scan Progress. If a scan is being run, this status bar gives the progress. Otherwise, it will have a message indicating that there is no scan running.
Server Communications. A tabbed display gives access to the three types of server communication which can be monitored in this panel. When a new message arrives in one of the tabs which is not active, its text will turn red to indicate that there is new information available.
Log Messages. This tab shows the commands sent to the server and responses from the server.
Dry Run Results. This tab shows the information sent from the server describing a dry run of a scan.
Detailed Error Messages. This tab shows the error messages send by the server.
Server Commands. Send commands to the server by typing them into the Input box and hitting ENTER.
The control panel is displayed to the user after the client establishes connection to the server. Having the panel at a fixed location on the screen allows users to stop, pause, and resume operations on the instrument immediately when commanded to.
Stop Button
The stop button allows users to stop all operations currently being performed on the instrument.
Pause Button
The pause button allows users to pause all operations currently being performed on the instrument. Clicking the pause button enables the play button.
Play Button
The play button allows users to continue all operations that were going to be performed on the instrument. Clicking the play button enables the pause button.
Information Bar
The information bar displays to users the current state of the instrument. The states displayed include pause, idle, and busy.
The Device Details Panel is located within the Experiment Configuration Window. This panel is one of the 3 tabs composing the Experiment Configuration Window. The Add/Remove Devices sub-panel allows users to add and remove devices. The Software Limits sub-panel allows users to set the lower and upper limits of devices. The Instrument Specifics panel allows users to set the properties of the instrument.
Add/Remove Devices
The add device text field is used to enter the device name.
The alias text field is used to enter the alias name for the device you want to add.
Clicking the add button, the system adds the device and it's alias to the system.
The installed devices text field is used to enter the name of the device you want to remove.
The installed devices text area is used to display the devices currently on the system.
Clicking the remove button, the selected device is removed from system.
Software Limits
The device drop down menu allows users to select a device. When a device is selected the lower and upper limits values are displayed.
The lower limit text field is used to change the lower limit value for the selected device.
The upper limit text field is used to change the upper limit value for the selected device.
Clicking the reset button changes the upper and lower limit textfields back to the current limits.
Clicking the apply button sets the upper and lower limits of the selected device to the values in the field.
Instrument Specifics
The monochromator drop down menu allows users to select the monochromator of the instrument. This is a required field.
The Analyzer drop down menu allows users to select the analyzer of the instrument. This is a required field.
The filter mode drop down menu allows users to select whether the instrument is filtered in or out. The filter mode is represented as a device. When a user selects in, the device is moved to the in state and filters neutrons.
The premonochromator collimator drop down menu allows users to select the time it takes to adjust the premonochromator collimator.
The postmonochromator collimator drop down menu allows users to select the time it takes to adjust the postmonochromator collimator. This is a required field.
The preanalyzer collimator drop down menu allows users to select the time it takes to adjust the preanalyzer collimator. This is a required field.
The postanalyzer collimator drop down menu allows users to select the time it takes to adjust the postanalyzer collimator. This is a required field.
The back slit width text field allows users to enter a value to set the back slit width of the instrument. This is a required field.
The back slit height text field allows users to enter a value to set the back slit height of the instrument. This is a required field.
The sample slit width text field allows users to enter a value to set the sample slit width of the instrument. This is a required field.
The sample slit height text field allows users to enter a value to set the back slit height of the instrument. This is a required field.
OK
The OK button saves any changes made to the device details panel and exits the experiment configuration window.
Cancel
The Cancel button does not save any changes made to the device details panel and exits the experiment configuration window.
The Device Status panel allows a user to directly view the values associated with devices on an instrument.
Panel Columns
Device Icons. : Icons representing devices are generally a letter inside a colored circle. The letter represents the type of the device and the color represents the status of the device.
M. Motor
V. Virtual Device – these are non-physical devices which may map to values on multiple other devices. Moving a virtual device will usually also move one or more other devices.
S.
?
Blue Circle. This represents a device or section that organizes devices heirarchically. Clicking on the blue icon will hide or display the devices.
Green Circle. The device is currently moving
Orange Circle. The device is not currently moving
Device Name. Name of device.
Current Position. The last reported position of the device.
Customizing the Device Status Panel.
The instruments shown in the device status panel can be customized using the Edit->Customize menu option, which will bring up the Customized Layout window, as shown above.
The list on the left is the list of devices shown in the Device Status Window. This list on the right is the list of all devices on the instrument. Multiple items can be selected in either list by holding down the Control key while selecting.
Adding Devices. To add devices to the Device Status Window, select devices to be added from the list on the right, labeled "All Devices." Click the Add button to add them to the "Current" list, which is the list of devices which will be displayed.
Removing Devices. To remove devices from the Device Status Window, select those devices which you wish to remove from the "Current" list on the left. Click the Remove button to remove them from the list
Changing the order of Devices. To move a device up or down in the list of displayed devices, click the item and click the "Move Up" or "Move Down" buttons to move it up or down in the list, respectively.
The Experiment Configuration Window contains the Experiment Details, Device Details, and Sample Environment panel. The Sample Environment panel is used to add, remove, and update environment devices to the system. The Experiment Details panel is used to configure the experiment information. The Device Details panel is used to add and remove device, define software limits for devices, and define instrument specifics.
Sample Environment
Experiment Details
Device Details
The Experiment Details Panel is located within the Experiment Configuration Window. This panel is one of the 3 tabs composing the Experiment Configuration Window. This panel allows users to define the name, participants, details, and comments of an experiment. These items are initially clear when ICE is started and must be defined before an experiment can start.
Experiment Name
The Experiment Name text field is used to enter an experiment name to associate the current experiment with. This is a required field.
Participants
The Participants text field is used to enter the names of participants the current experiment will have. This is a required field.
Experiment Details
The Experiment Details text area is used to enter the details of the current experiment. This is a required field.
Comments
The Comments text area is used to enter any additional information for the current experiment.
OK
The OK button saves any changes made to the experiment details panel and exits the experiment configuration window.
Cancel
The Cancel button does not save any changes made to the experiment details panel and exits the experiment configuration window.
The instrument selection panel is presented to the user at application startup and allows the user to select which instrument the ICE client will connect to.
The “Move Device” panel allows a user to directly view and control device values on an instrument.
Panel Components
View Tabs. These tabs, located at the top of the panel, allow the user to view only a specific subset of devices on the system. There are 3 standard tabs; Advanced, Basic, and All. Each has its own set of default instruments. The user can edit which instruments are set for each tab, and add additional tabs.
Customizing Tabs
The tabs in the Move Device Panel can be customized using the Customized Layout window, which can be loaded by choosing Edit->Customize. The window is shown below on the left. Note that the tab names are in blue and the devices which appear on a tab appear below the tab name in black.
Adding Devices to tabs. Devices can be added by clicking the item above where the new item is to be placed and clicking the "Add..." button. The Add Device window will appear. The Add Device window is shown above on the right. The list in the Add device window contains all devices which may be added. Select all devices to be added. Multiple devices can be selected by hoding the "Control" while selecting. Click "add" to add the devices, and click "Close" to close the add device window.
Adding Tabs. Tabs are added by clicking the "New Tab" button. When the button is clicked, the user will be asked to provide a name for the new tab. That name will then appear at the bottom of the list and as a tab in the Move Device Panel.
Removing Tabs and Devices. To remove tabs or devices, select those tabs or devices to be removed. Multiple tabs or devices can be selected by holding the "Control" key while selecting. Click the remove button to remove the selected tabs and devices. Devices which are included in a tab which is removed will also be removed. Devices and tabs cannot be removed at the same time. If both devices and tabs are selected, the Remove button will be disabled.
Reordering Devices within tabs. Devices can be moved up or down within a tab by selecting the device and clicking "Move Up" or "Move Down" on the Customize Layout Window. Multiple devices can be selected by holding down the "Control" key while selecting. All selected devices will be moved up or down one position when Move Up or Move Down are clicked, respectively.
Standard Tabs
Advanced. This option shows only the most commonly used devices and virtual devices on the instrument.
Basic. This options shows only the most commonly used devices on the instrument.
All. This option shows all devices on the instrument.
Manipulating Devices. The device status is given in rows, with each row representing a device. The columns represent properties of the device and allow manipulation of those properties. The following actions may be performed on devices:
Setting position. To move a device to a certain value or position, set the target position control for that device and hit the Go! Button to send a command to the instrument to move the device to the target position.
After you hit Go! And the instrument becomes idle, you should see the current position match the target position you set. If not, check the bottom of the Move Device panel to see if an error has shown up.
Jogging. Moving a device position in small increments is called jogging the device. The amount of movement for a jog is set using the Jog Step textboxes. After the Jog Step is set, pressing the “+” or “–“ buttons on either side of the Jog Step textbox will move the instrument by the amount set in the jog step in the positive or negative direction, respectively.
You can see the results of jogging in the Current Position reading for the device.
For instruments where jogging does not make sense, the jogging controls will be removed.
Fixing position. Selecting this checkbox will mean that the device to which it corresponds will not be moved during scans. The device can still be moved directly by setting position, Jogging, or moving a virtual device which contains it.
Information Columns for Devices. Devices are organized by section or virtual device. Clicking on the blue icon will hide or display the devices. The device status is given in rows, with each row representing a device. The columns represent properties of the device and allow manipulation of those properties.
Device Icons. : Icons representing devices are generally a letter inside a colored circle. The letter represents the type of the device and the color represents the status of the device.
M. Motor
V. Virtual Device – these are non-physical devices which may map to values on multiple other devices. Moving a virtual device will usually also move one or more other devices.
S.
?
Blue Circle. This represents a device or section that organizes devices heirarchically. Clicking on the blue icon will hide or display the devices.
Green Circle. The device is currently moving
Orange Circle. The device is not currently moving
Device. Name of device
Current Position. The current position of the device according to the ICE server.
Target Position. Use these controls to set a new position or value for a particular device. See “Setting Position” above.
Jog Step. Values set in these textboxes determines how far an instrument will move when jogged in the positive or negative direction. See “Jogging” above.
Fix. These checkboxes determine whether a particular device is fixed. See “Fixing Position” under the Devices section above.
Error Display. (bottom of panel)
Sometimes an instrument may not be able to move as specified. In such cases, a descriptive error message will be displayed along the bottom of the Move Device window.
The Peak Scan panel allows the user to find the position of a device which maximizes intensity.
The Peak Scan panel allows a user to scan a device through a range of values. The panel will plot the intensity at each point. It will also fit a Gaussian curve to the data and display the value and position of the curve peak.
Components of the Peak Scan Panel
Peak Scan
Device
The user is required to choose a device for which peak scan is performed.
Range
The user specifies the interval of device values, centered at the current device position.
Step Size
The user enters step size. The number of points for the scan is calculated as device range divided by the step size.
Duration
This field specifies the value till which counting is performed at every point of the peak scan.
Count Against
The user selects between Time and Monitor as the device for which Duration counts are measured.
Data to Display
The user selects Detector or Monitor as data to be displayed when peak scan is executed.
Accept Fit Result
If this option is selected, after the peak in the given device range is found, the device will be automatically moved to the position at which this peak was reached.
Find Peak
Clicking this button will start a scanning process. Counts vs Position plot will be updated in real time as the scan is progressing.
Fit Parameters
Background, Position, Height, Width
After scan is finished, the Gaussian curve will be fitted to the count data in order to determine device position (Position) at which maximum count is reached. Background, Height and Width are calculated characteristics of the fitted Gaussian curve.
Move to Fit
Move to Fit
Clicking Move to Fit button will instruct the server to move the device to the center of the fit.
Redefine
Clicking Redefine button will drive a device to the target value given in the associated text field.
New Lattice Values
This subpanels refers to the special case when A4 has been chosen as a device in peak scan, and when Ei and Ef are assumed to be equal. In this case, A4 peak position can be used to calculate d-spacing of the sample.
Uncorrected Fit Result
Uncorrected fit field displays the value of the d-spacing determined by the peak scan. The user types in a number for the conversion field. This number is multiplied by uncorrected fit value and is displayed in New Value field.
Redefine Lattice Parameters
User checks a combination of a, b, c boxes. Upon clicking the redefine lattice parameters button, the command to redefine checked parameters of the sample lattice to the New Value is sent to the server. Server redefines the lattice parameters and sends a client a confirmation notice
The Report A Bug Panel can be displayed by clicking on the "Report A Bug" file option from the "Help" file menu. This panel allows users to submit defects of the ICE software system.
Headline
The Headline text field is used to enter the title of the defect. This should be a brief description summarizing the defect's description.
Submitter's Email
The Submitter's Email text field is used to enter the email address of the person submitting the defect.
Priority
The Priority drop down menu allows the user to select the importance of the bug.
The Resolve Immediately selection gives the highest importance for the defect.
The Give High Attention selection gives the medium-highest importance for the defect.
The Normal Queue selection gives the medium-lowest importance for the defect.
The Low Priority selection gives the lowest importance for the defect.
Instrument
The Instrument drop down menu allows the user to select the instrument the defect is occuring on.
Description
The Description text area is used to enter the detailed description of the defect. This includes observations, users involved, workarounds, ecetera.
Submit Button
The Submit button sends all defect information (Headline, Submitter's Email, Priority, Instrument, Description) to ICE's bug tracking system.
Cancel Button
The Cancel button does not save any information and changes made to the Report A Bug panel. The panel closes.
The Resource Editor Panel allows the user to edit the text description of a scan or sequence stored in ICE .
Resource Editor Functions
Opening a file. Files can be opened for editing from the Server Queue Panel by right clicking on a file and choosing "Edit as Text" from the context menu.
Each open file will have its own tab in the Resource editor under the main set of panel tabs.
Creating a New Sequence File. A new sequence file can be created by clicking the "File" menu, moving the mouse over "New," and selecting "sequence" at the bottom of the list.
Choosing another file type from the File->New menu will open an editor for that particular file type.
Closing a File. Files can be closed by right clicking on the tab for that file, and choosing "Close" on the context menu.
Saving a file. Files can be saved by choosing "Save" from the File menu. Users will also be asked if they want to save when closing an unsaved file.
Files with an asterisk * next to them have not been saved since changes have been made.
Editing a file. The editor is a simple, minimally-featured text file editor. Users can click at any location in the file to edit at that point.
Text can be selected with the mouse and deleted using the Backspace or Delete keys
Standard editing key combinations apply, such as Ctrl-C to copy, Ctrl-X to cut, and Ctrl-V to paste.
There is no undo, so edit carefully. Users can revert to previously saved versions of files by closing the file and choosing "No" when asked to save.
Files
The files section shows scans, sequences, and scripts in ICE using a file tree view.
Deleting Files. Files can be deleted from the files section by right clicking the file and choosing “Delete” from the context menu.
Editing Files. Files can be edited by right clicking the file and choosing “Edit” or “Edit Scan Parameters” from the context menu. Edit will bring up the appropriate panel for that type of action. Selecting "Edit" will load the appropriate scan panel with its values for the scans properties. Selecting "Edit Scan Parameters" will load the Scan Properties panel. This panel is used to update the selected scan's number of points, base count, prefactor, data of interest, and count against fields.
Server Scan List Folder
The Server Scan List folder contains a list of scans saved. Selecting this folder allows the user to view the scans saved.
Name Column. The Name column displays the name of the file or folder. Clicking the name column sorts the list by name, ascending or descending.
Num Points Column. The Num Points column displays the number of points for the scan. Clicking the num points column sorts the folder by number of points, ascending or descending. This column is only available for scans.
Count Against Column. The Count Against column displays the count against for the scan, monitor or time. Clicking the count against column sorts the folder by monitor or time. This column is only available for scans.
Duration Column. The Duration column displays the duration for the scan. This displays the time it takes to run a scan. Clicking the duration column sorts the folder by duration, ascending or descending. This column is only available for scans.
EXPT Folder
The EXPT folder contains a list of files saved for an experiment. Selecting this folder allows the user to view the experiment files saved.
Name Column. The Name column displays the name of the file or folder. Clicking the name column sorts the list by name, ascending or descending.
Type Column. The Type column displays the type either file or folder. Clicking the type tab sorts the list by type, ascending or descending.
Comments Column. The Comments column displays any notes for the folder. Clicking the comments column sorts the folder by comments, ascending or descending.
The Sample Environment Panel is used to add, remove, and update sample environment devices. This panel is one of 3 tabs composing the Experiment Configuration Window. The system limits the user to have no more than one temperature controller and one magnet controller installed. There can be multiple occurences of other devices installed on the system.
Devices on System
The Devices on System list box contains the devices currently installed on the system. This information will be provided in the following format: "Alias Name (Device Name)" The alias name followed by the device name. When a user selects an item from the list box the controller type, controller, alias, and properties are updated with information for the device.
Controller Type
The Controller Type drop down menu is used to select the type of device. When the controller type is selected the Controller drop down menu is populated with controllers of that controller type.
Controller
The Controller drop down menu is used to select the device to add, update, or remove. When a magnet or temperature controller is selected, the properties panel updates with components for that controller. The properties panel is updated when a magnet or temperature controller is selected.
Alias
The Alias text field is used to enter an alias name to associate with the device selected. This component is enabled only for devices of type "other".
Temperature Properties
The maximum upper tilt text field takes an integer value to set the upper tilt on the goniometer. Damage to the instrument or equipment may occur if an inappropriate upper tilt limit is entered.
The maximum lower tilt text field takes an integer value to set the lower tilt on the goniometer. Damage to the instrument or equipment may occur if an inappropriate lower tilt limit is entered.
The user can set the unit of measurement for temperature to Kelvin or Celsius.
The sample channel drop down menu allows users to select the channel representing the temperature at which the sensor is located at the sample to record data. The sample channel and control channel can be set to the same sensor. The channels represent characters with 'A' as the first channel representing 0, 'B' as the second channel representing 1, etc.
The control channel drop down menu allows users to select the channel representing the temperature at which the sensor is located within the freezer. The control channel and sample channel can be set to the same sensor. The channels represent characters with 'A' as the first channel representing 0, 'B' as the second channel representing 1, etc.
Magnet Properties
The maximum upper tilt text field takes an integer value to set the upper tilt on the goniometer. Damage to the instrument or equipment may occur if an inappropriate upper tilt limit is entered.
The maximum lower tilt text field takes an integer value to set the lower tilt on the goniometer. Damage to the instrument or equipment may occur if an inappropriate lower tilt limit is entered.
The user can set the unit of measurement for magnet to Tesla, Gauss or Kilogauss.
The mode for magnet is defined as persistence or non-persistence. Persistence mode is creating a magnetic field with an ending state of no current coming from the magnet power supply. Non-persistence mode is creating a magnetic field using a continuous current coming from the magnet power supply.
Add Device
The Add Device button adds the selected controller to the system. This also updates the Devices on System list box by adding the selected controller with its alias to the list box. The Add Device button becomes disabled, while the Update Device and Remove Device buttons become enabled for the device added.
Update Device
The Update Device button updates any changes made to the selected controller's properties.
Remove Device
The Remove Device button removes the selected controller from the system. This also updates the Devices on System list box by removing the selected controller with its alias from the list box. The Remove Device and Update Device buttons becomes disabled, while the Add Device button becomes enabled.
OK
The OK button exits the experiment configuration window.
Cancel
The Cancel button exits the experiment configuration window.
The Scan Operation panel replaces the Edit Multiple Scans panel as an interface for editing several scans at once. The panel allows editing of the major parts of a scan description for one of more scans stored on the server.
Note that changes are not rigorously validated or checked to ensure proper functionality. It is therefore up to users to ensure that any changes they are applying will not cause problems with the scans to which the changes are being applied.
To open the scan operation panel, go the Resource manage panel by choosing Resource Manager from the Window menu. Select all of the scans you wish to change parameters for by holding Control and selecting them, or holding Shift while dragging the mouse across a continuous list of scans. When you have selected all of the scans to be edited, right click on the list and choose "Edit Scan Parameters," as shown below.
Target Scans
At the top of the panel, the target scans for the scan operation are listed. Each of these scans will have the operations specified applied to them. If Q component ranges are specified in the Change Scan Ranges section, then each of these ranges must contain a Q range, or the scan operation will fail.
Change Scan Ranges
In the middle of the Scan operation panel is a set of controls to allow editing of ranges in scan descriptions. To enable operations on ranges, click the checkbox next to “Change Range(s)”.
If a range is specified for a device which already has a range specified in a target scan description, then that range will be replaced; otherwise a range will be added.
If you have entered range changes, when you click "OK", some simple validation will be done to make sure that you have entered values for necessary fields. If there are errors, an error message will pop up and no scan operation command will be sent to the user. Note that the validation done is mimimal. Even if no error pops up for a scan operation, the values sent may cause an error with the command which prevents it from being successfully executed, or may cause problems with your scan.
Property Changes
At the bottom of the Scan Operation panel, other fields in the scan description can be changed. To change a field, select the checkbox next to it and put in a new value.
The Server Queue Panel lets a user view and manipulate which commands, scans, sequences, or scripts are waiting to be run on the server.
The Server Queue panel displays a list of scans and sequences which can be run on the server, and those which have recently completed, are currently running, or are scheduled to run.
Elements of the Server Queue Panel:
Files. The files section shows scans, sequences, scripts (currently disabled), and xml files stored in ICE using a file tree view. Note that, though scans are referred to as files, they are not actually stored onto the disk unless the SCAN LISTBACKUP command is sent to the server (see Command SCAN documentation).
Deleting Files. Files can be deleted from the files section by right clicking the file and choosing “Delete” from the context menu.
Editing Files. Files can be edited by right clicking the file and choosing “Edit” or “Edit as Text” from the context menu. Edit will bring up the appropriate panel for that type of action. Edit as Text will load the text of the server command in the file and allow the user to edit that directly.
Progress
The progress section lists properties of the current action running on the server. The listed properties include the following:
Current Point. The current data point being measured by the action.
Total Points. The total number of data points which will be measured during the action.
Monitor Count. Current value of the monitor counter.
Detector Count. Current Value of the detector counter.
Action List
The server queue panel displays a list of actions (scans, sequences, scripts, and XML Files) running on the server (right side of panel with white background), formatted to indicate their status, as follows:
Gray text. Indicates actions which have already been run.
Bold text. Indicates a running action.
Non-bold black text. Indicates a queued action waiting to be run.
Manipulating the Server Queue
Adding Actions to the Queue. Actions can be added to the queue by dragging them from the folders in the Files section onto the action list section or by right clicking an action in the Files section and choosing “Add to Queue” from the context menu.
Reordering Actions from the Queue. Actions waiting to be run can be reordered by selecting an action and clicking the up or down buttons to the right of the action list to move the action up or down in the queue. Consecutive actions can be reordered by holding the Ctrl button, selecting consecutive actions, and clicking the up or down buttons.
Removing Actions from the Queue. Actions can be removed from the queue by clicking on the action in the action list and clicking the remove button to the right of the action list. Holding the Ctrl button, clicking on multiple actions, and clicking the remove button allows the user to remove multiple actions.