Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFrames
extends Google_Service_Resource
in package
The "frames" collection of methods.
Typical usage is:
$healthcareService = new Google_Service_CloudHealthcare(...);
$frames = $healthcareService->frames;
Table of Contents
- $client : Google_Client
- $methods : array<string|int, mixed>
- $resourceName : string
- $rootUrl : string
- $serviceName : string
- $servicePath : string
- $stackParameters : mixed
- __construct() : mixed
- call() : Google_Http_Request|expectedClass
- TODO: This function needs simplifying.
- createRequestUri() : string
- Parse/expand request parameters and create a fully qualified request uri.
- retrieveFrames() : Google_Service_CloudHealthcare_HttpBody
- RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.
- retrieveRendered() : Google_Service_CloudHealthcare_HttpBody
- 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). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_consumer_image_formats). (frames.retrieveRendered)
- convertToArrayAndStripNulls() : mixed
Properties
$client
private
Google_Client
$client
$methods
private
array<string|int, mixed>
$methods
$resourceName
private
string
$resourceName
$rootUrl
private
string
$rootUrl
$serviceName
private
string
$serviceName
$servicePath
private
string
$servicePath
$stackParameters
private
mixed
$stackParameters
= array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))
Methods
__construct()
public
__construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
- $service : mixed
- $serviceName : mixed
- $resourceName : mixed
- $resource : mixed
Return values
mixed —call()
TODO: This function needs simplifying.
public
call( $name, $arguments[, $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
Tags
Return values
Google_Http_Request|expectedClass —createRequestUri()
Parse/expand request parameters and create a fully qualified request uri.
public
createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
- $restPath : string
- $params : array<string|int, mixed>
Tags
Return values
string —$requestUrl
retrieveFrames()
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.
public
retrieveFrames(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody
org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_dicom_data). (frames.retrieveFrames)
Parameters
- $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}. - $dicomWebPath : string
-
The path of the RetrieveFrames DICOMweb request. For example,
studies/{study_uid}/series/{series_uid}/instances/{instance_uid }/frames/{frame_list}. - $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_CloudHealthcare_HttpBody —retrieveRendered()
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). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_consumer_image_formats). (frames.retrieveRendered)
public
retrieveRendered(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody
Parameters
- $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}. - $dicomWebPath : string
-
The path of the RetrieveRenderedFrames DICOMweb request. For example,
studies/{study_uid}/series/{series_uid}/instances/{ins tance_uid}/frames/{frame_list}/rendered. - $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_CloudHealthcare_HttpBody —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed