-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
10 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,19 @@ | ||
| # Yet Another Gamma Index Tool | ||
|
|
||
| Library written in C++ for performing efficient comparisons of DICOM images using 2D, 2.5D and 3D gamma index concept. | ||
| YAGIT is a library written in C++ for performing efficient comparison of two images | ||
| containing radiation dose distributions using 2D, 2.5D and 3D gamma index concept. | ||
|
|
||
| ## Installation | ||
|
|
||
| Build steps: | ||
| 1. Creating a directory where the library will be built | ||
| ``` | ||
| mkdir build && cd build | ||
| ``` | ||
|
|
||
| 2. Installing packages and running cmake | ||
| * Using Conan package manager | ||
| ``` | ||
| conan install .. | ||
| cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake | ||
| ``` | ||
| * Using apt package manager | ||
| ``` | ||
| sudo apt-get install libgdcm-dev | ||
| cmake .. -DCMAKE_BUILD_TYPE=Release | ||
| ``` | ||
| ## Documentation | ||
|
|
||
| 3. Building the library | ||
| ``` | ||
| cmake --build . --config Release -j | ||
| ``` | ||
| The documentation is available at | ||
| [https://datamedsci.github.io/yagit/](https://datamedsci.github.io/yagit/). | ||
|
|
||
| 4. Installing the library | ||
| * system-wide (you need administrator privileges) | ||
| ``` | ||
| sudo cmake --install . | ||
| ``` | ||
| * in specific location | ||
| ``` | ||
| cmake --install . --prefix <path where you want to install> | ||
| ``` | ||
| ## Gamma versions | ||
| There are 2 implementations of gamma index: sequential and multithreaded. | ||
| To select the version you want, set the `GAMMA_VERSION` option to one of the values: `SEQUENTIAL`, `THREADS`, `SIMD`, `THREADS_SIMD`. | ||
| ``` | ||
| cmake .. -DGAMMA_VERSION=THREADS | ||
| ``` | ||
| The default value of this parameter is `THREADS`. | ||
| ## Installation | ||
|
|
||
| You can also modify SIMD extension used during the compilation of yagit. To do it, set `SIMD_EXTENSION` option to one of | ||
| the values: `DEFAULT`, `SSE2`, `SSE3`, `SSSE3`, `SSE4.1`, `SSE4.2`, `AVX`, `AVX2`, `AVX512`, `NATIVE`. | ||
| The default value of this parameter is `DEFAULT`, which means that no additional compilation options are added. | ||
| Option `NATIVE` adds `-march=native` if compiler supports it. | ||
| Instructions on how to install YAGIT are described at | ||
| [https://datamedsci.github.io/yagit/installation.html](https://datamedsci.github.io/yagit/installation.html). | ||
|
|
||
| ## Examples | ||
|
|
||
| Example usage of the library is located in `examples` directory. | ||
| To build examples, enable `BUILD_EXAMPLES` option during installation. | ||
| ``` | ||
| cmake .. -DBUILD_EXAMPLES=ON | ||
| ``` | ||
| And to start `gammaImage` example, run | ||
| * on Linux | ||
| ``` | ||
| ./examples/gammaImage | ||
| ``` | ||
| * on Windows | ||
| ``` | ||
| examples\Release\gammaImage.exe | ||
| ``` | ||
| Examples of how to use YAGIT are presented at | ||
| [https://datamedsci.github.io/yagit/examples.html](https://datamedsci.github.io/yagit/examples.html). |