Mercurial > hg > orthanc-stone
annotate Applications/StoneWebViewer/NOTES.txt @ 1709:2931f5e15320
download study from Stone Web viewer
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 30 Nov 2020 15:36:40 +0100 |
parents | eb59fbee071e |
children | 1952162474c3 |
rev | line source |
---|---|
1691
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
3 Differences with Osimis Web viewer |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
4 ================================== |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
5 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
6 - The images are retrieved using DICOMweb. |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
7 |
1702
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
8 |
1708 | 9 - In the Stone Web viewer, the individual instances are loaded on |
10 need, in order to reduce the use of the network bandwidth. This | |
11 contrasts with the Osimis Web viewer that loads the entire images in | |
12 background. | |
13 | |
14 | |
1709
2931f5e15320
download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1708
diff
changeset
|
15 - Contrarily to the Osimis Web viewer, the Stone Web viewer doesn't |
2931f5e15320
download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1708
diff
changeset
|
16 currently support annotations, and will not support Live Share. |
2931f5e15320
download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1708
diff
changeset
|
17 |
2931f5e15320
download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1708
diff
changeset
|
18 |
1691
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
19 - The Stone Web viewer uses the DICOM identifiers. The Osimis Web |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
20 viewer the Orthanc identifiers. |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
21 https://book.orthanc-server.com/faq/orthanc-ids.html |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
22 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
23 In the Stone Web viewer, the studies are indexed by their "Study |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
24 Instance UID" tag (0020,000d). The series are indexed by their |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
25 "Series Instance UID" tag (0020,000e). To open a single series, |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
26 the parent study must be provided. |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
27 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
28 To open a single study: |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
29 http://.../index.html?study=<StudyInstanceUID> |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
30 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
31 To open a single series: |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
32 http://.../index.html?study=<StudyInstanceUID>&series=<SeriesInstanceUID> |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
33 |
1702
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
34 |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
35 - In the Osimis Web viewer, the "OpenAllPatientStudies" configuration |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
36 option can be provided to search Orthanc for all studies from |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
37 patients with the same PatientID as the selected study, then display |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
38 them. |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
39 |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
40 In the Stone Web viewer, the "OpenAllPatientStudies" configuration |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
41 option is replaced by the single "patient" GET argument. This option |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
42 contains a comma-separated list of "Patient ID" tag (0010,0020). |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
43 |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
44 To open all the studies of one patient: |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
45 http://.../index.html?patient=<PatientID> |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
46 |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
47 To open all the studies of several patients: |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
48 http://.../index.html?patient=<PatientID1>,<PatientID2>,... |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
49 |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
50 |
1692
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
51 - In the Osimis Web viewer, the "pickableStudyIds" parameter in the |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
52 URL defines the list of studies that are available for display, and |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
53 that are listed in the dropdown at the top-left of the interface. |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
54 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
55 In the Stone Web viewer, "pickableStudyIds" is replaced by the |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
56 single "study" GET argument, that is allowed to contain a |
1702
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
57 comma-separated list of studies. The "series" parameter must not be |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
58 provided in this case. |
1691
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
59 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
60 To open a list of studies: |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
61 http://.../index.html?study=<StudyInstanceUID1>,<StudyInstanceUID2>,... |
1702
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
62 |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
63 |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
64 - In the Osimis Web viewer, the "selectedStudyIds" parameter in the |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
65 URL defines the list of studies that are selected in the dropdown at |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
66 the top-left corner of the viewer (those studies are therefore |
bc40b6450261
"patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1696
diff
changeset
|
67 displayed when the viewer starts). |
1692
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
68 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
69 In the Stone Web viewer, "selectedStudyIds" is replaced by the |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
70 "selectedStudies" GET argument, that is allowed to contain a |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
71 comma-separated list of studies. |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
72 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
73 To make a list of studies available, but display only one of those |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
74 studies when the viewer starts: |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
75 http://.../index.html?study=<StudyInstanceUID1>,<StudyInstanceUID2>,...&selectedStudies=<StudyInstanceUID1> |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
76 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
77 If the "selectedStudies" is not provided, then all the studies are |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
78 displayed at the startup. |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
79 |
1696
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
80 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
81 Dynamic actions using messages |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
82 ============================== |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
83 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
84 Some actions can be dynamically triggered in the Stone Web viewer from |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
85 another Web page. This is done by using the "window.postMessage()" |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
86 primitive of JavaScript: |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
87 https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
88 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
89 Each message must be a JSON object containing at least the "type" |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
90 field. The latter field indicates the type of action to be triggered. |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
91 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
92 For security, the "ExpectedMessageOrigin" configuration option of the |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
93 Stone Web viewer must have been set to the expected origin of the |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
94 messages. Otherwise, the Stone Web viewer will reject the message. |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
95 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
96 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
97 Action of type "show-osirix-annotations" |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
98 ---------------------------------------- |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
99 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
100 This action loads a set of ROIs exported from OsiriX. The ROIs must |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
101 use the XML file format of OsiriX. |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
102 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
103 The parent DICOM study containing the annotation(s) must have been |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
104 loaded by the Stone Web viewer beforehand. The Stone Web viewer shall |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
105 automatically focus on one instance that is associated with the ROIs. |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
106 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
107 The JSON message must contain the following fields: |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
108 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
109 - "type" must be equal to "show-osirix-annotations" |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
110 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
111 - "xml" must contain the XML file generated by OsiriX |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
112 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
113 - "clear" is a Boolean to indicate whether to clear the annotations |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
114 that have previously been opened. |