• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="healthcare_v1alpha2.html">Cloud Healthcare API</a> . <a href="healthcare_v1alpha2.projects.html">projects</a> . <a href="healthcare_v1alpha2.projects.locations.html">locations</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.html">dicomStores</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.html">dicomWeb</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.html">studies</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.series.html">series</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.html">instances</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.html">frames</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#rendered">rendered(parent, dicomWebPath, x__xgafv=None)</a></code></p>
79<p class="firstline">RetrieveRenderedFrames returns instances associated with the given study,</p>
80<p class="toc_element">
81  <code><a href="#retrieveFrames">retrieveFrames(parent, dicomWebPath, x__xgafv=None)</a></code></p>
82<p class="firstline">RetrieveFrames returns instances associated with the given study, series,</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="rendered">rendered(parent, dicomWebPath, x__xgafv=None)</code>
86  <pre>RetrieveRenderedFrames returns instances associated with the given study,
87series, SOP Instance UID and frame numbers in an acceptable Rendered Media
88Type. See
89http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
90
91Args:
92  parent: string, The name of the DICOM store that is being accessed (e.g.,
93`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
94  dicomWebPath: string, The path of the RetrieveRenderedFrames DICOMweb request (e.g.,
95`studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). (required)
96  x__xgafv: string, V1 error format.
97    Allowed values
98      1 - v1 error format
99      2 - v2 error format
100
101Returns:
102  An object of the form:
103
104    { # Message that represents an arbitrary HTTP body. It should only be used for
105      # payload formats that can't be represented as JSON, such as raw binary or
106      # an HTML page.
107      #
108      #
109      # This message can be used both in streaming and non-streaming API methods in
110      # the request as well as the response.
111      #
112      # It can be used as a top-level request field, which is convenient if one
113      # wants to extract parameters from either the URL or HTTP template into the
114      # request fields and also want access to the raw HTTP body.
115      #
116      # Example:
117      #
118      #     message GetResourceRequest {
119      #       // A unique request id.
120      #       string request_id = 1;
121      #
122      #       // The raw HTTP body is bound to this field.
123      #       google.api.HttpBody http_body = 2;
124      #     }
125      #
126      #     service ResourceService {
127      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
128      #       rpc UpdateResource(google.api.HttpBody) returns
129      #       (google.protobuf.Empty);
130      #     }
131      #
132      # Example with streaming methods:
133      #
134      #     service CaldavService {
135      #       rpc GetCalendar(stream google.api.HttpBody)
136      #         returns (stream google.api.HttpBody);
137      #       rpc UpdateCalendar(stream google.api.HttpBody)
138      #         returns (stream google.api.HttpBody);
139      #     }
140      #
141      # Use of this type only changes how the request and response bodies are
142      # handled, all other features will continue to work unchanged.
143    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
144    "data": "A String", # The HTTP request/response body as raw binary.
145    "extensions": [ # Application specific response metadata. Must be set in the first response
146        # for streaming APIs.
147      {
148        "a_key": "", # Properties of the object. Contains field @type with type URL.
149      },
150    ],
151  }</pre>
152</div>
153
154<div class="method">
155    <code class="details" id="retrieveFrames">retrieveFrames(parent, dicomWebPath, x__xgafv=None)</code>
156  <pre>RetrieveFrames returns instances associated with the given study, series,
157SOP Instance UID and frame numbers. See
158http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
159
160Args:
161  parent: string, The name of the DICOM store that is being accessed (e.g.,
162`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
163  dicomWebPath: string, The path of the RetrieveFrames DICOMweb request (e.g.,
164`studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). (required)
165  x__xgafv: string, V1 error format.
166    Allowed values
167      1 - v1 error format
168      2 - v2 error format
169
170Returns:
171  An object of the form:
172
173    { # Message that represents an arbitrary HTTP body. It should only be used for
174      # payload formats that can't be represented as JSON, such as raw binary or
175      # an HTML page.
176      #
177      #
178      # This message can be used both in streaming and non-streaming API methods in
179      # the request as well as the response.
180      #
181      # It can be used as a top-level request field, which is convenient if one
182      # wants to extract parameters from either the URL or HTTP template into the
183      # request fields and also want access to the raw HTTP body.
184      #
185      # Example:
186      #
187      #     message GetResourceRequest {
188      #       // A unique request id.
189      #       string request_id = 1;
190      #
191      #       // The raw HTTP body is bound to this field.
192      #       google.api.HttpBody http_body = 2;
193      #     }
194      #
195      #     service ResourceService {
196      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
197      #       rpc UpdateResource(google.api.HttpBody) returns
198      #       (google.protobuf.Empty);
199      #     }
200      #
201      # Example with streaming methods:
202      #
203      #     service CaldavService {
204      #       rpc GetCalendar(stream google.api.HttpBody)
205      #         returns (stream google.api.HttpBody);
206      #       rpc UpdateCalendar(stream google.api.HttpBody)
207      #         returns (stream google.api.HttpBody);
208      #     }
209      #
210      # Use of this type only changes how the request and response bodies are
211      # handled, all other features will continue to work unchanged.
212    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
213    "data": "A String", # The HTTP request/response body as raw binary.
214    "extensions": [ # Application specific response metadata. Must be set in the first response
215        # for streaming APIs.
216      {
217        "a_key": "", # Properties of the object. Contains field @type with type URL.
218      },
219    ],
220  }</pre>
221</div>
222
223</body></html>