1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\CloudHealthcare\Resource;
19
20use Google\Service\CloudHealthcare\HttpBody;
21
22/**
23 * The "frames" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $healthcareService = new Google\Service\CloudHealthcare(...);
27 *   $frames = $healthcareService->frames;
28 *  </code>
29 */
30class ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFrames extends \Google\Service\Resource
31{
32  /**
33   * RetrieveFrames returns instances associated with the given study, series, SOP
34   * Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.
35   * org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on
36   * the implementation of RetrieveFrames, see [DICOM
37   * frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the
38   * Cloud Healthcare API conformance statement. For samples that show how to call
39   * RetrieveFrames, see [Retrieving DICOM
40   * data](https://cloud.google.com/healthcare/docs/how-
41   * tos/dicomweb#retrieving_dicom_data). (frames.retrieveFrames)
42   *
43   * @param string $parent The name of the DICOM store that is being accessed. For
44   * example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
45   * /dicomStores/{dicom_store_id}`.
46   * @param string $dicomWebPath The path of the RetrieveFrames DICOMweb request.
47   * For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid
48   * }/frames/{frame_list}`.
49   * @param array $optParams Optional parameters.
50   * @return HttpBody
51   */
52  public function retrieveFrames($parent, $dicomWebPath, $optParams = [])
53  {
54    $params = ['parent' => $parent, 'dicomWebPath' => $dicomWebPath];
55    $params = array_merge($params, $optParams);
56    return $this->call('retrieveFrames', [$params], HttpBody::class);
57  }
58  /**
59   * RetrieveRenderedFrames returns instances associated with the given study,
60   * series, SOP Instance UID and frame numbers in an acceptable Rendered Media
61   * Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/
62   * output/html/part18.html#sect_10.4). For details on the implementation of
63   * RetrieveRenderedFrames, see [Rendered
64   * resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources)
65   * in the Cloud Healthcare API conformance statement. For samples that show how
66   * to call RetrieveRenderedFrames, see [Retrieving consumer image
67   * formats](https://cloud.google.com/healthcare/docs/how-
68   * tos/dicomweb#retrieving_consumer_image_formats). (frames.retrieveRendered)
69   *
70   * @param string $parent The name of the DICOM store that is being accessed. For
71   * example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
72   * /dicomStores/{dicom_store_id}`.
73   * @param string $dicomWebPath The path of the RetrieveRenderedFrames DICOMweb
74   * request. For example, `studies/{study_uid}/series/{series_uid}/instances/{ins
75   * tance_uid}/frames/{frame_list}/rendered`.
76   * @param array $optParams Optional parameters.
77   * @return HttpBody
78   */
79  public function retrieveRendered($parent, $dicomWebPath, $optParams = [])
80  {
81    $params = ['parent' => $parent, 'dicomWebPath' => $dicomWebPath];
82    $params = array_merge($params, $optParams);
83    return $this->call('retrieveRendered', [$params], HttpBody::class);
84  }
85}
86
87// Adding a class alias for backwards compatibility with the previous class name.
88class_alias(ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFrames::class, 'Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFrames');
89