Operator Discretization Library (ODL) is a Python library for fast prototyping focusing on (but not restricted to) inverse problems. ODL is being developed at KTH Royal Institute of Technology, Stockholm and Centrum Wiskunde & Informatica (CWI), Amsterdam.
The main intent of ODL is to enable mathematicians and applied scientists to use different numerical methods on real-world problems without having to implement all necessary parts from the bottom up.
This is reached by an Operator structure which encapsulates all application-specific parts, and a high-level formulation of solvers which usually expect an operator, data and additional parameters.
The main advantages of this approach are that
- Different problems can be solved with the same method (e.g. TV regularization) by simply switching operator and data.
- The same problem can be solved with different methods by simply calling into different solvers.
- Solvers and application-specific code need to be written only once, in one place, and can be tested individually.
- Adding new applications or solution methods becomes a much easier task.
- Efficient and well-tested data containers based on NumPy (default) or CUDA (optional)
- Objects to represent mathematical notions like vector spaces and operators, including properties as expected from mathematics (inner product, norm, operator composition, ...)
- Convenience functionality for operators like arithmetic, composition, operator matrices etc., which satisfy the known mathematical rules.
- Out-of-the-box support for frequently used operators like scaling, partial derivative, gradient, Fourier transform etc.
- A versatile and pluggable library of optimization routines for smooth and non-smooth problems, such as CGLS, BFGS, Chambolle-Pock and Douglas-Rachford splitting.
- Support for tomographic imaging with a unified geometry representation and bindings to external libraries for efficient computation of projections and back-projections.
- Standardized tests to validate implementations against expected behavior of the corresponding mathematical object, e.g. if a user-defined norm satisfies
norm(x + y) <= norm(x) + norm(y)for a number of input vectorsxandy.
Installing ODL should be as easy as
conda install -c odlgroup odl
or
pip install odl
For more detailed instructions, check out the Installation guide.
The code is compatible with Python 2 and 3 through the future library. It is intended to work on all major platforms (GNU/Linux / Mac / Windows).
ODL has been used in a wide range of research and development with several scientific articles and conference contributions as well as other open source projects using ODL as a back-end. Many of these release their code publicly and can serve as examples of how to use ODL. This is a short list of such projects. If you want to add your project to the list, contact the maintainers or file a pull request.
| Description | Code |
|---|---|
| Learned Primal-Dual Reconstruction. Arxiv, blog | GitHub |
| Indirect Image Registration with Large Diffeomorphic Deformations. Arxiv | GitHub |
| High-level algorithm prototyping: an example extending the TVR-DART algorithm. DGCI, 2017. DOI | GitHub |
| GPUMCI, a flexible platform for x-ray imaging on the GPU. Fully3D, 2017 | |
| Spectral CT reconstruction with anti-correlated noise model and joint prior. Fully3D, 2017 | GitHub |
| Solving ill-posed inverse problems using iterative deep neural networks. Arxiv | GitHub |
| Total variation regularization with variable Lebesgue prior. Arxiv | GitHub |
| Generalized Sinkhorn iterations for regularizing inverse problems using optimal mass transport. Arxiv | GitHub |
| A modified fuzzy C means algorithm for shading correction in craniofacial CBCT images. CMBEBIH, 2017 | GitHub |
| Shape Based Image Reconstruction Using Linearized Deformations. Inverse Problems, 2017. DOI | GitHub |
| Description | Code |
|---|---|
| Multigrid CT reconstruction | GitHub |
| Inverse problems over Lie groups | GitHub |
| Bindings for the EMRecon package for PET | GitHub |
| ADF-STEM reconstruction using nuclear norm regularization | GitHub |
Mozilla Public License version 2.0 or later. See the LICENSE file.
The project was started by and is maintained by Jonas Adler (@adler-j) and Holger Kohr (@kohr-h). Several others have given significant contributions, including:
Chong Chen, Matthias J. Ehrhardt, Barbara Gris, Johan Karlsson, Gregory R. Lee, Julian Moosmann, Kati Niinimäki, Willem Jan Palenstijn, Axel Ringh, Olivier Verdier, Gustav Zickert and Ozan Öktem.
To contact the developers either open an issue on the issue tracker or send an email to odl@math.kth.se.
Development of ODL is financially supported by the Swedish Foundation for Strategic Research as part of the project "Low complexity image reconstruction in medical imaging".
Some development time has also been financed by Elekta.