Mercurial > hg > orthanc-stone
annotate Applications/StoneWebViewer/NOTES.txt @ 1696:572652803929
bootstrapping the Stone Web viewer configuration file
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 27 Nov 2020 09:34:02 +0100 |
parents | e787b52d025f |
children | bc40b6450261 |
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 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
8 - 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
|
9 viewer the Orthanc identifiers. |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
10 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
|
11 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
12 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
|
13 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
|
14 "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
|
15 the parent study must be provided. |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
16 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
17 To open a single study: |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
18 http://.../index.html?study=<StudyInstanceUID> |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
19 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
20 To open a single series: |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
21 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
|
22 |
1692
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
23 - 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
|
24 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
|
25 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
|
26 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
27 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
|
28 single "study" 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
|
29 comma-separated list of studies. The "series" parameter is ignored |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
30 in this case. |
1691
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
31 |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
32 To open a list of studies: |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
33 http://.../index.html?study=<StudyInstanceUID1>,<StudyInstanceUID2>,... |
4a49de03a419
porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
34 |
1692
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
35 - In the Osimis Web viewer, the "selectedStudyIds" defines the list of |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
36 studies that are selected in the dropdown (and therefore displayed |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
37 when the viewer starts). |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
38 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
39 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
|
40 "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
|
41 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
|
42 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
43 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
|
44 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
|
45 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
|
46 |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
47 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
|
48 displayed at the startup. |
e787b52d025f
"selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1691
diff
changeset
|
49 |
1696
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
50 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
51 Dynamic actions using messages |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
52 ============================== |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
53 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
54 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
|
55 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
|
56 primitive of JavaScript: |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
57 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
|
58 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
59 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
|
60 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
|
61 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
62 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
|
63 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
|
64 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
|
65 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
66 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
67 Action of type "show-osirix-annotations" |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
68 ---------------------------------------- |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
69 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
70 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
|
71 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
|
72 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
73 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
|
74 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
|
75 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
|
76 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
77 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
|
78 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
79 - "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
|
80 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
81 - "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
|
82 |
572652803929
bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1692
diff
changeset
|
83 - "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
|
84 that have previously been opened. |