ScanImage control of X/Y & Z position, of either the objective or specimen, requires use of a Sutter Instruments MP-285 controller. Several improvements to the MP-285 interface have been added in ScanImage 3.5:
- The 'calibration' of the X/Y & Z motions has been considerably simplified. Rather than entering separate X/YZCalibration values in the INI file, users must now enter only one value in the INI File Rig Configuration section, specifying the type of firmware present in their MP-285 controller. This ensures that the X/Y & Z positions are read-out and updated correctly by ScanImage.
In ScanImage 3.0, incorrect calibration could cause errors in the displayed X/Y/Z positions and discrepancies between the entered Z step/slice and the actual step size.
- Users can now reliably enter positions into the X/Y/Z position controls to cause MP-285 to move to newly desired position.
- The # Slices and Z step/slice values in the
Unknown macro: {link-window}Standard ControlsUnknown macro: {report-link}window, the other parameter will auto-adjust, so the start/endpoints set here remain in effect. For example, the user can vary the Z step/slice and the # slices will auto-adjust based on the distance between the stack start/end. If the checkbox is deselected, any change to the Z step/slice or # slices will clear the stack start/endpoints.
window can now be constrained to the stack start/end-points set in the Movement window (if both are in factset). This new option is active by default.
- MP-285 error conditions are now uniformly handled. A simple procedure allows recovery from most errors.
MovementUnknown macro: {center}New Controls
- Stack Start/End: These read-only display controls allow Z positions set via start and end buttons to be seen, and stored even as the current Z position may be updated.
- Slice Params Obey Start/End: If selected, when either one of the # slices or Z step/slice is adjusted in the
Unknown macro: {report-link}Standard Controls
- MP-285 error conditions are now uniformly handled. A simple procedure allows recovery from most errors.
Modified Controls
- GRAB: This control, which initiates a GRAB acquisition consisting of a Z stack between the displayed stack start/endpoints, is now inactive unless both a stack start and end have been entered.
INI File Rig Configuration Changes
New Variables
- firmware: ScanImage users employ different MP285 firmware types. To identify the firmware used on your MP-285, navigate to Setup->Utilities->Info on the MP-285 controller. If there are 2 letters ('KS', 'SA', or 'WD') preceding the version number, enter those two letters here. If not, the string 'native' should be entered.
- posnResolution: ScanImage validates the motor end position following all move operations, except for those in the midst of a stack acquisition. Infrequently, the end position will not exactly match the specified position. This value specifies, in microns, the smallest difference that will be tolerated without alerting the user.
Modified Variables
These variables should not be modified by typical users.
- velocityFast/Slow: (Previously below Rig Configuration section) These values specify the 'velocity' of the motor movement employed for long moves (fast) and short moves (slow). Movements during stack acquisitions always follow velocitySlow. Other movements (e.g. entering a new position in one of the X/Y/Z controls) use velocityFast for moves larger than 100um to get within 100um of the final position. The movement always finish using velocitySlow to reach the final position, which helps ensure the correct position is reached. The velocityFast value is roughly in um/second, whereas velocitySlow is in units about half of this.
The precise calibration of these 'velocities' is not fully understood and is known to be somewhat nonlinear. The default values in standard_model.INI (2000 and 400, respectively) have been found empirically to be satisfactory.
Values for velocityFast and velocitySlow must not exceed 6500 and 1300, respectively.
Removed Variables
- calibrationX/Y/Z: (Previously below Rig Configuration section) These values are no longer needed. The correct firmware setting ensures proper calibration in each dimension.
Error Handling
If an error condition is encountered during MP-285 operation, including timeout errors, the Movement window will clearly indicate the error condition:
null
Hitting the RESET button will attempt to restore communication with the MP-285 using serial commands sent to the MP-285 (the 'Interrupt' command is sent multiple times). Following that, the X,Y, and Z positions are read and updated. This ensures that future motor commands pertain to the correct actual positions.
If the RESET operation is unsuccessful, the user is advised to press the physical Reset button on the MP-285 controller. After this, pressing the software RESET button in the Movement window should operate correctly.
When the MP-285 is in an error condition, ScanImage operation can continue, but motor operations will not be possible.