HealthImaging / Client / get_image_frame

get_image_frame

HealthImaging.Client.get_image_frame(**kwargs)

Get an image frame (pixel data) for an image set.

See also: AWS API Documentation

Request Syntax

response = client.get_image_frame(
    datastoreId='string',
    imageSetId='string',
    imageFrameInformation={
        'imageFrameId': 'string'
    }
)
Parameters:

  • datastoreId (string) –

    [REQUIRED]

    The data store identifier.

  • imageSetId (string) –

    [REQUIRED]

    The image set identifier.

  • imageFrameInformation (dict) –

    [REQUIRED]

    Information about the image frame (pixel data) identifier.

    • imageFrameId (string) – [REQUIRED]

      The image frame (pixel data) identifier.

Return type:

dict

Returns:

Response Syntax

{
    'imageFrameBlob': StreamingBody(),
    'contentType': 'string'
}

Response Structure

  • (dict) –

    • imageFrameBlob (StreamingBody) –

      The blob containing the aggregated image frame information.

    • contentType (string) –

      The format in which the image frame information is returned to the customer. Default is application/octet-stream.

      Note

      • If the stored transfer syntax is 1.2.840.10008.1.2.1, the returned contentType is application/octet-stream.

      • If the stored transfer syntax is 1.2.840.10008.1.2.4.50, the returned contentType is image/jpeg.

      • If the stored transfer syntax is 1.2.840.10008.1.2.4.91, the returned contentType is image/j2c.

      • If the stored transfer syntax is MPEG2, 1.2.840.10008.1.2.4.100, 1.2.840.10008.1.2.4.100.1, 1.2.840.10008.1.2.4.101, or 1.2.840.10008.1.2.4.101.1, the returned contentType is video/mpeg.

      • If the stored transfer syntax is MPEG-4 AVC/H.264, UID 1.2.840.10008.1.2.4.102, 1.2.840.10008.1.2.4.102.1, 1.2.840.10008.1.2.4.103, 1.2.840.10008.1.2.4.103.1, 1.2.840.10008.1.2.4.104, 1.2.840.10008.1.2.4.104.1, 1.2.840.10008.1.2.4.105, 1.2.840.10008.1.2.4.105.1, 1.2.840.10008.1.2.4.106, or 1.2.840.10008.1.2.4.106.1, the returned contentType is video/mp4.

      • If the stored transfer syntax is HEVC/H.265, UID 1.2.840.10008.1.2.4.107 or 1.2.840.10008.1.2.4.108, the returned contentType is video/H256.

      • If the stored transfer syntax is 1.2.840.10008.1.2.4.202 or if the stored transfer syntax is missing, the returned contentType is image/jph.

      • If the stored transfer syntax is 1.2.840.10008.1.2.4.203, the returned contentType is image/jphc.

Exceptions