Mercurial > hg > orthanc-book
view Sphinx/source/plugins.rst @ 209:0ba37a21e5ec dfslezak/restrst-edited-online-with-bitbucket-add-1550282269472
closing
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 16 Feb 2019 11:14:58 +0100 |
parents | b79ef7808f16 |
children | c74f044dc3ce |
line wrap: on
line source
.. _plugins: Plugins ======= .. contents:: Overview -------- The core of Orthanc can be extended through **plugins**. A plugin takes the form of a shared library (``.DLL`` under Windows, ``.so`` under GNU/Linux, ``.dylib`` under Apple OS X...). A plugin can do various things, among others: * Serving new **Web applications** that have full access to the REST API of Orthanc, which makes easy to handle DICOM images from JavaScript code. * Replacing **the way DICOM images are decoded** (e.g. the official :ref:`Web viewer plugin <webviewer>` introduces the decoding of JPEG2000 images, which is not available in the core of Orthanc). * Replacing the default **database back-end** of Orthanc (that is built upon SQLite) by another (:ref:`PostgreSQL <postgresql>`, :ref:`MySQL <mysql>`, SQL Server...). * Creating **new REST APIs** on the top of the Orthanc built-in API (as in in the official :ref:`DICOMweb <dicomweb>` plugin). * **Reacting** to the arrival of new DICOM images or other DICOM-related events so as to carry on automated processing. * ... Developers external to the official Orthanc project are :ref:`invited to contribute <contributing>` to the C/C++ part of Orthanc by creating third-party plugins. A specific section of the Orthanc Book explains :ref:`how to create new Orthanc plugins <creating-plugins>`. .. _plugins-official: Index of the official plugins ----------------------------- From University Hospital of Liège ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. toctree:: :maxdepth: 1 plugins/webviewer.rst plugins/dicomweb.rst plugins/postgresql.rst plugins/wsi.rst plugins/worklists-plugin.rst plugins/serve-folders.rst From Osimis ^^^^^^^^^^^ * :ref:`mysql` * :ref:`authorization` * :ref:`transfers` * `Osimis <http://osimis.io/>`__ maintains an evolution of the official Web viewer plugin. The Osimis plugin adds tools for measuring, for viewing multiple series, and for split-pane. `Check out the source code <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__. .. _plugins-contributed: Index of the contributed plugins -------------------------------- * `AWS S3 storage plugin <https://github.com/radpointhq/orthanc-s3-storage>`__: This plugin by `Radpoint <https://www.radpoint.pl/>`__ makes Orthanc store its DICOM files into an `Amazon S3 bucket <https://en.wikipedia.org/wiki/Amazon_S3>`__. * `DWV Orthanc Plugin <https://github.com/ivmartel/dwv-orthanc-plugin>`__: This plugin by Yves Martelli is based on `dwv <https://github.com/ivmartel/dwv/wiki>`__ and extends Orthanc with a Web viewer of DICOM images. * Another Web viewer is provided courtesy of `Emsy Chan <https://groups.google.com/d/msg/orthanc-users/EC5Z2KaM4Hs/MG3KkzhCDAAJ>`__. * `VPI Reveal <http://www.vpireveal.com/>`__ provides a plugin to "write the DICOM records in a normal Windows-readable file hierarchy (patient-study-series-DICOM file) at a location called ``VPIStorage`` that can then be imported into VPI Reveal." `Check out their source code <https://github.com/jodogne/OrthancContributed/tree/master/Plugins/orthancVPIRevealPlugin>`__. * `Doc Cirrus <https://www.doc-cirrus.com/>`__ is working on `MongoDB <https://en.wikipedia.org/wiki/MongoDB>`__ database plugins. Check out their `source code <https://github.com/Doc-Cirrus/orthanc-mongodb>`__ and the `associated description <https://github.com/jodogne/OrthancContributed/tree/master/Plugins/orthanc-mongodb>`__. * Check out the `OrthancContributed repository on GitHub <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`__, that might contain plugins that are not tracked in this list. *Remark:* Do not hesitate to `contact us <http://www.orthanc-server.com/static.php?page=contact>`__ if you have developed a plugin so that we can promote it in the list above!