Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
OverlayCount Property
See Also  Example
Leadtools.Dicom Namespace > DicomDataSet Class : OverlayCount Property



Gets the number of overlays in the Data Set.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property OverlayCount As Integer
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim value As Integer
 
value = instance.OverlayCount
C# 
public int OverlayCount {get;}
C++/CLI 
public:
property int OverlayCount {
   int get();
}

Return Value

The number of overlays in the Data Set.

Example

This example will read a DICOM dataset and update its overlay attributes and overlay image.

Visual BasicCopy Code
Public Sub TestOverlay()
   Dim dicomFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Overlay.dic"
   'Make sure to initialize the DICOM engine, this needs to be done only once
   'In the whole application
   DicomEngine.Startup()

   Dim ds As DicomDataSet = New DicomDataSet()
   Using (ds)
      'Load DICOM File
      ds.Load(dicomFileName, DicomDataSetLoadFlags.None)

      If ds.OverlayCount > 0 Then
         Dim attributes As RasterOverlayAttributes = ds.GetOverlayAttributes(0)
         If Not attributes Is Nothing Then
            ' 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
            Dim overlayImage As RasterImage = ds.GetOverlayImage(0)
            If Not overlayImage Is Nothing Then

               Dim ds1 As DicomDataSet = New DicomDataSet()
               Using (ds1)
                  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(LeadtoolsExamples.Common.ImagesPath.Path + "NewOverlay.dcm", DicomDataSetSaveFlags.None)
               End Using

            End If
         End If
      End If
   End Using

   DicomEngine.Shutdown()
End Sub
C#Copy Code
public void TestOverlay() 

   string dicomFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Overlay.dic"; 
   //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(LeadtoolsExamples.Common.ImagesPath.Path + "NewOverlay.dcm", DicomDataSetSaveFlags.None); 
               } 
            } 
         } 
      } 
   } 
   DicomEngine.Shutdown(); 
}

Remarks

This property gets the number of overlays inside a Data Set by counting the number of repeating groups in the range (6000-601E).

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features