Mercurial > hg > orthanc-stone

comparison README @ 0:351ab0da0150

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial commit
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 14 Oct 2016 15:34:11 +0200
parents
children 2dbe613f6c93
comparison
equal deleted inserted replaced
-1:000000000000 0:351ab0da0150
1 Stone of Orthanc
2 ================
3
4
5 General Information
6 -------------------
7
8 This repository contains the source code of the Stone of Orthanc.
9
10 Stone of Orthanc is a lightweight, cross-platform C++ framework for
11 the CPU-based rendering of medical images. It notably features support
12 for MPR (multiplanar reconstruction of volume images), PET-CT fusion,
13 and accurate physical world coordinates.
14
15 Stone of Orthanc comes bundled with its own software-based rendering
16 engine (based upon pixman). This engine will use CPU hardware
17 acceleration if available (notably SSE2, SSSE3, and NEON instruction
18 sets), but not the GPU. This makes Stone a highly versatile framework
19 that can run even on low-performance platforms. Stone is able to
20 display DICOM series without having to entirely store them in the RAM.
21
22 Stone of Orthanc is conceived as a companion toolbox to the Orthanc
23 VNA (vendor neutral archive, i.e. DICOM server). As a consequence,
24 Stone will smoothly interface with Orthanc out of the
25 box. Interestingly, Stone does not contain any DICOM toolkit: It
26 entirely relies on the REST API of Orthanc to parse/decode DICOM
27 images. However, thanks to the object-oriented architecture of Stone,
28 it is possible to avoid this dependency upon Orthanc.
29
30
31 Comparison
32 ----------
33
34 Pay attention to the fact that Stone of Orthanc is a toolkit, and not
35 a fully-featured application for the visualization of medical
36 images. Such applications can be built on the top of Stone of Orthanc.
37
38 Stone of Orthanc is quite similar to two other well-known toolkits:
39
40 * Cornerstone, a client-side JavaScript toolkit to display medical
41 images in Web browsers, by Chris Hafey <chafey@gmail.com>:
42 https://github.com/chafey/cornerstone
43
44 Contrarily to Cornerstone, Stone of Orthanc can be embedded into
45 native, heavyweight applications.
46
47 * VTK, a C++ toolkit for scientific visualization, by Kitware:
48 http://www.vtk.org/
49
50 Contrarily to VTK, Stone of Orthanc is focused on CPU-based, 2D
51 rendering: The GPU will not be used.
52
53
54 Dependencies
55 ------------
56
57 Stone of Orthanc is based upon the following projects:
58
59 * Orthanc, a lightweight Vendor Neutral Archive (DICOM server):
60 http://www.orthanc-server.com/
61
62 * Cairo and pixman, a cross-platform 2D graphics library:
63 https://www.cairographics.org/
64
65 * Optionally, SDL, a cross-platform multimedia library:
66 https://www.libsdl.org/
67
68
69 Installation and usage
70 ----------------------
71
72 Build instructions are similar to that of Orthanc:
73 https://orthanc.chu.ulg.ac.be/book/faq/compiling.html
74
75 Stone of Orthanc comes with several sample applications in the
76 "Samples" folder. These samples use SDL.
77
78
79 Licensing
80 ---------
81
82 Stone of Orthanc is licensed under the GPLv3 license, with the OpenSSL
83 exception:
84 http://people.gnome.org/~markmc/openssl-and-the-gpl.html
85
86 We also kindly ask scientific works and clinical studies that make
87 use of Orthanc to cite Orthanc in their associated publications.
88 Similarly, we ask open-source and closed-source products that make
89 use of Orthanc to warn us about this use. You can cite our work
90 using the following BibTeX entry:
91
92 @inproceedings{Jodogne:ISBI2013,
93 author = {Jodogne, S. and Bernard, C. and Devillers, M. and Lenaerts, E. and Coucke, P.},
94 title = {Orthanc -- {A} Lightweight, {REST}ful {DICOM} Server for Healthcare and Medical Research},
95 booktitle={Biomedical Imaging ({ISBI}), {IEEE} 10th International Symposium on},
96 year={2013},
97 pages={190-193},
98 ISSN={1945-7928},
99 month=apr,
100 url={http://ieeexplore.ieee.org/xpl/articleDetails.jsp?tp=&arnumber=6556444},
101 address={San Francisco, {CA}, {USA}}
102 }