GetOverlayImage Method

Summary

Retrieves the "Overlay Data" (60xx,3000) for the specified overlay index.

Syntax

C++

Java

public RasterImage GetOverlayImage( 
   int index 
)

Public Function GetOverlayImage( _ 
   ByVal index As Integer _ 
) As RasterImage

public RasterImage getOverlayImage(int index)

public: 
RasterImage^ GetOverlayImage(  
   int index 
)

Parameters

index
The zero-based index of the overlay whose image is required.

Return Value

Image filled with the overlay data.

Remarks

This method will extract the "Overlay Data" (60xx,3000) for an overlay, initialize the returned image based on the "Overlay Columns" (60xx,0011) and "Overlay Rows" (60xx,0010), and then fill the image with the stream of bytes under the "Overlay Data" (60xx,3000) element. If the method does not find the "Overlay Data" element inside the Data Set it will throw an DicomExceptionCode.OverlayDataMissing exception.

Before calling this method you must call GetOverlayAttributes to determine if the overlay pixel data is embedded in the "Image Pixel Data" (7FE0,0010) element or is under the "Overlay Data" (60xx,3000) element. If the overlay data is embedded in the "Image Pixel Data", UseBitPlane will be set to true in the attributes returned by GetOverlayAttributes.

If the overlay pixel data is embedded in the "Image Pixel Data" (7FE0, 0010), follow these steps to get the overlay data:

Call one of the methods which can be used to extract the "Image Pixel Data", such as GetImage. This will return a raster image populated with the "Image Pixel Data" with the overlay data embedded. For this example, assume that the raster image returned by this method is called mainImage.
Call GetOverlayAttributes to get the attributes of the overlay. For this example, assume that the overlay attributes returned by this method is called overlayAttributes.

Now we need to add our overlay as one of the overlays associated with mainImage. To do that, we need to call SetOverlayAttributes:

mainImage.UpdateOverlayAttributes(0, overlayAttributes, RasterGetSetOverlayAttributesFlags.Flags | RasterGetSetOverlayAttributesFlags.BitIndex | RasterGetSetOverlayAttributesFlags.Origin | RasterGetSetOverlayAttributesFlags.Dicom | RasterGetSetOverlayAttributesFlags.Color);

We are assuming that this is the first overlay in the image; this is why we are passing 0 as the overlay index.

Now we need to extract the overlay data from the main image data:

mainImage.UpdateOverlayBits(0, RasterUpdateOverlayBitsFlags.FromImage);

Now call mainImage.GetOverlayImage to get the overlay data itself as a raster image.

Example

For an example, refer to OverlayCount.

Requirements

Target Platforms

Reference

DicomDataSet Class

DicomDataSet Members

OverlayCount Property

GetOverlayAttributes Method

GetOverlayActivationLayer Method

GetOverlayImages(Int32,Int32,Int32) Method

SetOverlayAttributes Method

SetOverlayImage Method

SetOverlayImages Method

DeleteOverlay Method

Download our FREE evaluation

Help Version 21.0.2021.6.30

Leadtools.Dicom Assembly

Introduction

Getting Started

Namespaces

Leadtools.Dicom Namespace

Assemblies