- index
- The zero-based index of the overlay whose attributes are required.
Visual Basic (Declaration) | |
---|---|
Public Function GetOverlayAttributes( _ ByVal index As Integer _ ) As RasterOverlayAttributes |
Visual Basic (Usage) | Copy Code |
---|---|
Dim instance As DicomDataSet Dim index As Integer Dim value As RasterOverlayAttributes value = instance.GetOverlayAttributes(index) |
C# | |
---|---|
public RasterOverlayAttributes GetOverlayAttributes( int index ) |
C++/CLI | |
---|---|
public: RasterOverlayAttributes^ GetOverlayAttributes( int index ) |
Parameters
- index
- The zero-based index of the overlay whose attributes are required.
Return Value
The overlay attributes.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 Leadtools.Dicom.DicomDataSet.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: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)
Reference
DicomDataSet ClassDicomDataSet Members
OverlayCount Property
GetOverlayGroupNumber Method
IsOverlayInDataSet Method
GetOverlayActivationLayer Method
GetOverlayImage Method
GetOverlayImages Method
SetOverlayAttributes Method
SetOverlayImage Method
SetOverlayImages Method
DeleteOverlay Method