The CXI File Format

In this page you can find a complete description of the CXI file format along with many CXI examples files, and code to make and read those files. You can download the current reference document here.

CXI version 1.5 released

Posted by Filipe Maia on March 13, 2015

This version of the CXI format adds support for peak lists, commonly used in crystallography, as well as updating the meaning of several bits in mask used in the Detector and Image class so that it matches common use.

The new document can be found here.

CXI version 1.4 released

Posted by Filipe Maia on June 23, 2014

This new version of the CXI format introduces special support for modular pixel detectors (e.g. the CSPAD), storing each of the modules as a 2D array. This results in 3D arrays to store an image, and 4D to store an image scan from a modular detector. A score and tags field was also added to detectors to make it easier to sort and filter large datasets. Also the concept of implicit axis was added to make scans easier to use.

Finally a new Result class was added to store non-image analysis results. The new document can be found here.

CXI version 1.3 released

Posted by Filipe Maia on April 20, 2012

The biggest change is the introduction of the concept of scans to accomodate datasets where one experimental parameter is continuously changed such as wavelength or sample rotation. A new axes attribute was introduced, related with scans. The ptychography example was updated, and now makes use of scans. Several small corrections and clarifications. As usual the document can be found on github.

CXI version 1.2 released

Posted by Filipe Maia on July 21, 2011

A new version of the CXI file format has been released. It now includes the possibility of storing image supports in the file, all quantities are required to be in SI units, and there's a new method to define the CCD orientation. You can read the details here.

All examples have been updated to reflect these changes.

CXI Reference Document

Posted by Filipe Maia on January 11, 2011

The current version of the CXI reference document is now online. You can follow its development here or on GitHub.

Example files added

Posted by Filipe Maia on January 12, 2011

I've added the CXI example files described in the reference to the website. You should be able to find them on the CXI Examples section on the lower right.

Missing features

If you feel like there is an important feature (or class) that we are currently missing in CXI files then please send your ideas to cxi@cxidb.org.

Example CXI files


Python code that creates example files