Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins.rst @ 400:f6464ae6342b
fix links in docker-osimis
| author | Alain Mazy <alain@mazy.be> |
|---|---|
| date | Thu, 23 Apr 2020 12:56:55 +0200 |
| parents | 011b01ccf52d |
| children | 83f36bc9e725 |
| rev | line source |
|---|---|
| 24 | 1 .. _plugins: |
| 2 | |
| 3 Plugins | |
| 4 ======= | |
| 5 | |
| 25 | 6 .. contents:: |
| 7 | |
| 8 Overview | |
| 9 -------- | |
| 10 | |
| 24 | 11 The core of Orthanc can be extended through **plugins**. A plugin |
| 12 takes the form of a shared library (``.DLL`` under Windows, ``.so`` | |
| 42 | 13 under GNU/Linux, ``.dylib`` under Apple OS X...). A plugin can do |
| 14 various things, among others: | |
| 24 | 15 |
| 16 * Serving new **Web applications** that have full access to the REST | |
| 17 API of Orthanc, which makes easy to handle DICOM images from | |
| 18 JavaScript code. | |
| 19 * Replacing **the way DICOM images are decoded** (e.g. the official | |
| 20 :ref:`Web viewer plugin <webviewer>` introduces the decoding of | |
| 21 JPEG2000 images, which is not available in the core of Orthanc). | |
| 154 | 22 * Replacing the default **database back-end** of Orthanc (that is |
| 23 built upon SQLite) by another (:ref:`PostgreSQL <postgresql>`, | |
| 24 :ref:`MySQL <mysql>`, SQL Server...). | |
| 24 | 25 * Creating **new REST APIs** on the top of the Orthanc built-in API (as in |
| 26 in the official :ref:`DICOMweb <dicomweb>` plugin). | |
| 27 * **Reacting** to the arrival of new DICOM images or other | |
| 28 DICOM-related events so as to carry on automated processing. | |
| 25 | 29 * ... |
| 30 | |
| 31 Developers external to the official Orthanc project are :ref:`invited | |
| 38 | 32 to contribute <contributing>` to the C/C++ part of Orthanc by creating |
| 33 third-party plugins. A specific section of the Orthanc Book explains | |
| 34 :ref:`how to create new Orthanc plugins <creating-plugins>`. | |
| 24 | 35 |
| 36 .. _plugins-official: | |
| 37 | |
| 38 Index of the official plugins | |
| 39 ----------------------------- | |
| 40 | |
|
96
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
41 From University Hospital of Liège |
|
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
42 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
43 |
| 24 | 44 .. toctree:: |
| 45 :maxdepth: 1 | |
| 46 | |
|
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
47 plugins/webviewer.rst |
| 24 | 48 plugins/dicomweb.rst |
| 49 plugins/postgresql.rst | |
| 53 | 50 plugins/wsi.rst |
| 24 | 51 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
|
52 plugins/serve-folders.rst |
| 24 | 53 |
| 229 | 54 .. _plugins-osimis: |
| 55 | |
|
96
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
56 From Osimis |
|
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
57 ^^^^^^^^^^^ |
|
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
58 |
|
301
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
59 * :ref:`osimis_webviewer` |
| 154 | 60 * :ref:`mysql` |
|
96
750f7ab733c1
start documentation of authorization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
93
diff
changeset
|
61 * :ref:`authorization` |
| 164 | 62 * :ref:`transfers` |
| 254 | 63 * :ref:`google` |
|
341
d1f00afca0fb
adding blank page for the Python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
301
diff
changeset
|
64 * :ref:`python-plugin` |
| 24 | 65 |
| 66 .. _plugins-contributed: | |
| 67 | |
| 68 Index of the contributed plugins | |
| 69 -------------------------------- | |
| 70 | |
| 163 | 71 * `AWS S3 storage plugin |
| 72 <https://github.com/radpointhq/orthanc-s3-storage>`__: This plugin | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
341
diff
changeset
|
73 by `Radpoint <https://radpoint.pl/>`__ makes Orthanc store its |
| 163 | 74 DICOM files into an `Amazon S3 bucket |
| 75 <https://en.wikipedia.org/wiki/Amazon_S3>`__. | |
| 24 | 76 * `DWV Orthanc Plugin |
| 77 <https://github.com/ivmartel/dwv-orthanc-plugin>`__: This plugin by | |
| 78 Yves Martelli is based on `dwv | |
| 79 <https://github.com/ivmartel/dwv/wiki>`__ and extends Orthanc with a | |
| 80 Web viewer of DICOM images. | |
| 81 * Another Web viewer is provided courtesy of `Emsy Chan | |
| 25 | 82 <https://groups.google.com/d/msg/orthanc-users/EC5Z2KaM4Hs/MG3KkzhCDAAJ>`__. |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
341
diff
changeset
|
83 * `VPI Reveal <https://www.vpireveal.com/>`__ provides a plugin to |
| 71 | 84 "write the DICOM records in a normal Windows-readable file hierarchy |
| 70 | 85 (patient-study-series-DICOM file) at a location called |
| 86 ``VPIStorage`` that can then be imported into VPI Reveal." `Check | |
| 71 | 87 out their source code |
| 70 | 88 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins/orthancVPIRevealPlugin>`__. |
| 93 | 89 * `Doc Cirrus <https://www.doc-cirrus.com/>`__ is working on `MongoDB |
| 115 | 90 <https://en.wikipedia.org/wiki/MongoDB>`__ database plugins. Check |
| 91 out their `source code | |
| 92 <https://github.com/Doc-Cirrus/orthanc-mongodb>`__ and the | |
| 93 `associated description | |
| 94 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins/orthanc-mongodb>`__. | |
| 40 | 95 * Check out the `OrthancContributed repository on GitHub |
| 96 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`__, that | |
| 97 might contain plugins that are not tracked in this list. | |
| 24 | 98 |
| 38 | 99 *Remark:* Do not hesitate to `contact us |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
341
diff
changeset
|
100 <https://www.orthanc-server.com/static.php?page=contact>`__ if you have |
| 203 | 101 developed a plugin so that we can promote it in the list above! |