EMPyRe - Electron Microscopy Reconstruction¶
EMPyRe is an open source framework for constructing and solving hyperdimensional inverse problems and visualizing the corresponding input and output data. it has its roots in the reconstruction of three-dimensional magnetization distributions from magnetic phase images generated by electron holography but is meant to be extendable for many other problems that are based on forward models that are expressable as a combination of linear subproblems. EMPyRe is purely Python package, so all platforms should be supported.
$ pip install empyre
Per default, only the strictly required libraries are installed, but there are a few additional dependencies that will unlock additional capabilites of EMPYRE.
fftwwill install PyFFTW to speed up Fourier transforms used in some forward models.
colorswill install the cmocean, whose
balancecolor map is used as a default for the
imshowcommmand, if available.
3dwill install the mayavi package for 3D plotting capabilities.
testswill install all dependencies that are needed to test the package (usually not necessary for the average user).
allwill install all of the dependencies listed above.
You can choose these settings by using, e.g.:
$ pip install empyre[all]
EMPyRe has several dedicated modules which are fully documented here!
fieldsmodule provides the
Fieldcontainer class for multidimensional scalar or vector fields and is the fundamental data structure used in EMPyRe.
vismodule enables the plotting of
Fieldobjects, based on and similar in syntax to the commonly known matplotlib framework.
modelsmodule provides tools for constructing forward models that describe processes in Electron Microscopy.
reconstructmodule is a collection of tools for solving the inverse problems corresponding to the constructed forward models and diagnostic tools for their assessment.
iomodule is used to load and save
Fieldobjects and the models generated by the
utilsmodule, which houses utility functionality used throughout EMPyRe.
EMPyRe is licensed under GPLv3.
- The Field container class
- The vis visualization submodule
- The io visualization submodule