DeleteOverlay Method

Summary

Deletes all the elements that describe an overlay.

Syntax

C++/CLI

Java

public void DeleteOverlay( 
   int index 
)

public void deleteOverlay(int index)

public: 
void DeleteOverlay(  
   int index 
)

Parameters

index
The zero-based index of the overlay to delete.

Remarks

This method will delete the following elements: "Overlay Rows" (60xx, 0010)

"Overlay Columns" (60xx, 0011)

"Overlay Planes" (60xx, 0012)

"Number of Frames in Overlay" (60xx, 0015)

"Overlay Description" (60xx, 0022)

"Overlay Type" (60xx, 0040)

"Overlay Subtype" (60xx, 0045)

"Overlay Origin" (60xx, 0050)

"Image Frame Origin" (60xx, 0051)

"Overlay Plane Origin" (60xx, 0052)

"Overlay Bits Allocated" (60xx, 0100)

"Overlay Bit Position" (60xx, 0102)

"Overlay Activation Layer" (60xx, 1001)

"ROI Area" (60xx, 1301)

"ROI Mean" (60xx, 1302)

"ROI Standard Deviation" (60xx, 1303)

"Overlay Label" (60xx, 1500)

"Overlay Data" (60xx, 3000)

Example

using Leadtools; 
using Leadtools.Dicom; 
 
 
public void TestOverlay() 
{ 
   string dicomFileName = Path.Combine(LEAD_VARS.ImagesDir, "DICOM", "Overlay.dcm"); 
   //Make sure to initialize the DICOM engine, this needs to be done only once  
   //In the whole application 
   DicomEngine.Startup(); 
   using (DicomDataSet ds = new DicomDataSet()) 
   { 
      //Load DICOM File 
      ds.Load(dicomFileName, DicomDataSetLoadFlags.None); 
 
      if (ds.OverlayCount > 0) 
      { 
         RasterOverlayAttributes attributes = ds.GetOverlayAttributes(0); 
         if (attributes != null) 
         { 
            // We can call in here methods like GetOverlayGroupNumber, IsOverlayInDataset  
            // and GetOverlayActivationLayer to get some further infromation about the overlay 
 
            //Let's get the overlay Image, If RasterOverlayAttributes.NumFramesInOverlay  
            //Is greater than 1 we can call GetOverlayImages to extract all the frames 
            RasterImage overlayImage = ds.GetOverlayImage(0); 
            if (overlayImage != null) 
            { 
               using (DicomDataSet ds1 = new DicomDataSet()) 
               { 
                  ds1.Initialize(DicomClassType.DXImageStoragePresentation, DicomDataSetInitializeType.ExplicitVRLittleEndian); 
                  ds1.SetOverlayAttributes(0, attributes, DicomSetOverlayFlags.None); 
                  ds1.SetOverlayImage(0, overlayImage);//We can call SetOverlayImages if the overlay has more than one frame 
                  ds1.Save(Path.Combine(LEAD_VARS.ImagesDir, "DICOM", "NewOverlay.dcm"), DicomDataSetSaveFlags.None); 
               } 
            } 
         } 
      } 
   } 
   DicomEngine.Shutdown(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}