annotate README.md @ 1481:970ee51fe01f

fix comment
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 19 Jun 2020 18:43:09 +0200
parents c53a4667f895
children 0cbc85e0c583
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 Stone of Orthanc
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 ================
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 General Information
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 -------------------
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 This repository contains the source code of the Stone of Orthanc.
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 Stone of Orthanc is a lightweight, cross-platform C++ framework for
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 the CPU-based rendering of medical images. It notably features support
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 for MPR (multiplanar reconstruction of volume images), PET-CT fusion,
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 and accurate physical world coordinates.
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 Stone of Orthanc comes bundled with its own software-based rendering
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 engine (based upon pixman). This engine will use CPU hardware
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 acceleration if available (notably SSE2, SSSE3, and NEON instruction
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 sets), but not the GPU. This makes Stone a highly versatile framework
9
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
18 that can run even on low-performance platforms. Note that Stone is
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
19 able to display DICOM series without having to entirely store them in
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
20 the RAM (i.e. frame by frame).
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
21
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
22 Thanks to its standalone rendering engine, Stone of Orthanc is also
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
23 compatible with any GUI framework (such as Qt, wxWidgets, MFC...). The
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
24 provided sample applications use the SDL framework.
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
9
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
26 Stone is conceived as a companion toolbox to the Orthanc VNA (vendor
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
27 neutral archive, i.e. DICOM server). As a consequence, Stone will
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
28 smoothly interface with Orthanc out of the box. Interestingly, Stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
29 does not contain any DICOM toolkit: It entirely relies on the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
30 of Orthanc to parse/decode DICOM images. However, thanks to the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
31 object-oriented architecture of Stone, it is possible to avoid this
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
32 dependency upon Orthanc, e.g. to download DICOM datasets using
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4
diff changeset
33 DICOMweb.
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 Comparison
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 ----------
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 Pay attention to the fact that Stone of Orthanc is a toolkit, and not
1
2dbe613f6c93 add orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
40 a fully-featured application for the visualization of medical images
2dbe613f6c93 add orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
41 (such as Horos/OsiriX or Ginkgo CADx). However, such applications
445
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
42 can be built on the top of Stone of Orthanc.
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 Stone of Orthanc is quite similar to two other well-known toolkits:
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 * Cornerstone, a client-side JavaScript toolkit to display medical
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 images in Web browsers, by Chris Hafey <chafey@gmail.com>:
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 https://github.com/chafey/cornerstone
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 Contrarily to Cornerstone, Stone of Orthanc can be embedded into
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 native, heavyweight applications.
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 * VTK, a C++ toolkit for scientific visualization, by Kitware:
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 http://www.vtk.org/
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 Contrarily to VTK, Stone of Orthanc is focused on CPU-based, 2D
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 rendering: The GPU will not be used.
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 Dependencies
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 ------------
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 Stone of Orthanc is based upon the following projects:
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 * Orthanc, a lightweight Vendor Neutral Archive (DICOM server):
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 http://www.orthanc-server.com/
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 * Cairo and pixman, a cross-platform 2D graphics library:
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 https://www.cairographics.org/
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 * Optionally, SDL, a cross-platform multimedia library:
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 https://www.libsdl.org/
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
445
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
74 Prerequisites to compile natively on Ubuntu:
222
84844649a8fd continued: reusable applications
am@osimis.io
parents: 211
diff changeset
75 ```
84844649a8fd continued: reusable applications
am@osimis.io
parents: 211
diff changeset
76 sudo apt-get install -y libcairo-dev libpixman-1-dev libsdl2-dev
84844649a8fd continued: reusable applications
am@osimis.io
parents: 211
diff changeset
77 ```
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
445
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
79 The emscripten SDK is required for the WASM build. Please install it
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
80 in `~/apps/emsdk`. If you wish to use it in another way, please edit
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
81 the `build-wasm.sh` file.
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
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
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
85 Installation and usage ----------------------
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 Build instructions are similar to that of Orthanc:
460
4d8ac609fc33 fix link
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 295
diff changeset
88 http://book.orthanc-server.com/faq/compiling.html
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
41
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 9
diff changeset
90 Usage details are available as part of the Orthanc Book:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 9
diff changeset
91 http://book.orthanc-server.com/developers/stone.html
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 9
diff changeset
92
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
ee41b6a017d7 dumb change
bgo-osimis
parents: 295
diff changeset
98
265
30dc6e383b0b documented how to build the native sample
am@osimis.io
parents: 264
diff changeset
99
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 Licensing
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 ---------
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102
49
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 41
diff changeset
103 Stone of Orthanc is licensed under the AGPL license.
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 We also kindly ask scientific works and clinical studies that make
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 use of Orthanc to cite Orthanc in their associated publications.
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 Similarly, we ask open-source and closed-source products that make
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 use of Orthanc to warn us about this use. You can cite our work
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 using the following BibTeX entry:
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
210
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
111 @Article{Jodogne2018,
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
112 author="Jodogne, S{\'e}bastien",
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
113 title="The {O}rthanc Ecosystem for Medical Imaging",
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
114 journal="Journal of Digital Imaging",
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
115 year="2018",
211
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 210
diff changeset
116 month="Jun",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 210
diff changeset
117 day="01",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 210
diff changeset
118 volume="31",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 210
diff changeset
119 number="3",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 210
diff changeset
120 pages="341--352",
210
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
121 issn="1618-727X",
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
122 doi="10.1007/s10278-018-0082-y",
101e487cd154 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 49
diff changeset
123 url="https://doi.org/10.1007/s10278-018-0082-y"
0
351ab0da0150 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 }
501
8424b10df93a Dummy change
bgo-osimis
parents: 466
diff changeset
125