Mercurial > hg > orthanc-stone
annotate README.md @ 506:801d2697a1b1 bgo-commands-codegen
Merge with am-touch-events
| author | Benjamin Golinvaux <bgo@osimis.io> |
|---|---|
| date | Tue, 26 Feb 2019 21:33:16 +0100 |
| parents | README@64d90190a08c README@7cdb4634846c |
| children | b1377625e4ba |
| rev | line source |
|---|---|
| 0 | 1 Stone of Orthanc |
| 2 ================ | |
| 3 | |
| 4 General Information | |
| 5 ------------------- | |
| 6 | |
| 7 This repository contains the source code of the Stone of Orthanc. | |
| 8 | |
| 9 Stone of Orthanc is a lightweight, cross-platform C++ framework for | |
| 10 the CPU-based rendering of medical images. It notably features support | |
| 11 for MPR (multiplanar reconstruction of volume images), PET-CT fusion, | |
| 12 and accurate physical world coordinates. | |
| 13 | |
| 14 Stone of Orthanc comes bundled with its own software-based rendering | |
| 15 engine (based upon pixman). This engine will use CPU hardware | |
| 16 acceleration if available (notably SSE2, SSSE3, and NEON instruction | |
| 17 sets), but not the GPU. This makes Stone a highly versatile framework | |
| 9 | 18 that can run even on low-performance platforms. Note that Stone is |
| 19 able to display DICOM series without having to entirely store them in | |
| 20 the RAM (i.e. frame by frame). | |
| 21 | |
| 22 Thanks to its standalone rendering engine, Stone of Orthanc is also | |
| 23 compatible with any GUI framework (such as Qt, wxWidgets, MFC...). The | |
| 24 provided sample applications use the SDL framework. | |
| 0 | 25 |
| 9 | 26 Stone is conceived as a companion toolbox to the Orthanc VNA (vendor |
| 27 neutral archive, i.e. DICOM server). As a consequence, Stone will | |
| 28 smoothly interface with Orthanc out of the box. Interestingly, Stone | |
| 29 does not contain any DICOM toolkit: It entirely relies on the REST API | |
| 30 of Orthanc to parse/decode DICOM images. However, thanks to the | |
| 31 object-oriented architecture of Stone, it is possible to avoid this | |
| 32 dependency upon Orthanc, e.g. to download DICOM datasets using | |
| 33 DICOMweb. | |
| 0 | 34 |
| 35 | |
| 36 Comparison | |
| 37 ---------- | |
| 38 | |
| 39 Pay attention to the fact that Stone of Orthanc is a toolkit, and not | |
| 1 | 40 a fully-featured application for the visualization of medical images |
| 41 (such as Horos/OsiriX or Ginkgo CADx). However, such applications | |
| 445 | 42 can be built on the top of Stone of Orthanc. |
| 0 | 43 |
| 44 Stone of Orthanc is quite similar to two other well-known toolkits: | |
| 45 | |
| 46 * Cornerstone, a client-side JavaScript toolkit to display medical | |
| 47 images in Web browsers, by Chris Hafey <chafey@gmail.com>: | |
| 48 https://github.com/chafey/cornerstone | |
| 49 | |
| 50 Contrarily to Cornerstone, Stone of Orthanc can be embedded into | |
| 51 native, heavyweight applications. | |
| 52 | |
| 53 * VTK, a C++ toolkit for scientific visualization, by Kitware: | |
| 54 http://www.vtk.org/ | |
| 55 | |
| 56 Contrarily to VTK, Stone of Orthanc is focused on CPU-based, 2D | |
| 57 rendering: The GPU will not be used. | |
| 58 | |
| 59 | |
| 60 Dependencies | |
| 61 ------------ | |
| 62 | |
| 63 Stone of Orthanc is based upon the following projects: | |
| 64 | |
| 65 * Orthanc, a lightweight Vendor Neutral Archive (DICOM server): | |
| 66 http://www.orthanc-server.com/ | |
| 67 | |
| 68 * Cairo and pixman, a cross-platform 2D graphics library: | |
| 69 https://www.cairographics.org/ | |
| 70 | |
| 71 * Optionally, SDL, a cross-platform multimedia library: | |
| 72 https://www.libsdl.org/ | |
| 73 | |
| 445 | 74 Prerequisites to compile natively on Ubuntu: |
| 222 | 75 ``` |
| 76 sudo apt-get install -y libcairo-dev libpixman-1-dev libsdl2-dev | |
| 77 ``` | |
| 0 | 78 |
| 445 | 79 The emscripten SDK is required for the WASM build. Please install it |
| 80 in `~/apps/emsdk`. If you wish to use it in another way, please edit | |
| 81 the `build-wasm.sh` file. | |
| 82 | |
|
466
5055031f4a06
- Added browserify to build. This allows using require calls for modules that
bgo-osimis
parents:
445
diff
changeset
|
83 ninja (`sudo apt-get install -y ninja-build`) is used instead of make, for performance reasons. |
|
5055031f4a06
- Added browserify to build. This allows using require calls for modules that
bgo-osimis
parents:
445
diff
changeset
|
84 |
| 445 | 85 Installation and usage ---------------------- |
| 0 | 86 |
| 87 Build instructions are similar to that of Orthanc: | |
| 460 | 88 http://book.orthanc-server.com/faq/compiling.html |
| 0 | 89 |
| 41 | 90 Usage details are available as part of the Orthanc Book: |
| 91 http://book.orthanc-server.com/developers/stone.html | |
| 92 | |
| 0 | 93 Stone of Orthanc comes with several sample applications in the |
| 445 | 94 `Samples` folder. These samples can be compiled into Web Assembly or |
| 95 into native SDL applications. | |
|
264
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
96 |
| 445 | 97 The following assumes that the source code to be downloaded in |
| 98 `~/orthanc-stone` and Orthanc source code to be checked out in | |
| 99 `~/orthanc`. | |
| 100 | |
| 101 Building the WASM samples | |
| 102 ------------------------------------- | |
|
264
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
103 ``` |
|
295
b04b13810540
unified CMakeLists.txt into a single file for WASM/Native + bootstrap Command (to rework) + doc
am@osimis.io
parents:
265
diff
changeset
|
104 cd ~/orthanc-stone/Applications/Samples |
|
264
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
105 ./build-wasm.sh |
|
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
106 ``` |
|
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
107 |
| 445 | 108 Serving the WASM samples |
| 109 ------------------------------------ | |
|
264
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
110 ``` |
|
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
111 # launch an Orthanc listening on 8042 port: |
|
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
112 Orthanc |
|
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
113 |
| 445 | 114 # launch an nginx that will serve the WASM static files and reverse |
| 115 # proxy | |
|
264
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
116 sudo nginx -p $(pwd) -c nginx.local.conf |
|
6b98ac45aaee
documented how to compile and execute WASM samples
am@osimis.io
parents:
222
diff
changeset
|
117 ``` |
| 445 | 118 |
| 119 You can now open the samples in http://localhost:9977 | |
| 0 | 120 |
| 445 | 121 Building the SDL native samples (SimpleViewer only) |
| 122 --------------------------------------------------- | |
| 123 | |
| 124 The following also assumes that you have checked out the Orthanc | |
| 125 source code in an `orthanc` folder next to the Stone of Orthanc | |
| 126 repository, please enter the following: | |
| 127 | |
| 265 | 128 ``` |
| 129 mkdir -p ~/builds/orthanc-stone-build | |
| 130 cd ~/builds/orthanc-stone-build | |
| 445 | 131 cmake -DORTHANC_FRAMEWORK_SOURCE=path \ |
| 132 -DORTHANC_FRAMEWORK_ROOT=$currentDir/../../../orthanc \ | |
| 133 -DALLOW_DOWNLOADS=ON -DENABLE_SDL=ON \ | |
| 134 ~/orthanc-stone/Applications/Samples/ | |
| 135 ``` | |
| 136 | |
| 137 If you are working on Windows, add the correct generator option to | |
| 138 cmake to, for instance, generate msbuild files for Visual Studio. | |
| 139 | |
| 140 Then, under Linux: | |
| 141 ``` | |
| 265 | 142 cmake --build . --target OrthancStoneSimpleViewer -- -j 5 |
| 143 ``` | |
| 144 | |
| 445 | 145 Note: replace `$($pwd)` with the current directory when not using Powershell |
| 146 | |
| 147 Building the Qt native samples (SimpleViewer only) under Windows: | |
| 148 ------------------------------------------------------------------ | |
| 149 For instance, if Qt is installed in `C:\Qt\5.12.0\msvc2017_64` | |
| 150 | |
| 151 `cmake -DSTATIC_BUILD=ON -DCMAKE_PREFIX_PATH=C:\Qt\5.12.0\msvc2017_64 -DORTHANC_FRAMEWORK_SOURCE=path -DORTHANC_FRAMEWORK_ROOT="$($pwd)\..\orthanc" -DALLOW_DOWNLOADS=ON -DENABLE_QT=ON -G "Visual Studio 15 2017 Win64" ../orthanc-stone/Applications/Samples/` | |
| 152 | |
| 153 Note: replace `$($pwd)` with the current directory when not using Powershell | |
| 154 | |
| 155 | |
| 501 | 156 |
| 445 | 157 Building the SDL native samples (SimpleViewer only) under Windows: |
| 158 ------------------------------------------------------------------ | |
| 159 `cmake -DSTATIC_BUILD=ON -DORTHANC_FRAMEWORK_SOURCE=path -DORTHANC_FRAMEWORK_ROOT="$($pwd)\..\orthanc" -DALLOW_DOWNLOADS=ON -DENABLE_SDL=ON -G "Visual Studio 15 2017 Win64" ../orthanc-stone/Applications/Samples/` | |
| 160 | |
| 161 Note: replace `$($pwd)` with the current directory when not using Powershell | |
| 162 | |
| 163 Executing the native samples: | |
| 164 -------------------------------- | |
| 265 | 165 ``` |
| 166 # launch an Orthanc listening on 8042 port: | |
| 167 Orthanc | |
| 168 | |
| 169 # launch the sample | |
|
295
b04b13810540
unified CMakeLists.txt into a single file for WASM/Native + bootstrap Command (to rework) + doc
am@osimis.io
parents:
265
diff
changeset
|
170 ./OrthancStoneSimpleViewer --studyId=XX |
| 265 | 171 ``` |
| 172 | |
| 0 | 173 Licensing |
| 174 --------- | |
| 175 | |
| 49 | 176 Stone of Orthanc is licensed under the AGPL license. |
| 0 | 177 |
| 178 We also kindly ask scientific works and clinical studies that make | |
| 179 use of Orthanc to cite Orthanc in their associated publications. | |
| 180 Similarly, we ask open-source and closed-source products that make | |
| 181 use of Orthanc to warn us about this use. You can cite our work | |
| 182 using the following BibTeX entry: | |
| 183 | |
| 210 | 184 @Article{Jodogne2018, |
| 185 author="Jodogne, S{\'e}bastien", | |
| 186 title="The {O}rthanc Ecosystem for Medical Imaging", | |
| 187 journal="Journal of Digital Imaging", | |
| 188 year="2018", | |
| 211 | 189 month="Jun", |
| 190 day="01", | |
| 191 volume="31", | |
| 192 number="3", | |
| 193 pages="341--352", | |
| 210 | 194 issn="1618-727X", |
| 195 doi="10.1007/s10278-018-0082-y", | |
| 196 url="https://doi.org/10.1007/s10278-018-0082-y" | |
| 0 | 197 } |
| 501 | 198 |