Welcome to fpd’s documentation!

A python package for fast pixelated detector data storage, analysis and visualisation.

The fpd package provides code for the storage, analysis and visualisation of data from fast pixelated detectors. The data storage uses the hdf5 based EMD file format, and the conversion currently supports the Merlin readout from Medipix3 detectors. Differential phase contrast imaging and several other common data analyses, like radial distributions, virtual apertures, and lattice analysis, are also implemented, along with many utilities.

The package is relatively lightweight, with most of its few dependencies being standard scientific libraries. All calculations run on CPUs and many use out-of-core processing, allowing data to be visualised and processed on anything from very modest to powerful hardware.

News

4 September 2020 - Publication: Fast Pixelated Detectors in Scanning Transmission Electron Microscopy. Part II: Post Acquisition Data Processing, Visualisation, and Structural Characterisation, Microsc. Microanal. 26, 944 (2020), arXiv (2019).

21 August 2020 - Publication of open-data for ‘part 2’ including all data and scripts:

https://zenodo.org/badge/DOI/10.5281/zenodo.3903517.svg

10 August 2020 - Publication: Fast Pixelated Detectors in Scanning Transmission Electron Microscopy. Part I: Data Acquisition, Live Processing and Storage, Microsc. Microanal. 26, 653 (2020), arXiv (2019). All data and scripts for this paper are available:

https://zenodo.org/badge/DOI/10.5281/zenodo.3479124.svg

7 April 2020 - Release 0.1.10 (see changelog for details), updated notebook (https://gitlab.com/fpdpy/fpd-demos), and a new preprint: Fast Pixelated Detectors in Scanning Transmission Electron Microscopy. Part II: Post Acquisition Data Processing, Visualisation, and Structural Characterisation, Microsc. Microanal. 26, 944 (2020), arXiv (2020).

1 March 2020 - Release 0.1.9 with many new features and improvements - see changelog for details.

See News Archive for earlier news.

fpd-demos overview

Many examples of application of the fpd package are included in the fpd-demos repository: https://gitlab.com/fpdpy/fpd-demos

Citing

If you find this software useful and use it to produce results in a puplication, please consider citing the website or related paper(s).

An example bibtex entry with the date in the note field yet to be specified:

>>>
@Misc{fpd,
    Title                    = {{FPD: Fast pixelated detector data storage, analysis and visualisation}},
    howpublished             = {\url{https://gitlab.com/fpdpy/fpd}},
    note                     = {{Accessed} todays date}
}
>>>

Aspects of the library are covered in a paper:

https://zenodo.org/badge/DOI/10.5281/zenodo.3479124.svg https://zenodo.org/badge/DOI/10.5281/zenodo.3903517.svg

Publications

Some of the known scientific papers that used the fpd library are listed below. If you use the library for results contributing to a publication, please pass the paper details to developers for inclusion in this list.

Indices and tables