Revision a3d351fb6de40a4726ce169414d81715662c2728 authored by Konrad Werys on 16 November 2018, 12:33:56 UTC, committed by Konrad Werys on 16 November 2018, 12:33:56 UTC
1 parent 02d6226
Raw File
# Tomato
A library to calculate parametric maps in MRI. It contains ShMOLLI implementation as in [this article](

| [OSX/Linux - Travis](travis_link) | [Windows - AppVeyor](appveyor_link) |  [Test coverage - Codecov](codecov_link) | Downlads |
|:-------------:|:-------------:|:-------------:| :-------------:| 
![Travis (.org)][travis_badge] | ![AppVeyor][appveyor_badge]| ![codecov][codecov_badge]| ![GitHub Releases (by Release)][downloads_badge]

**Github** repository can be found [here](
**Documentation** in doxygen can be found [here](

## Tomato and Numerical Recipes

Original ShMOLLI (and based on it Tomato) uses code based on Numerical Recipes book. Due to Numerical Recipes licence I cannot share this part of the code online. Please contact me if you would like to use this part of the code. To make up for this limitation we provide a number of alternative fitting procedures. 

# Software Requirements Specification

1. Calculate ShMOLLI with exactly the same results as these from the previous implementation.
2. API for easily choosing
    * a map calculation algorithm,
    * a fitting algorithm,
    * a model function and corresponding energy function.
3. Compatibility with:
    * main operating systems (Windows, MacOS, Linux),
    * C++98 (to include the library in older code).
4. Handling DICOM files.
5. Fast calculation.
6. Easily interfaced to calculation environments MATLAB, IDL and Python.  

# Coding style

* Underscore (`_variable`) means a class member variable.
* C++98 does not allow me to use constructor delegation. I am using methods like `setAllPointersToNull()` to make up for it.
* Order of methods in a class definition: 
    * functional (calculation, helpers etc)
    * getters/setters
    * disp()
    * constructors/destructors
* In **copy constructors** copy primitive types, set all pointers to zero.

# Notes

* **Continuous integration** was tested [in this repo](
* **Gitmodules**: after `git clone` run `git submodule update --init --recursive` to get the submodules code.
* It would be nice to follow [CppCoreGuidlines]( as far as C++98 allows.
* Maybe I can write a script for github releases with [github releases REST api]( and [curl REST api](

# TODO: 

* provide template yaml config files
* scripts for python
* processing without phase data

back to top