GetOverlayAttributes Method

Summary

Retrieves the attributes of the overlay at the specified index.

Syntax

C++

Java

public RasterOverlayAttributes GetOverlayAttributes( 
   int index 
)

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

public RasterOverlayAttributes getOverlayAttributes(int index)

public: 
RasterOverlayAttributes^ GetOverlayAttributes(  
   int index 
)

Parameters

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

Return Value

The overlay attributes.

Remarks

Most of the members of RasterOverlayAttributes are based on the "Overlay Plane Module Attributes" in the DICOM standard. If the overlay data is embedded in the "Image Pixel Data" (7FE0,0010), UseBitPlane will be set to true. If 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.

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 Color to black.

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

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

Example

For an example, refer to OverlayCount.

Requirements

Target Platforms