Mercurial > hg > orthanc-book

annotate Sphinx/source/plugins/indexer.rst @ 1113:a588960a72e5 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
spelling
author Alain Mazy <am@orthanc.team>
date Mon, 28 Oct 2024 09:23:08 +0100
parents 89bb195dfbc0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
772
3971710d9d45 added indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _indexer:
3971710d9d45 added indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
3971710d9d45 added indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
4 Folder Indexer plugin
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
5 =====================
772
3971710d9d45 added indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
3971710d9d45 added indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 .. contents::
3971710d9d45 added indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
9 This **official** plugin by the `ICTEAM institute of UCLouvain
1056
89bb195dfbc0 starting stl documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1023
diff changeset
10 <https://orthanc.uclouvain.be/>`__ uses Orthanc to publish filesystems
89bb195dfbc0 starting stl documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1023
diff changeset
11 containing medical images as a DICOM modality.
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
12
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
13 The plugin continuously synchronizes the content of an Orthanc server
802
57d1b1680e71 improvement for the indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 780
diff changeset
14 with the content of a filesystem, which can then be accessed, through
57d1b1680e71 improvement for the indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 780
diff changeset
15 Orthanc, based on the :ref:`DICOM model of the real world <model-world>`.
57d1b1680e71 improvement for the indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 780
diff changeset
16 The indexed DICOM resources are immediately available in a Web
57d1b1680e71 improvement for the indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 780
diff changeset
17 interface and in a Web viewer, and can be queried/retrieved by DICOM
57d1b1680e71 improvement for the indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 780
diff changeset
18 clients. The DICOM files are **not** copied, so this solution has a
57d1b1680e71 improvement for the indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 780
diff changeset
19 very small footprint in terms of storage requirements.
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
20
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
21
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
22 Compilation
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
23 -----------
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
24
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
25 .. highlight:: bash
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
26
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
27 Official releases can be `downloaded from the Orthanc homepage
993
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 919
diff changeset
28 <https://orthanc.uclouvain.be/downloads/sources/orthanc-indexer/index.html>`__. As
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
29 an alternative, the `repository containing the source code
919
5c1ce758f748 uclouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 802
diff changeset
30 <https://orthanc.uclouvain.be/hg/orthanc-indexer/>`__ can be accessed using
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
31 Mercurial.
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
32
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
33 The procedure to compile this plugin is similar of that for the
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
34 :ref:`core of Orthanc <binaries>`. The following commands should work
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
35 for most UNIX-like distribution (including GNU/Linux)::
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
36
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
37 $ mkdir Build
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
38 $ cd Build
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
39 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
40 $ make
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
41
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
42 The compilation will produce a shared library ``OrthancIndexer``
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
43 that contains the folder indexer plugin for Orthanc.
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
44
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
45 Pre-compiled Linux Standard Base (LSB) binaries `can be downloaded
993
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 919
diff changeset
46 <https://orthanc.uclouvain.be/downloads/linux-standard-base/orthanc-indexer/index.html>`__.
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
47
993
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 919
diff changeset
48 Pre-compiled binaries for `Microsoft Windows <https://orthanc.uclouvain.be/downloads/windows-32/orthanc-indexer/index.html>`__
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 919
diff changeset
49 and `macOS <https://orthanc.uclouvain.be/downloads/macos/orthanc-indexer/index.html>`__ available as well.
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
50
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
51 Furthermore, the :ref:`Docker images <docker>`
1023
5d4701d8fe28 replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents: 993
diff changeset
52 ``jodogne/orthanc-plugins`` and ``orthancteam/orthanc`` also contain the
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
53 plugin.
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
54
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
55
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
56 Usage
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
57 -----
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
58
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
59 .. highlight:: json
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
60
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
61 Here is a minimal sample :ref:`configuration file <configuration>` to
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
62 use this plugin::
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
63
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
64 {
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
65 "Plugins" : [
779
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
66 "/home/user/OrthancIndexer/Build/libOrthancIndexer.so"
778
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
67 ],
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
68 "Indexer" : {
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
69 "Enable" : true,
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
70 "Folders" : [ "/home/user/DICOM" ], // List of folders to synchronize
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
71 "Interval" : 10 // Delay between two synchronizations
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
72 }
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
73 }
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
74
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
75 Orthanc must of course be restarted after the modification of its
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
76 configuration file.
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
77
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
78 Once Orthanc is started, the folders are transparently synchronized
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
79 without any further interaction. You can start Orthanc with the
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
80 ``--verbose-plugins`` command-line option in order to monitor the
4707c55080c8 documentation of folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
81 synchronization process.
779
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
82
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
83 Some remarks:
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
84
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
85 * This plugin cannot be used together with other custom storage area
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
86 plugins (such as :ref:`cloud object storage <object-storage>`).
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
87
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
88 * Even if the folder indexer plugin is in use, you can still add other
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
89 DICOM files using the :ref:`REST API <rest>` or the :ref:`DICOM
780
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 779
diff changeset
90 network protocol <dicom-protocol>`. Such files would be stored in
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 779
diff changeset
91 the ``OrthancStorage`` :ref:`usual folder <orthanc-storage-area>`.
779
15f017e7555b remarks about folder indexer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 778
diff changeset
92