GetOverlayAttributes Method

public RasterOverlayAttributes GetOverlayAttributes( 
   int index
)

'Declaration
 
Public Function GetOverlayAttributes( _
   ByVal index As Integer _
) As RasterOverlayAttributes

'Usage
 
Dim instance As DicomDataSet
Dim index As Integer
Dim value As RasterOverlayAttributes
 
value = instance.GetOverlayAttributes(index)

public RasterOverlayAttributes GetOverlayAttributes( 
   int index
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.GetOverlayAttributes( 
   index 
)

public:
RasterOverlayAttributes^ GetOverlayAttributes( 
   int index
) 

Parameters

index

The zero-based index of the overlay whose attributes are required.

Return Value

If the overlay data is embedded in the "Image Pixel Data" (7FE0,0010), Leadtools.RasterOverlayAttributes.UseBitPlane will be set to true. If Leadtools.RasterOverlayAttributes.UseBitPlane is false, then the overlay data is stored in the "Overlay Data" (60xx,3000) element and in this case you can call GetOverlayImage to get the data for that overlay.

Leadtools.RasterOverlayAttributes.Origin will hold the value of the "Overlay Origin" (60xx,0050) element; however, the upper left pixel of the image will have the coordinate 0\0, instead of 1\1 (as in the DICOM standard).

This method will always set Leadtools.RasterOverlayAttributes.Color to black.

For multi-frame overlays, this method will update Leadtools.RasterOverlayAttributes.FramesInOverlay with the value of "Number of Frames in Overlay" (60xx,0015) element and Leadtools.RasterOverlayAttributes.ImageFrameOrigin with the value of "Image Frame Origin" (60xx,0051) element.

Leadtools.RasterOverlayAttributes.ActivationLayer will be updated with the value of the element "Overlay Activation Layer" (60xx,1001).

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

Reference

DicomDataSet Class
DicomDataSet Members
OverlayCount Property
GetOverlayGroupNumber Method
IsOverlayInDataSet Method
GetOverlayActivationLayer Method
GetOverlayImage Method
GetOverlayImages(Int32,Int32,Int32) Method
SetOverlayAttributes Method
SetOverlayImage Method
SetOverlayImages Method
DeleteOverlay Method