Mercurial > hg > orthanc-book

annotate Sphinx/source/plugins.rst @ 96:750f7ab733c1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
start documentation of authorization
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 22 Mar 2017 16:45:42 +0100
parents a1e55e1baf38
children 75bd7c364d9f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _plugins:
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 Plugins
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 =======
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
6 .. contents::
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
7
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
8 Overview
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
9 --------
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
10
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 The core of Orthanc can be extended through **plugins**. A plugin
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 takes the form of a shared library (``.DLL`` under Windows, ``.so``
42
a52f1dc48ebc GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 40
diff changeset
13 under GNU/Linux, ``.dylib`` under Apple OS X...). A plugin can do
a52f1dc48ebc GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 40
diff changeset
14 various things, among others:
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * Serving new **Web applications** that have full access to the REST
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 API of Orthanc, which makes easy to handle DICOM images from
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 JavaScript code.
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * Replacing **the way DICOM images are decoded** (e.g. the official
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 :ref:`Web viewer plugin <webviewer>` introduces the decoding of
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 JPEG2000 images, which is not available in the core of Orthanc).
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * Replacing the default **database back-end** of Orthanc (that is built
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 upon SQLite) by another (:ref:`PostgreSQL <postgresql>`, MySQL, SQL Server...).
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * Creating **new REST APIs** on the top of the Orthanc built-in API (as in
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 in the official :ref:`DICOMweb <dicomweb>` plugin).
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * **Reacting** to the arrival of new DICOM images or other
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 DICOM-related events so as to carry on automated processing.
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
28 * ...
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
29
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
30 Developers external to the official Orthanc project are :ref:`invited
38
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 31
diff changeset
31 to contribute <contributing>` to the C/C++ part of Orthanc by creating
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 31
diff changeset
32 third-party plugins. A specific section of the Orthanc Book explains
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 31
diff changeset
33 :ref:`how to create new Orthanc plugins <creating-plugins>`.
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 .. _plugins-official:
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 Index of the official plugins
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 -----------------------------
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
96
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
40 From University Hospital of Liège
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
41 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
42
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 .. toctree::
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 :maxdepth: 1
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
31
93bbfaf0e62c worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 25
diff changeset
46 plugins/webviewer.rst
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 plugins/dicomweb.rst
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 plugins/postgresql.rst
53
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 42
diff changeset
49 plugins/wsi.rst
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 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
51 plugins/serve-folders.rst
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
96
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
53 From Osimis
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
54 ^^^^^^^^^^^
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
55
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
56 * :ref:`authorization`
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
57 * `Osimis <http://osimis.io/>`__ maintains an evolution of the
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
58 official Web viewer plugin. The Osimis plugin adds tools for
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
59 measuring, for viewing multiple series, and for split-pane. `Check
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
60 out the source code
750f7ab733c1 start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 93
diff changeset
61 <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__.
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 .. _plugins-contributed:
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 Index of the contributed plugins
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 --------------------------------
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 * `DWV Orthanc Plugin
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 <https://github.com/ivmartel/dwv-orthanc-plugin>`__: This plugin by
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 Yves Martelli is based on `dwv
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 <https://github.com/ivmartel/dwv/wiki>`__ and extends Orthanc with a
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 Web viewer of DICOM images.
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 * Another Web viewer is provided courtesy of `Emsy Chan
25
669ea65ba7fb fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
74 <https://groups.google.com/d/msg/orthanc-users/EC5Z2KaM4Hs/MG3KkzhCDAAJ>`__.
71
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 70
diff changeset
75 * `VPI Reveal <http://www.vpireveal.com/>`__ provides a plugin to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 70
diff changeset
76 "write the DICOM records in a normal Windows-readable file hierarchy
70
bcd9e83dac7a index VPI Reveal
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 53
diff changeset
77 (patient-study-series-DICOM file) at a location called
bcd9e83dac7a index VPI Reveal
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 53
diff changeset
78 ``VPIStorage`` that can then be imported into VPI Reveal." `Check
71
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 70
diff changeset
79 out their source code
70
bcd9e83dac7a index VPI Reveal
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 53
diff changeset
80 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins/orthancVPIRevealPlugin>`__.
93
a1e55e1baf38 mongodb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 71
diff changeset
81 * `Doc Cirrus <https://www.doc-cirrus.com/>`__ is working on `MongoDB
a1e55e1baf38 mongodb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 71
diff changeset
82 <https://en.wikipedia.org/wiki/MongoDB>`__ database plugins. `Check
a1e55e1baf38 mongodb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 71
diff changeset
83 out their source code
a1e55e1baf38 mongodb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 71
diff changeset
84 <https://github.com/Doc-Cirrus/orthanc-mongodb>`__.
40
99b45a963bcf contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 38
diff changeset
85 * Check out the `OrthancContributed repository on GitHub
99b45a963bcf contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 38
diff changeset
86 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`__, that
99b45a963bcf contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 38
diff changeset
87 might contain plugins that are not tracked in this list.
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
38
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 31
diff changeset
89 *Remark:* Do not hesitate to `contact us
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 31
diff changeset
90 <http://www.orthanc-server.com/static.php?page=contact>`__ if you have
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 31
diff changeset
91 developed a plugin so that we can include it in the list above!