blob: 58b478147e21e62438ec8c48b67cf42bbb06f1e6 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="healthcare_v1.html">Cloud Healthcare API</a> . <a href="healthcare_v1.projects.html">projects</a> . <a href="healthcare_v1.projects.locations.html">locations</a> . <a href="healthcare_v1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1.projects.locations.datasets.dicomStores.html">dicomStores</a> . <a href="healthcare_v1.projects.locations.datasets.dicomStores.studies.html">studies</a> . <a href="healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html">series</a> . <a href="healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html">instances</a> . <a href="healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.frames.html">frames</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#retrieveFrames">retrieveFrames(parent, dicomWebPath, x__xgafv=None)</a></code></p>
<p class="firstline">RetrieveFrames returns instances associated with the given study, series,</p>
<p class="toc_element">
<code><a href="#retrieveRendered">retrieveRendered(parent, dicomWebPath, x__xgafv=None)</a></code></p>
<p class="firstline">RetrieveRenderedFrames returns instances associated with the given study,</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="retrieveFrames">retrieveFrames(parent, dicomWebPath, x__xgafv=None)</code>
<pre>RetrieveFrames returns instances associated with the given study, series,
SOP Instance UID and frame numbers. See
[RetrieveTransaction]
(http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}.
Args:
parent: string, The name of the DICOM store that is being accessed. For example,
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
dicomWebPath: string, The path of the RetrieveFrames DICOMweb request. For example,
`studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for
# payload formats that can&#x27;t be represented as JSON, such as raw binary or
# an HTML page.
#
#
# This message can be used both in streaming and non-streaming API methods in
# the request as well as the response.
#
# It can be used as a top-level request field, which is convenient if one
# wants to extract parameters from either the URL or HTTP template into the
# request fields and also want access to the raw HTTP body.
#
# Example:
#
# message GetResourceRequest {
# // A unique request id.
# string request_id = 1;
#
# // The raw HTTP body is bound to this field.
# google.api.HttpBody http_body = 2;
# }
#
# service ResourceService {
# rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
# rpc UpdateResource(google.api.HttpBody) returns
# (google.protobuf.Empty);
# }
#
# Example with streaming methods:
#
# service CaldavService {
# rpc GetCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# rpc UpdateCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# }
#
# Use of this type only changes how the request and response bodies are
# handled, all other features will continue to work unchanged.
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
# for streaming APIs.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
}</pre>
</div>
<div class="method">
<code class="details" id="retrieveRendered">retrieveRendered(parent, dicomWebPath, x__xgafv=None)</code>
<pre>RetrieveRenderedFrames returns instances associated with the given study,
series, SOP Instance UID and frame numbers in an acceptable Rendered Media
Type. See
[RetrieveTransaction]
(http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).
Args:
parent: string, The name of the DICOM store that is being accessed. For example,
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
dicomWebPath: string, The path of the RetrieveRenderedFrames DICOMweb request. For example,
`studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for
# payload formats that can&#x27;t be represented as JSON, such as raw binary or
# an HTML page.
#
#
# This message can be used both in streaming and non-streaming API methods in
# the request as well as the response.
#
# It can be used as a top-level request field, which is convenient if one
# wants to extract parameters from either the URL or HTTP template into the
# request fields and also want access to the raw HTTP body.
#
# Example:
#
# message GetResourceRequest {
# // A unique request id.
# string request_id = 1;
#
# // The raw HTTP body is bound to this field.
# google.api.HttpBody http_body = 2;
# }
#
# service ResourceService {
# rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
# rpc UpdateResource(google.api.HttpBody) returns
# (google.protobuf.Empty);
# }
#
# Example with streaming methods:
#
# service CaldavService {
# rpc GetCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# rpc UpdateCalendar(stream google.api.HttpBody)
# returns (stream google.api.HttpBody);
# }
#
# Use of this type only changes how the request and response bodies are
# handled, all other features will continue to work unchanged.
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
# for streaming APIs.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
}</pre>
</div>
</body></html>