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 and general electron microscopy related tools.

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

11 May 2022 - Release 0.2.5 with some compatibility updates and improvements - see changelog for details.

2 May 2022 - Release 0.2.4 with several updates and improvements - see changelog for details.

26 February 2022 - Release 0.2.3 with several updates and improvements - see changelog for details.

29 November 2021 - Release 0.2.2 with several updates and improvements - see changelog for details.

19 October 2021 - Release 0.2.1 with several updates and improvements - see changelog for details.

20 September 2021 - Publication of a diptych on Parallel mode differential phase contrast in transmission electron microscopy: Part I Microsc. Microanal. 27, 1113 (2021), Part II Microsc. Microanal. 27, 1123 (2021).

See News Archive for earlier news.

Indices and tables

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.