File: services-scu.rst

package info (click to toggle)
odil 0.12.2-5
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 5,320 kB
  • sloc: cpp: 55,035; python: 3,971; javascript: 460; xml: 182; makefile: 98
file content (252 lines) | stat: -rw-r--r-- 9,737 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
DICOM services -- client side
=============================

.. highlight:: c++

:abbr:`SCUs (Service Class User)` (i.e. *clients*) are available for `C-ECHO`_, `C-FIND`_, `C-GET`_, `C-MOVE`_, and `C-STORE`_, with an abstract base class, `odil::SCU`_, implementing common features and concrete classes for each service (see table below). Every service requires an association which is correctly associated and has negotiated the corresponding abstract syntax.

.. table:: DICOM services and Odil classes
  
  +----------+-------------------+
  | Service  | Odil class        |
  +==========+===================+
  | C-ECHO   | `odil::EchoSCU`_  |
  +----------+-------------------+
  | C-FIND   | `odil::FindSCU`_  |
  +----------+-------------------+
  | C-GET    | `odil::GetSCU`_   |
  +----------+-------------------+
  | C-MOVE   | `odil::MoveSCU`_  |
  +----------+-------------------+
  | C-STORE  | `odil::StoreSCU`_ |
  +----------+-------------------+

Verifying DICOM communication
-----------------------------

The simplest service is C-ECHO, used to verify that the two peers can exchange information using DICOM. 

::
  
  #include <odil/Association.h>
  #include <odil/EchoSCU.h>
  #include <odil/registry.h>
  
  int main()
  {
      odil::Association association;
      association.set_peer_host("www.dicomserver.co.uk");
      association.set_peer_port(11112);
      association.update_parameters()
          .set_calling_ae_title("WORKSTATION")
          .set_called_ae_title("SERVER")
          .set_presentation_contexts({
              {
                  odil::registry::Verification,
                  { odil::registry::ExplicitVRLittleEndian }, 
                  odil::AssociationParameters::PresentationContext::Role::SCU
              }
          });  
      association.associate();
      
      odil::EchoSCU echo_scu(association);
      echo_scu.echo();
      
      association.release();  
  }

Querying a database
-------------------

The query service, C-FIND, is parameterized by a query and either returns all the matching data sets or calls a function for each match.

::
  
  #include <iostream>
  
  #include <odil/Association.h>
  #include <odil/FindSCU.h>
  #include <odil/registry.h>
  
  void print_informations(odil::DataSet const & response)
  {
      auto const name = 
          (response.has("PatientName") && !response.empty("PatientName"))
          ?response.as_string("PatientName", 0):"(no name)";
      auto const study = 
          (response.has("StudyDescription") && !response.empty("StudyDescription"))
          ?response.as_string("StudyDescription", 0):"(no description)";
      
      std::cout << name << ": " << study << "\n";
  }
  
  int main()
  {
      auto const model = odil::registry::StudyRootQueryRetrieveInformationModelFind;
      
      odil::Association association;
      association.set_peer_host("www.dicomserver.co.uk");
      association.set_peer_port(11112);
      association.update_parameters()
          .set_calling_ae_title("WORKSTATION")
          .set_called_ae_title("SERVER")
          .set_presentation_contexts({
              { 
                  model, { odil::registry::ExplicitVRLittleEndian }, 
                  odil::AssociationParameters::PresentationContext::Role::SCU }
          });  
      association.associate();
      
      odil::DataSet query;
      query.add("PatientName", { "*" });
      query.add("QueryRetrieveLevel", { "STUDY" });
      query.add("StudyDescription");
      query.add("StudyDate");
      
      odil::FindSCU find_scu(association);
      find_scu.set_affected_sop_class(model);
      
      auto const result = find_scu.find(query);
      for(auto const & dataset: result)
      {
          print_informations(dataset);
      }
      
      find_scu.find(query, print_informations);
      
      association.release();  
  }

Retrieving data sets
--------------------

The retrieval of data sets, using either C-GET or C-MOVE, is very similar to querying a database. The main difference is the additional presentation contexts required to transfer the data sets.

::
  
  #include <iostream>
  #include <string>
  #include <vector>

  #include <odil/Association.h>
  #include <odil/FindSCU.h>
  #include <odil/GetSCU.h>
  #include <odil/registry.h>

  odil::DataSet find(
      std::string const & host, unsigned int port, 
      std::string const & calling_aet, std::string const & called_aet)
  {
      auto const model = odil::registry::StudyRootQueryRetrieveInformationModelFind;
      
      odil::Association association;
      association.set_peer_host(host);
      association.set_peer_port(port);
      association.update_parameters()
          .set_calling_ae_title(calling_aet).set_called_ae_title(called_aet)
          .set_presentation_contexts({
              { 
                  model, { odil::registry::ExplicitVRLittleEndian }, 
                  odil::AssociationParameters::PresentationContext::Role::SCU }
          });  
      association.associate();
      
      odil::DataSet query;
      query.add("QueryRetrieveLevel", { "STUDY" });
      query.add("StudyInstanceUID");
      query.add("SOPClassesInStudy");
      query.add("StudyDate");
      
      odil::FindSCU scu(association);
      scu.set_affected_sop_class(model);
      auto const studies = scu.find(query);
      
      association.release();
      
      if(studies.empty())
      {
          throw std::runtime_error("No matching studies");
      }
      return studies[0];
  }

  std::vector<odil::DataSet> 
  get_study(
      std::string const & host, unsigned int port, 
      std::string const & calling_aet, std::string const & called_aet,
      odil::DataSet const & study)
  {
      auto const model = odil::registry::StudyRootQueryRetrieveInformationModelGet;
      
      odil::Association association;
      association.set_peer_host(host);
      association.set_peer_port(port);
      association.update_parameters()
          .set_calling_ae_title(calling_aet).set_called_ae_title(called_aet);
      
      std::vector<odil::AssociationParameters::PresentationContext> contexts{
          { 
              model, { odil::registry::ExplicitVRLittleEndian }, 
              odil::AssociationParameters::PresentationContext::Role::SCU }
      };
      for(auto const & abstract_syntax: study.as_string("SOPClassesInStudy"))
      {
          contexts.push_back({
              abstract_syntax, { odil::registry::ExplicitVRLittleEndian }, 
              odil::AssociationParameters::PresentationContext::Role::SCP
          });
      }
      association.update_parameters().set_presentation_contexts(contexts);
      
      association.associate();
      
      odil::DataSet query;
      query.add("QueryRetrieveLevel", { "STUDY" });
      query.add("StudyInstanceUID", study.as_string("StudyInstanceUID"));
      
      odil::GetSCU scu(association);
      scu.set_affected_sop_class(model);
      auto const data_sets = scu.get(query);
      
      association.release();
      
      return data_sets;
  }

  int main()
  {
      std::string const host = "www.dicomserver.co.uk";
      unsigned int port = 11112;
      std::string const calling_aet = "WORKSTATION";
      std::string const called_aet = "SERVER";
      
      auto const study = find(host, port, calling_aet, called_aet);
      auto const data_sets = get_study(
          host, port, calling_aet, called_aet, study);
      std::cout 
          << data_sets.size() << " data set" << (data_sets.size()>0?"s":"") << " "
          << "received\n";
  }

Note that several presentation contexts must be specified: the C-GET context and one for each type of object returned by C-FIND in the *SOP Classes In Study* element.

The C-GET SCU can also be called using one or two callbacks: one which will be called for each C-STORE operation initiated by the server and an optional one which will be called for each C-GET response. The latter one may for example be used for progress information.

The C-MOVE SCU is similar to the C-GET SCU in terms of required presentation contexts (the *XXX Root Query Retrieve Information Model GET* being replaced by *XXX Root Query Retrieve Information Model MOVE*) and callbacks. The C-MOVE SCU has additional member functions used to specify where the remote peer will send the data sets: ``get_move_destination`` and ``set_move_destination``. If the move destination is the local peer and not a third party, the port of a temporary C-STORE SCP may be specified through ``set_incoming_port``. The default value of ``0`` means that no C-STORE SCP should be started.

Storing data sets
-----------------

The C-STORE SCU differs from the query/retrieve SCUs since it has no callback: each data set is either stored successfully or an exception is raised. An optional move origin (if the C-STORE SCU is created by a C-MOVE SCP) may be specified.

.. _C-ECHO: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/chapter_A.html
.. _C-FIND: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_C.4.html#sect_C.4.1
.. _C-GET: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_C.4.3.html
.. _C-MOVE: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_C.4.2.html
.. _C-STORE: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/chapter_B.html
.. _odil::EchoSCU: ../../_static/doxygen/classodil_1_1EchoSCU.html
.. _odil::FindSCU: ../../_static/doxygen/classodil_1_1FindSCU.html
.. _odil::GetSCU: ../../_static/doxygen/classodil_1_1GetSCU.html
.. _odil::MoveSCU: ../../_static/doxygen/classodil_1_1MoveSCU.html
.. _odil::SCU: ../../_static/doxygen/classodil_1_1SCU.html
.. _odil::StoreSCU: ../../_static/doxygen/classodil_1_1StoreSCU.html