changeset 150:71d8ce7ff295

Merged in integrations-osirix-horos (pull request #5) Integrations osirix horos
author Sébastien Jodogne <s.jodogne@gmail.com>
date Tue, 29 May 2018 09:40:28 +0000
parents 2f871e5728fe (current diff) bc5906892316 (diff)
children 8753cd3e6735
files
diffstat 7 files changed, 205 insertions(+), 42 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/faq/query-retrieve.rst	Tue May 29 08:44:41 2018 +0200
+++ b/Sphinx/source/faq/query-retrieve.rst	Tue May 29 09:40:28 2018 +0000
@@ -20,45 +20,5 @@
 If you encounter configuration problem with query/retrieve, please be
 sure to read the :ref:`dicom-move` section.
 
-
-.. _ginkgo-cadx:
-
-Illustration: Ginkgo CADx
--------------------------
-
-This section explains how to connect the `Ginkgo CADx viewer
-<http://ginkgo-cadx.com/en/>`__ to an Orthanc server, both running on
-the local computer. First, start Orthanc without specifying a
-configuration file (i.e. using its default configuration).  Then, open
-the settings pannel of Ginkgo CADx:
-
-.. image:: ../images/GinkgoCADx1.png
-           :align: center
-           :width: 500px
-
-Write down the AET and the DICOM port of Ginkgo CADx (in this case,
-respectively ``GINKGO_001`` and ``11112``). Then, create a new DICOM
-node corresponding to Orthanc by clicking on the "*New...*" button,
-which raises the following dialog box:
-
-.. image:: ../images/GinkgoCADx2.png
-           :align: center
-           :width: 400px
-
-.. highlight:: json
-
-Complete the highlighted fields with the default parameters of
-Orthanc, as shown in the screenshot.  Do not forget to click on the
-"*Test connection*" button to make sure the :ref:`C-Echo <dicom-echo>`
-succeeds. Stop Orthanc, create a new :ref:`configuration file
-<configuration>`, and declare Gingko CADx in the ``DicomModalities``
-section, given the parameters you wrote down above::
-
-  // The list of the known DICOM modalities
-  "DicomModalities" : {
-    "ginkgo" : [ "GINKGO_001", "localhost", 11112 ]
-  },
-
-Restart Orthanc using this newly created configuration file, and
-you will be able to do query/retrieve from Gingko CADx through the
-"*PACS Q/R*" menu.
+For examples specific to well-known applications, check out the
+:ref:`integrations` section.
--- a/Sphinx/source/index.rst	Tue May 29 08:44:41 2018 +0200
+++ b/Sphinx/source/index.rst	Tue May 29 09:40:28 2018 +0000
@@ -19,5 +19,6 @@
    dicom-guide.rst
    plugins.rst
    developers.rst
+   integrations.rst
    faq.rst
    contributing.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/integrations.rst	Tue May 29 09:40:28 2018 +0000
@@ -0,0 +1,12 @@
+.. _integrations:
+
+Integrations
+============
+
+.. toctree::
+   :maxdepth: 1
+
+   integrations/ginkgo-cadx.rst
+   integrations/integrate-horos-using-dicom.rst
+   integrations/integrate-osirix-using-dicom.rst
+   integrations/integrate-osirix-using-dicomweb.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/integrations/ginkgo-cadx.rst	Tue May 29 09:40:28 2018 +0000
@@ -0,0 +1,41 @@
+.. _ginkgo-cadx:
+
+Ginkgo CADx
+===========
+
+This section explains how to connect the `Ginkgo CADx viewer
+<http://ginkgo-cadx.com/en/>`__ to an Orthanc server, both running on
+the local computer. First, start Orthanc without specifying a
+configuration file (i.e. using its default configuration).  Then, open
+the settings pannel of Ginkgo CADx:
+
+.. image:: ../images/GinkgoCADx1.png
+           :align: center
+           :width: 500px
+
+Write down the AET and the DICOM port of Ginkgo CADx (in this case,
+respectively ``GINKGO_001`` and ``11112``). Then, create a new DICOM
+node corresponding to Orthanc by clicking on the "*New...*" button,
+which raises the following dialog box:
+
+.. image:: ../images/GinkgoCADx2.png
+           :align: center
+           :width: 400px
+
+.. highlight:: json
+
+Complete the highlighted fields with the default parameters of
+Orthanc, as shown in the screenshot.  Do not forget to click on the
+"*Test connection*" button to make sure the :ref:`C-Echo <dicom-echo>`
+succeeds. Stop Orthanc, create a new :ref:`configuration file
+<configuration>`, and declare Gingko CADx in the ``DicomModalities``
+section, given the parameters you wrote down above::
+
+  // The list of the known DICOM modalities
+  "DicomModalities" : {
+    "ginkgo" : [ "GINKGO_001", "localhost", 11112 ]
+  },
+
+Restart Orthanc using this newly created configuration file, and
+you will be able to do query/retrieve from Gingko CADx through the
+"*PACS Q/R*" menu.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/integrations/integrate-horos-using-dicom.rst	Tue May 29 09:40:28 2018 +0000
@@ -0,0 +1,48 @@
+.. _integrate-horos-using-dicom:
+
+Integrate Horos using DICOM
+===========================
+
+Configuration of Horos
+-----------------------
+
+- In ``Preferences->Listener``, activate and configure AETitle and Port (e.g. Horos 11112).
+- In ``Preferences->Locations``, add a DICOM Node:
+
+  - with the AET of your Orthanc instance (default is ``ORTHANC``)
+  - with a name (eg ``MYORTHANC``)
+  - with Retrieve method C-GET
+  - with Send Transfers syntax : Explicit Little Endian
+
+
+Configuration of Orthanc
+------------------------
+
+Add the following :ref:`configuration options <configuration>`
+(obviously, adapt the IP address)::
+
+  {
+    "DicomModalities" : {
+      "Horos": [ "Horos", "192.168.253.53", 11112 ]
+    }
+  }
+
+
+Configuration of Docker images by Osimis
+----------------------------------------
+
+This section applies if you are using the `Docker images by Osimis
+<https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images>`__
+to run Orthanc.
+
+Add Modality through Environmental variable in docker::
+
+  DICOM_MODALITIES=
+  {
+    "Horos": ["Horos", "192.168.253.53", 11112]
+  }
+
+If using Orthanc in a docker container, map the Orthanc DICOM Port. Eg in docker-compose file::
+
+  ports:
+    - "4242:4242"
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/integrations/integrate-osirix-using-dicom.rst	Tue May 29 09:40:28 2018 +0000
@@ -0,0 +1,48 @@
+.. _integrate-osirix-using-dicom:
+
+Integrate Osirix using DICOM
+============================
+
+Configuration of Osirix
+-----------------------
+
+- In ``Preferences->Listener``, activate and configure AETitle and Port (e.g. Osirix 11112).
+- In ``Preferences->Locations``, add a DICOM Node:
+
+  - with the AET of your Orthanc instance (default is ``ORTHANC``)
+  - with a name (eg ``MYORTHANC``)
+  - with Retrieve method C-GET
+  - with Send Transfers syntax : Explicit Little Endian
+
+
+Configuration of Orthanc
+------------------------
+
+Add the following :ref:`configuration options <configuration>`
+(obviously, adapt the IP address)::
+
+  {
+    "DicomModalities" : {
+      "Horos": [ "Horos", "192.168.253.53", 11112 ]
+    }
+  }
+
+
+Configuration of Docker images by Osimis
+----------------------------------------
+
+This section applies if you are using the `Docker images by Osimis
+<https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images>`__
+to run Orthanc.
+
+Add Modality through Environmental variable in docker::
+
+  DICOM_MODALITIES=
+  {
+    "Osirix": ["Osirix", "192.168.253.53", 11112]
+  }
+
+If using Orthanc in a docker container, map the Orthanc DICOM Port. Eg in docker-compose file::
+
+  ports:
+    - "4242:4242"
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/integrations/integrate-osirix-using-dicomweb.rst	Tue May 29 09:40:28 2018 +0000
@@ -0,0 +1,53 @@
+.. _integrate-osirix-using-dicomweb:
+
+Integrate Osirix using DICOMWeb
+===============================
+
+Configuration of Osirix
+-----------------------
+
+- In ``Preferences->Listener``, activate and configure AETitle and Port (e.g. Osirix 11112)
+- In ``Preferences->Locations->DICOMWeb Node``, add a DICOM Node:
+
+  - with the URL of the Orthanc server
+  - with the DICOMweb API path of Orthanc (default is ``/dicom-web``)
+  - with a name (eg ``MYORTHANC``)
+  - with Q&R activated
+  - without authentication
+  - with Send Transfers syntax : Explicit Little Endian
+
+
+Configuration of Orthanc
+------------------------
+
+First, make sure to :ref:`install and enable the DICOMweb plugin <dicomweb>`.
+
+Adapt the following :ref:`configuration options <configuration>`
+(obviously, adapt the IP address)::
+
+  {
+    "Plugins" : [ /* fill the path to the DICOMweb plugin */ ],
+    "RemoteAccessEnabled" : true,
+    "DicomWeb" : {
+      "Enable" : true,
+      "Root" : "/dicom-web/"
+    }
+  }
+
+
+
+Configuration of Docker images by Osimis
+----------------------------------------
+
+This section applies if you are using the `Docker images by Osimis
+<https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images>`__
+to run Orthanc.
+
+Make sure Orthanc has the Dicom Web protocol enabled::
+
+  DW_ENABLED: "true"
+
+If using Orthanc in a docker container, map the Orthanc DICOMWeb Http Port. Eg in docker-compose file::
+
+  ports:
+    - "4242:4242"