Mercurial > hg > orthanc-stone
annotate README.md @ 1526:61023b0d39c8
Reverted the Stone Web Viewer plugin to rev. 307a805d0587
(mistakenly changed to serve the RT Viewer and make it
available in the Orthanc Explorer while it should have been
done in a separate plugin)
| author | Benjamin Golinvaux <bgo@osimis.io> |
|---|---|
| date | Sun, 02 Aug 2020 13:53:48 +0200 |
| parents | c53a4667f895 |
| children | 0cbc85e0c583 |
| 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 |
|
1350
c53a4667f895
Sample paths have been adapted
Benjamin Golinvaux <bgo@osimis.io>
parents:
1173
diff
changeset
|
94 `Samples` folder. |
|
1173
1064098f496d
Added sample cmake command for bash/zsh
Benjamin Golinvaux <bgo@osimis.io>
parents:
1003
diff
changeset
|
95 |
|
1350
c53a4667f895
Sample paths have been adapted
Benjamin Golinvaux <bgo@osimis.io>
parents:
1173
diff
changeset
|
96 Please see the Samples/README.md file for information on the samples building |
|
c53a4667f895
Sample paths have been adapted
Benjamin Golinvaux <bgo@osimis.io>
parents:
1173
diff
changeset
|
97 and running procedure. |
| 445 | 98 |
| 265 | 99 |
| 0 | 100 Licensing |
| 101 --------- | |
| 102 | |
| 49 | 103 Stone of Orthanc is licensed under the AGPL license. |
| 0 | 104 |
| 105 We also kindly ask scientific works and clinical studies that make | |
| 106 use of Orthanc to cite Orthanc in their associated publications. | |
| 107 Similarly, we ask open-source and closed-source products that make | |
| 108 use of Orthanc to warn us about this use. You can cite our work | |
| 109 using the following BibTeX entry: | |
| 110 | |
| 210 | 111 @Article{Jodogne2018, |
| 112 author="Jodogne, S{\'e}bastien", | |
| 113 title="The {O}rthanc Ecosystem for Medical Imaging", | |
| 114 journal="Journal of Digital Imaging", | |
| 115 year="2018", | |
| 211 | 116 month="Jun", |
| 117 day="01", | |
| 118 volume="31", | |
| 119 number="3", | |
| 120 pages="341--352", | |
| 210 | 121 issn="1618-727X", |
| 122 doi="10.1007/s10278-018-0082-y", | |
| 123 url="https://doi.org/10.1007/s10278-018-0082-y" | |
| 0 | 124 } |
| 501 | 125 |