Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins.rst @ 532:034895d2432a
vacuum
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 20 Oct 2020 20:31:03 +0200 |
parents | 5abd8869514f |
children | 109c043907a1 |
rev | line source |
---|---|
24 | 1 .. _plugins: |
2 | |
3 Plugins | |
4 ======= | |
5 | |
481
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
6 .. toctree:: |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
7 :hidden: |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
8 |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
9 plugins/authorization.rst |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
10 plugins/google-cloud-platform.rst |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
11 plugins/mysql.rst |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
12 plugins/object-storage.rst |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
13 plugins/osimis-webviewer.rst |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
14 plugins/python.rst |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
15 plugins/transfers.rst |
4f076a3b9934
unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
470
diff
changeset
|
16 |
25 | 17 .. contents:: |
18 | |
19 Overview | |
20 -------- | |
21 | |
24 | 22 The core of Orthanc can be extended through **plugins**. A plugin |
23 takes the form of a shared library (``.DLL`` under Windows, ``.so`` | |
42 | 24 under GNU/Linux, ``.dylib`` under Apple OS X...). A plugin can do |
25 various things, among others: | |
24 | 26 |
27 * Serving new **Web applications** that have full access to the REST | |
28 API of Orthanc, which makes easy to handle DICOM images from | |
29 JavaScript code. | |
30 * Replacing **the way DICOM images are decoded** (e.g. the official | |
31 :ref:`Web viewer plugin <webviewer>` introduces the decoding of | |
32 JPEG2000 images, which is not available in the core of Orthanc). | |
154 | 33 * Replacing the default **database back-end** of Orthanc (that is |
34 built upon SQLite) by another (:ref:`PostgreSQL <postgresql>`, | |
35 :ref:`MySQL <mysql>`, SQL Server...). | |
24 | 36 * Creating **new REST APIs** on the top of the Orthanc built-in API (as in |
37 in the official :ref:`DICOMweb <dicomweb>` plugin). | |
38 * **Reacting** to the arrival of new DICOM images or other | |
39 DICOM-related events so as to carry on automated processing. | |
25 | 40 * ... |
41 | |
42 Developers external to the official Orthanc project are :ref:`invited | |
38 | 43 to contribute <contributing>` to the C/C++ part of Orthanc by creating |
44 third-party plugins. A specific section of the Orthanc Book explains | |
45 :ref:`how to create new Orthanc plugins <creating-plugins>`. | |
24 | 46 |
47 .. _plugins-official: | |
48 | |
49 Index of the official plugins | |
50 ----------------------------- | |
51 | |
96
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
52 From University Hospital of Liège |
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
53 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
54 |
24 | 55 .. toctree:: |
56 :maxdepth: 1 | |
57 | |
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
58 plugins/webviewer.rst |
24 | 59 plugins/dicomweb.rst |
60 plugins/postgresql.rst | |
53 | 61 plugins/wsi.rst |
24 | 62 plugins/worklists-plugin.rst |
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
63 plugins/serve-folders.rst |
431 | 64 plugins/gdcm.rst |
24 | 65 |
229 | 66 .. _plugins-osimis: |
67 | |
96
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
68 From Osimis |
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
69 ^^^^^^^^^^^ |
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
70 |
301
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
71 * :ref:`osimis_webviewer` |
154 | 72 * :ref:`mysql` |
96
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
73 * :ref:`authorization` |
164 | 74 * :ref:`transfers` |
254 | 75 * :ref:`google` |
451 | 76 * :ref:`python-plugin` |
77 * :ref:`object-storage` | |
24 | 78 |
79 .. _plugins-contributed: | |
80 | |
81 Index of the contributed plugins | |
82 -------------------------------- | |
83 | |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
84 C/C++ plugins |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
85 ^^^^^^^^^^^^^ |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
86 |
163 | 87 * `AWS S3 storage plugin |
88 <https://github.com/radpointhq/orthanc-s3-storage>`__: This plugin | |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
341
diff
changeset
|
89 by `Radpoint <https://radpoint.pl/>`__ makes Orthanc store its |
163 | 90 DICOM files into an `Amazon S3 bucket |
91 <https://en.wikipedia.org/wiki/Amazon_S3>`__. | |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
92 |
24 | 93 * `DWV Orthanc Plugin |
94 <https://github.com/ivmartel/dwv-orthanc-plugin>`__: This plugin by | |
95 Yves Martelli is based on `dwv | |
96 <https://github.com/ivmartel/dwv/wiki>`__ and extends Orthanc with a | |
97 Web viewer of DICOM images. | |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
98 |
24 | 99 * Another Web viewer is provided courtesy of `Emsy Chan |
25 | 100 <https://groups.google.com/d/msg/orthanc-users/EC5Z2KaM4Hs/MG3KkzhCDAAJ>`__. |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
101 |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
341
diff
changeset
|
102 * `VPI Reveal <https://www.vpireveal.com/>`__ provides a plugin to |
71 | 103 "write the DICOM records in a normal Windows-readable file hierarchy |
70 | 104 (patient-study-series-DICOM file) at a location called |
105 ``VPIStorage`` that can then be imported into VPI Reveal." `Check | |
71 | 106 out their source code |
70 | 107 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins/orthancVPIRevealPlugin>`__. |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
108 |
93 | 109 * `Doc Cirrus <https://www.doc-cirrus.com/>`__ is working on `MongoDB |
115 | 110 <https://en.wikipedia.org/wiki/MongoDB>`__ database plugins. Check |
111 out their `source code | |
112 <https://github.com/Doc-Cirrus/orthanc-mongodb>`__ and the | |
113 `associated description | |
114 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins/orthanc-mongodb>`__. | |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
115 |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
116 Python plugins |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
117 ^^^^^^^^^^^^^^ |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
118 |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
119 * Julian Hartig maintains a `Python plugin |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
120 <https://github.com/crispinus2/orthanc-gdt>`__ called |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
121 ``orthanc-gdt``, in order to glue Orthanc to the `GDT interface most |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
122 German AIS <https://en.wikipedia.org/wiki/XDT>`__ |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
123 (Arztinformationssysteme - as opposed to e.g. the RIS used by |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
124 radiologists) use for communicating with external applications and |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
125 devices. This topic is further discussed on the `Orthanc Users forum |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
126 <https://groups.google.com/d/msg/orthanc-users/NO7MnWzKsAc/5hEVxymWBQAJ>`__. |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
127 |
486 | 128 * Stephen Douglas Scotti maintains a `Python plugin |
129 <https://github.com/sscotti/OrthancBrowser>`__ to implement | |
130 pagination on one Orthanc server. | |
131 | |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
132 |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
133 Other |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
134 ^^^^^ |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
135 |
40 | 136 * Check out the `OrthancContributed repository on GitHub |
137 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`__, that | |
138 might contain plugins that are not tracked in this list. | |
24 | 139 |
470
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
140 * **Important:** Do not hesitate to `contact us |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
141 <https://www.orthanc-server.com/static.php?page=contact>`__ if you |
90e6c20cef1e
indexing orthanc-gdt python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
451
diff
changeset
|
142 have developed a plugin so that we can promote it in the list above! |