Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/orthanc-explorer-2.rst @ 910:888df946c1be
preview quality
author | Alain Mazy <am@osimis.io> |
---|---|
date | Wed, 25 Jan 2023 14:15:03 +0100 |
parents | 9447f34ff010 |
children | 5a421cfaa9ff |
rev | line source |
---|---|
845 | 1 .. _orthanc-explorer-2: |
2 | |
3 | |
4 Orthanc Explorer 2 plugin | |
5 ========================= | |
6 | |
7 .. contents:: | |
8 | |
9 | |
10 Introduction | |
11 ------------ | |
12 | |
13 This plugin provides a new User Interface (UI) to Orthanc. It aims at being | |
14 more user-friendly, more configurable and more evolutive than the default | |
15 Orthanc UI which was developed mainly for testing/administrative purpose. | |
16 | |
17 .. image:: ../images/OE2-screenshot-study-list.png | |
18 :align: center | |
19 :width: 1000px | |
20 | |
21 | | |
22 | |
23 Note that a major difference between the legacy UI and Orthanc Explorer 2 (OE2) | |
24 is that OE2 works only at the study level, not the patient level. The main page is | |
25 the study list in which, of course, you can apply a filter to display only the studies of a single patient. | |
26 | |
27 | |
28 How to get it ? | |
29 --------------- | |
30 | |
31 The source code is available on `GitHub <https://github.com/orthanc-server/orthanc-explorer-2>`__. | |
32 | |
33 Binaries are included in: | |
34 | |
35 - The `osimis/orthanc Docker image <https://hub.docker.com/r/osimis/orthanc>`__ | |
36 - The `Windows Installer <https://orthanc.osimis.io/win-installer/OrthancInstaller-Win64-latest.exe>`__ (only for 64bits platform) | |
37 - The `MacOS packages <https://orthanc.osimis.io/osx/stable/orthancAndPluginsOSX.stable.zip>`__ | |
38 | |
39 Release notes are available `here <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/release-notes.md>`__. | |
40 | |
41 Depending on the configuration, the plugin can replace the default Orthanc UI you are redirected to when accessing orthanc at `http://localhost:8042/ <http://localhost:8042/>`__. | |
42 In any case, the new and old UI can coexist: | |
43 | |
44 - Orthanc Explorer 2 is available at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`__ | |
45 - Legacy UI remains available at `http://localhost:8042/app/explorer.html <http://localhost:8042/app/explorer.html>`__ | |
46 | |
47 | |
48 Configuration | |
49 ------------- | |
50 | |
51 .. highlight:: json | |
52 | |
53 The plugin must be configured through a configuration file. The minimal configuration to include in your orthanc configuration file is:: | |
54 | |
55 "OrthancExplorer2" : { | |
56 "Enable": true, | |
57 "IsDefaultOrthancUI": true | |
58 } | |
59 | |
60 There are many more options that are documented in the | |
61 `default configuration file <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/Plugin/DefaultConfiguration.json>`__. | |
62 | |
63 Main features you can configure: | |
64 | |
65 - Root URL | |
867
888d6b29245a
faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
849
diff
changeset
|
66 - Whether OE2 becomes the default Orthanc UI |
845 | 67 - Configure the side menu |
68 - Configure the actions available on the resources | |
69 - Configure the columns of the main study list | |
70 | |
71 | |
72 Advanced features | |
73 ----------------- | |
74 | |
75 You may open the OE2 interface directly on a specific study or patient by specifying DICOM Tags directly in the URL. | |
76 e.g:: | |
77 | |
869 | 78 http://localhost:8042/ui/app/#/filtered-studies?PatientID="00000169" |
845 | 79 http://localhost:8042/ui/app/#/filtered-studies?StudyDate=20220512-20220513&ModalitiesInStudy=CR\DX |
869 | 80 http://localhost:8042/ui/app/#/filtered-studies?StudyInstanceUID="1.2.3" |
81 http://localhost:8042/ui/app/#/filtered-studies?StudyInstanceUID="1.2.3"&expand | |
82 http://localhost:8042/ui/app/#/filtered-studies?StudyInstanceUID="1.2.3"&expand=study | |
83 http://localhost:8042/ui/app/#/filtered-studies?StudyInstanceUID="1.2.3"&expand=series | |
84 | |
85 By default, OE2 will add a wildcard ``*`` at the beginning and at the end of the search text. Therefore, searching | |
86 for ``PatientID=1234`` will actually search for ``PatientID=*1234*``. If you do not want to have these extra wildcards | |
87 added, you should use ``"`` at the beginning and/or at the end of the search text. Therefore, searching for | |
88 ``PatientID="1234"`` will return only the studies whose ``PatientID`` is exactly ``1234``. | |
89 These ``"`` can also be used in the User Interface search fields. | |
845 | 90 |
91 | |
92 | |
93 Roadmap | |
94 ------- | |
95 | |
96 Main elements of the roadmap are listed hereunder (not in the order of implementation): | |
97 | |
98 - Multiple language support | |
99 - Mobile friendly | |
100 - Allow edition of DICOM Tags | |
101 - Query-retrieve interface for dicom-web servers & remote DICOM servers | |
102 - Open other viewers from UI (Radiant, Osirix, MedDream, OHIF, ...) | |
103 | |
104 A full list of `ideas` is stored directly in the repository's `TODO <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/TODO>`__ | |
105 | |
106 | |
107 Bug reports & support | |
108 --------------------- | |
109 | |
110 As usual, you can get support and report issues from the `Orthanc Users group <https://groups.google.com/g/orthanc-users>`__. | |
111 | |
112 You may also directly introduce bugs or feature requests in `GitHub <https://github.com/orthanc-server/orthanc-explorer-2/issues>`__. | |
113 | |
114 The plugin is currently maintained by Alain Mazy from `Orthanc.team <https://orthanc.team/>`__ who, like many of you, enjoys | |
115 receiving a salary for his work. Feel free to hire him if you need a specific feature or bug fixed. | |
116 | |
117 Donations to `Open Collective <https://opencollective.com/orthanc>`__ may also be used to maintain/develop this plugin. |