DicomObjects.NET.8.48 Documentation
DicomObjects.DicomWeb.WebClient 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
    In This Topic
    Asynchronously retrieves a thumbnail image with specified viewport dimensions and optional cropping area.
    Syntax
    'Declaration
     
    
    <System.Runtime.CompilerServices.AsyncStateMachineAttribute(DicomObjects.DicomWeb.WebClient.WadoWebClient/d__14)> 
    Public Function RetrieveThumbnailAsync( _ 
       ByVal Viewport As System.Nullable(Of Size), _ 
       ByVal Area As System.Nullable(Of Rectangle), _ 
       ByVal StudyUID As System.String, _ 
       Optional ByVal SeriesUID As System.String, _ 
       Optional ByVal InstanceUID As System.String, _ 
       Optional ByVal Frames As System.Collections.Generic.IEnumerable(Of Integer) _ 
    ) As System.Threading.Tasks.Task(Of Dictionary(Of HttpContentHeaders,Byte()))
    [System.Runtime.CompilerServices.AsyncStateMachine(DicomObjects.DicomWeb.WebClient.WadoWebClient/d__14)] 
    public System.Threading.Tasks.Task<Dictionary<HttpContentHeaders,byte[]>> RetrieveThumbnailAsync( 
       System.Nullable<Size> Viewport, 
       System.Nullable<Rectangle> Area, 
       System.string StudyUID, 
       System.string SeriesUID, 
       System.string InstanceUID, 
       System.Collections.Generic.IEnumerable<int> 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: .NET CLR 4.8 or higher

    See Also