GetOverlayImages(Int32,Int32,UInt32) Method

Loads the image(s) with frames from the "Overlay Data" (60xx, 3000) element.

Syntax

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public RasterImage GetOverlayImages( 
   int index,
   int overlayFrameIndex,
   uint count
)

'Declaration

Public Overloads Function GetOverlayImages( _
   ByVal index As Integer, _
   ByVal overlayFrameIndex As Integer, _
   ByVal count As UInteger _
) As RasterImage

'Usage

Dim instance As DicomDataSet
Dim index As Integer
Dim overlayFrameIndex As Integer
Dim count As UInteger
Dim value As RasterImage
 
value = instance.GetOverlayImages(index, overlayFrameIndex, count)

public RasterImage GetOverlayImages( 
   int index,
   int overlayFrameIndex,
   uint count
)

 function Leadtools.Dicom.DicomDataSet.GetOverlayImages(Int32,Int32,UInt32)( 
   index ,
   overlayFrameIndex ,
   count 
)

public:
RasterImage^ GetOverlayImages( 
   int index,
   int overlayFrameIndex,
   uint count
)

Parameters

index: The zero-based index of the overlay whose frames are required.
overlayFrameIndex: The zero-based index of the first frame to load.
count: Value that represents the number of frames to load.

Return Value

Image(s) with frames from the "Overlay Data" (60xx, 3000) element.

Remarks

Before calling this method, you must call GetOverlayAttributes. The FramesInOverlay property will be updated with the number of frames under an overlay.

As an example, To load 5 frames starting with the 1st frame in the "Overlay Data", call this method with overlayFrameIndex set to 0 and count set to 5.

Example

For an example, refer to OverlayCount.

Requirements

Target Platforms

Reference

DicomDataSet Class
DicomDataSet Members
Overload List
OverlayCount Property
GetOverlayAttributes Method
GetOverlayActivationLayer Method
GetOverlayImage Method
SetOverlayAttributes Method
SetOverlayImage Method
SetOverlayImages Method
DeleteOverlay Method