DicomObjects.NET8 Documentation
DicomObjects.DicomWeb Namespace / WadoWebClient Class / RetrieveThumbnailAsync Method
The desired output size of the thumbnail. This specifies the width (vw) and height (vh) to which the image should be scaled.
An optional rectangular area of the source image to crop before scaling. If specified, this defines the source x (sx), y (sy), width (sw), and height (sh).
The unique identifier of the study.
The unique identifier of the series (optional).
The unique identifier of the instance (optional).
The frames to retrieve.



In This Topic
    RetrieveThumbnailAsync Method (WadoWebClient)
    In This Topic
    Asynchronously retrieves a thumbnail image with specified viewport dimensions and optional cropping area.
    Syntax
    'Declaration
     
    
    <AsyncStateMachineAttribute(DicomObjects.DicomWeb.WadoWebClient/d__16)> 
    Public Function RetrieveThumbnailAsync( _ 
       ByVal Viewport As Nullable(Of SKSizeI), _ 
       ByVal Area As Nullable(Of SKRectI), _ 
       ByVal StudyUID As String, _ 
       Optional ByVal SeriesUID As String, _ 
       Optional ByVal InstanceUID As String, _ 
       Optional ByVal Frames As IEnumerable(Of Integer) _ 
    ) As Task(Of Dictionary(Of HttpContentHeaders,Byte()))
    'Usage
     
    
    Dim instance As WadoWebClient
    Dim Viewport As Nullable(Of SKSizeI)
    Dim Area As Nullable(Of SKRectI)
    Dim StudyUID As String
    Dim SeriesUID As String
    Dim InstanceUID As String
    Dim Frames As IEnumerable(Of Integer)
    Dim value As Task(Of Dictionary(Of HttpContentHeaders,Byte()))
     
    value = instance.RetrieveThumbnailAsync(Viewport, Area, StudyUID, SeriesUID, InstanceUID, Frames)

    Parameters

    Viewport
    The desired output size of the thumbnail. This specifies the width (vw) and height (vh) to which the image should be scaled.
    Area
    An optional rectangular area of the source image to crop before scaling. If specified, this defines the source x (sx), y (sy), width (sw), and height (sh).
    StudyUID
    The unique identifier of the study.
    SeriesUID
    The unique identifier of the series (optional).
    InstanceUID
    The unique identifier of the instance (optional).
    Frames
    The frames to retrieve.

    Return Value

    A byte array containing the thumbnail image.
    Exceptions
    ExceptionDescription
    Thrown if viewport width or height is not specified or is less than or equal to zero.
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also