Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.10.31
GetOverlayImages Method
See Also 
Leadtools.Dicom Namespace > DicomDataSet Class : GetOverlayImages Method




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.
Loads the image(s) with frames from the "Overlay Data" (60xx, 3000) element.

Syntax

Visual Basic (Declaration) 
Public Function GetOverlayImages( _
   ByVal index As Integer, _
   ByVal overlayFrameIndex As Integer, _
   ByVal count As Integer _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim index As Integer
Dim overlayFrameIndex As Integer
Dim count As Integer
Dim value As RasterImage
 
value = instance.GetOverlayImages(index, overlayFrameIndex, count)
C# 
public RasterImage GetOverlayImages( 
   int index,
   int overlayFrameIndex,
   int count
)
Managed Extensions for C++ 
public: RasterImage GetOverlayImages( 
   int index,
   int overlayFrameIndex,
   int count
) 
C++/CLI 
public:
RasterImage GetOverlayImages( 
   int index,
   int overlayFrameIndex,
   int 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.

Example

For an example, refer to OverlayCount.

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Leadtools.Dicom requires a Medical toolkit license and unlock key. For more information, refer to: Raster Pro/Document/Medical Features