Processing Results
Overview
Once a data collection Run has completed with 10 or more images, the data are automatically processed using
ICEflow — an SSRL automated pipeline that runs several 3rd party data processing
applications that provide quick feedback on the quality of each data set.
Data processing run information and selected results are written to the Sample Database.
Once the run information appears in the database, selected information is displayed in the Processing Results tab
of the Crystal Server web application (accessible at smb.slac.stanford.edu/lims/processing)
and in the Processing Tab of Blu-Ice.
Currently, autoPROC is used to run processing for two different resolution cutoffs for each dataset.
If autoPROC detects an anomalous signal it will spawn two new jobs with anomalous flags to optimize
anomalous data processing.
If the Processing Tab is not displaying processing information:
- Make sure a spreadsheet has been assigned to the cassette in the Screening Tab
(which is currently required for writing to the Sample Database).
A default spreadsheet can be created
and assigned to the cassette.
- If you have assigned the correct spreadsheet to your cassette in the
Screening Tab and you still cannot see processing information, contact beamline support staff.
If a group does not want auto-processing results written to the Sample Database,
they can opt out by checking the appropriate checkbox on the
SSRL SMB Unix account request form
(applies upon submittal) or by contacting their support staff. If a group opts out, no results will be recorded
in the database or displayed in the Processing tab, however auto-processing will still be carried out and the
results can be found in the auto-processing directories (described below).
Single Crystal Datasets
Displays processing results for individual crystal datasets. Each row represents one
processing run for one crystal. The table can be quickly traversed using scroll bars
or arrow keys. Column widths can be changed by hovering the mouse pointer near the
side of the column; when the pointer turns into a cross, click and drag.
Display Options
First Column
This dropdown menu allows the user to select the first column which is fixed in place
(default: Start Time) — the column stays in view when the table is scrolled horizontally.
View Options
This dropdown menu can be used to select from several displays: Minimum, Less, More, or All:
- Minimum — a bare-bones configuration showing essential information:
- Start Time
- Status
- Port
- Run
- Space Group
- Unit Cell
- Resolution
- [Resolution cutoff]
- Summary file
- Error
- Less — a configuration showing additional summary statistics:
- Mosaicity
- Anisotropy
- R-factors (Rpim, CC1⁄2)
- Summary Stats (Completeness, Multiplicity, I/σ(I))
- Anomalous Signal
- More — a comprehensive list that also includes:
- Crystal ID
- Protein
- Filename
- Image Directory
- Processing Directory
- 3rd Party Pipeline
- 3rd Party Pipeline Version
- All — adds information for staff troubleshooting:
- Run Time
- Sample ID
- Spreadsheet ID
- Job ID
- Slurm Job ID
- Slurm Job Name
- Slurm Partition
- Hostname
Processing Method
This dropdown menu can be used to view the results for different resolution cutoffs
(i.e. CC1⁄2, I/σ(I), etc.).
Spreadsheet Filter
Limit results to specific spreadsheets using the multi-select dropdown.
Table Sorting
By default, the table is sorted on Start Time (when the job was submitted to the queue)
and the column is sorted with the last submission on top. However, any column can be used
as the primary sorting column by simply clicking on the column title. By clicking on the
arrow in the column heading, sorting can be reversed.
Two-column sorting is possible by clicking on a second column title anywhere in the table
which will then become the primary sorting column and the previous sorting column will become
the secondary sorting column (similar to how Excel works). The primary sorting column is
indicated by a solid arrow and the secondary sorting column is indicated by a hollow arrow.
Buttons
The Restore Defaults button restores the column default spacing and sorting.
The Export to Excel button allows the user to download an Excel file with all the
processing results associated with the spreadsheet. Each processing method is shown on a different sheet.
Status
The "Status" column indicates the current status of the auto-processing job:
- Submitting — the job has been submitted to the queue.
- Pending — the job has been added to the queue but not started yet.
- Running — the job is currently in progress.
- Error (highlighted in red) — the job has exited with an error. The associated error message can be found in the column labeled "Error".
- Completed (highlighted in green) — the job has finished without errors.
Results auto-refresh every 5 seconds to show live processing progress.
Anomalous Signal Detection
When autoPROC detects an anomalous signal, it is reported in the "Anomalous Signal"
column and another processing job will be spawned with several anomalous flags set to optimize
anomalous data processing:
- -ANO — Main anomalous flag for autoPROC
- ExpectLargeHeavyAtomSignal=yes — Tells autoPROC to expect an anomalous signal
- ExpectLargeHeavyAtomSignalScaleAndMerge=yes — Apply anomalous handling during scaling/merging
- autoPROC_XdsKeyword_STRICT_ABSORPTION_CORRECTION="TRUE" — Enable strict absorption correction in XDS
Note that multiplicity (as reported by autoPROC in the Summary Stats column and in
the Summary.html file) always assumes no anomalous signal. Anomalous multiplicity can be
found in the "Anomalous Signal" column and in the summary file under Anom. Multiplicity.
Anisotropy
In addition to the standard processing method, autoPROC runs an anisotropic analysis
and the processing statistics can be found in the summary.html file under "Anisotropic".
The program STARANISO fits an ellipse to the scattering data and the "Anisotropy"
parameter in the Processing tab is calculated from the 3 axes of the ellipsoid:
Anisotropy = [Max(res1,res2,res3) − Min(res1,res2,res3)] / Ave(res1,res2,res3)
An anisotropy value close to zero indicates no anisotropy in the scattering. However,
anisotropies on the order of 0.3 have made significant improvements to electron density maps
compared to the standard processing method. Currently, the reported values in the Processing
tab (other than mosaicity and anisotropy) are taken from the standard processing output file
autoproc.xml. The anisotropic values and links to the corresponding anisotropic output files
can be found in the summary.html file.
Results Summary File
The "Summary" column will show a path to a summary HTML file (e.g. "00_summary.html"
for autoPROC)
- Clicking on the filename will open the file as a webpage in a web browser.
- Periodically refreshing the page will show the updated statistics as the processing job runs.
- The file will also display any error messages and warnings that come up during processing.
Multicrystal Datasets
Displays results from multicrystal scaling jobs. Each row represents one scaling job.
In addition to the columns available for single crystal datasets, the following columns
are available:
| Multicrystal Project | Name of the project that produced this result |
| Scaling Job | Job configuration name within the project |
| Merged Datasets | Count of datasets included in this merge |
| Average Phi | Average phi range across merged datasets |
| Reference Dataset | Dataset used as the scaling reference |
Anisotropy handling: When anisotropy exceeds 5%, statistics automatically switch
to STARANISO-corrected values with three resolution limits displayed.
Toolbar controls
- Project Filter — Limit results to specific multicrystal projects.
- View Presets — Same four levels as Single Crystal (Minimum, Less, More, All).
How to Interpret Error Messages
If an error occurs, the Status column will indicate an error and the message will be displayed
in the Error column. There are two general types of errors:
- ICEflow errors (these should be labeled "ICEFLOW ERROR")
- Processing software errors (these should be labeled "AUTOPROC ERROR" for processing with autoPROC)
If there are ICEflow errors, please contact beamline support.
autoPROC errors most often reflect issues with processing the data; some of the most common types are:
- Indexing errors in XDS
- Integration errors in XDS
- Scaling errors in apScale or XSCALE
ICEflow extracts autoPROC error messages from the "top" log file (typically named out-{cutoff}.log);
these errors most often point to the log files for specific processes (e.g. indexing) and provide relative paths to them.
Inspect these logs if you need more detailed information about what went wrong.
The autoPROC manual lists a few common errors
that can be encountered when running autoPROC as well as a few general suggestions for how to handle them.
ICEflow is designed to avoid the more basic errors (for example, all SSRL beamline-specific settings have been implemented already),
but if any of these errors crop up, please contact beamline support.
Viewing Previous Processing Results
There are several ways to view previous results:
- Crystal Server web application — Navigate to the
Processing Results
tab to see all processing results across all your spreadsheets. Use the Spreadsheet
Filter to narrow results to a specific spreadsheet.
- Blu-Ice Processing Tab — Within Blu-Ice, the
"View Previous Spreadsheets" button will open a standalone application.
- Blu-Ice Starter — If not assigned to a beamline, open the
Blu-Ice starter (desktop icon, right-click menu, or type "go" in a terminal)
and select "Auto-Processing Results" to open the standalone viewer.
The standalone application displays a list of all spreadsheets associated with your account.
Double-click a row (or click "View Processing Results") to open the processing results for that spreadsheet.
Where Are My Data Located?
The data processing directories can be quickly accessed by clicking on the link listed in the
"Processing Directory" column when using the View Options "More" or "All".
For those groups that have opted out of database recording, a symbolic link to the processing
directories can be found in the image directory, for example:
/data/{username}/mb_test/A5/autoprocessing_autoproc_8c562b
How to Modify the Processing Script and Reprocess Datasets Manually
- Click on the Processing Directory link.
- Create a new processing subdirectory:
> mkdir new_processing_folder
- Copy the processing script into the new folder:
> cp run-{cutoff}.sh new_processing_folder/my_new_run.sh
- Open the new script in the geany or gvim text editor and modify the autoPROC launch string as needed:
> cd new_processing_folder
> geany my_new_run.sh
CRITICAL — make sure to add the subfolder name after the -d argument or the script will not run! e.g.:
process [pre-existing arguments] -d .../new_processing_folder [rest of arguments]
- Save the new version and run my_new_run.sh:
> ./my_new_run.sh
ICEflow Pipeline (autoPROC)
The initial version of ICEflow deployed autoPROC v1.0.5
in a default configuration. Changes made to the pipeline, 3rd party software, configurations, input parameters, etc.
are listed and documented in the next section.
Resolution Cutoffs
- cc12 – Data are processed using a resolution cutoff corresponding to a target value for CC1⁄2 (~0.3) that is dynamically optimized by autoPROC.
- isigi – Data are processed using a resolution cutoff corresponding to a value of I/σ(I) that is fixed at 1.5.
Programs and Output
References
- autoPROC – Vonrhein, C., Flensburg, C., Keller, P., Sharff, A., Smart, O., Paciorek, W., Womack, T. & Bricogne, G. Data processing and analysis with the autoPROC toolbox. Acta Crystallographica D67, 293-302 (2011).
- autoPROC – Vonrhein, C., Flensburg, C., Keller, P., Fogh, R., Sharff, A., Tickle, I.J. and Bricogne, G., Advanced exploitation of unmerged reflection data during processing and refinement with autoPROC and BUSTER. Acta Crystallographica D80(3) (2024).
- STARANISO – Tickle, I.J., Flensburg, C., Keller, P., Paciorek, W., Sharff, A., Vonrhein, C., Bricogne, G., STARANISO. Cambridge, United Kingdom: Global Phasing Ltd. (2016).
- XDS – Kabsch, W. XDS. Acta Crystallographica D66, 125-132 (2010).
- POINTLESS – Evans, P.R. Scaling and assessment of data quality. Acta Crystallographica D62, 72-82 (2006).
- AIMLESS – Evans, P.R. and Murshudov, G.N. How good are my data and what is the resolution? Acta Crystallographica D69, 1204–1214 (2013).
ICEflow Versions and Release Notes
- ICEflow-2.0.0 – released on 11/15/2025
- New standalone Spreadsheet Viewer to view past results while on-line or off-line.
- "Export to Excel" feature.
- Changed from aimless.xml to autoproc.xml for display stats. Output now exactly matches autoPROC summary.html file.
- Fixed ambiguity for CC(anom) and added anomalous signal/noise ratio.
- Anisotropy calculation.
- Anomalous detection and resubmission with anomalous flags set.
- Multi-energy, inverse beam and wedge data set processing.
- Removed "No Cutoff" jobs to free up CPUs.
- Changes to the GUI:
- New buttons: "Export to Excel" and "View Previous Results".
- Anisotropy column added.
- "Potential anomalous signal detection and spawning new job" reported in Anomalous Signal column.
- A clickable link that displays the header contents of the image file.
- Slurm parameters added to the "All" view for troubleshooting.
- Misc. fixes (spacing, widths, units, etc.).
- ICEflow-1.5.0 – released on 03/19/2025
- ICEflow jobs are now submitted to a queue using the Slurm workload manager.
- Processing job submission parameters tweaked for optimal resource usage.
- Major changes to the GUI:
- A new status – "Pending" – appears for jobs waiting to run.
- New columns added to the Layout, with two settings available to users.
- A clickable link to a summary webpage file added.
- autoPROC log parsing takes into account new formatting.
- ICEflow-1.4.0 – released on 01/14/2025
- Added data collection strategy calculation (iMosflm) to ICEflow packages.
- Strategy can be found on the Collect Tab.
- ICEflow-1.3.0 (autoPROC) – released on 09/12/2024
- Added error extraction from logs and reporting in the Processing Tab.
- Reorganized result reporting to database and UI.
- ICEflow-1.2.1 (patch) (autoPROC) – released on 06/21/2024
- Fixed issue where autoPROC could not index images collected with a vertical offset on a Pilatus detector.
- Changed symlinks in data folder to point to the top processing folder.
- ICEflow-1.2.0 (autoPROC) – released on 06/18/2024
- Changed to a more descriptive convention for output folder:
/data/{username}/{3rd_party_software}/{filename_prefix}_{run_number}_{date}_{time}/{cutoff}
- The
README file now contains explicit path to source data and image file template, for easier reference.
- ICEflow-1.1.0 (autoPROC) – released on 06/12/2024
- Fixed an issue where both cutoff versions output data with a CC1/2-based resolution cutoff; the I/σ(I)-based cutoff is now enabled.
- Added a no-cutoff option.
- The summary.html files are now copied to the top folder for easier access.
- ICEflow-1.0.0 (autoPROC) – released on 06/05/2024
- Initial release, with only autoPROC pipeline enabled.
Pipelines Running before the Inception of ICEflow (before 6/5/2024)
For the SSRL pipeline (and the xia2 test pipeline), look in the image file directory
for the symbolic link to the directory with the processed data (these links will all begin with
'autoprocessing'). The processing directory contains the README file that describes the
pipeline used for data processing. If you can't find what you're looking for, contact your user support
staff member.
More information on the software supported by the SSRL-SMB Macromolecular Crystallography division
is available on our software webpage.
|