←Select platform

Load(string,DicomDataSetLoadFlags) Method

Loads a Data Set from a disk file.
public virtual void Load( 
   string name, 
   DicomDataSetLoadFlags flags 
public void load(String file, /*DicomDataSetLoadFlags*/ int flags) 
virtual void Load(  
   String^ name, 
   DicomDataSetLoadFlags flags 


The name of the file that contains the Data Set to be loaded.

Meta-header flags and Transfer Syntax flags that indicate the file characteristics to use when loading the file.


If you know certain characteristics of the file, you can set those in flags. Any characteristic that you do not set will be automatically determined. For example, if you know that the Meta-header is present, but you do not know the byte order, or whether the Value Representation is Implicit or Explicit, you can set only DicomDataSetLoadFlags.MetaHeaderPresent in flags. During loading, LEADTOOLS will determine the byte order and whether the byte order is Implicit or Explicit. If you do not know any of the characteristics of the file, set flags to DicomDataSetLoadFlags.None and LEADTOOLS will automatically determine all the file characteristics and load the file accordingly.

If DicomDataSetLoadFlags.LoadAndClose is not included in flags, the file will remain open until the object is destructed, or one of the following methods is called: Reset, Initialize, or Load (again). If LoadAndClose is used for large images it may slow performance; however, the file handle will be released. If set to None, large images will load quickly, and image traverse can begin immediately. Although, nothing can be done to the image until the file handle is released.

To load a Data Set from memory, call Load.


This example will load a DICOM Dataset and enumerate all its elements.

using Leadtools; 
using Leadtools.Dicom; 
public void LoadEnumerateSample() 
   string dicomFileName = Path.Combine(LEAD_VARS.ImagesDir, "DICOM", "image3.dcm"); 
   //Make sure to initialize the DICOM engine, this needs to be done only once  
   //In the whole application 
   using (DicomDataSet ds = new DicomDataSet()) 
      //Load DICOM File 
      ds.Load(dicomFileName, DicomDataSetLoadFlags.None); 
      //Insert patient name element, if it doesn't already exist 
      DicomElement element = ds.FindFirstElement(null, DicomTag.PatientName, false); 
      if (element == null) 
         element = ds.InsertElement(null, false, DicomTag.PatientName, DicomVRType.PN, false, 0); 
      //The dataset should include the patient name element or an error occurred 
      element = ds.FindLastElement(null, DicomTag.PatientName, false); 
      Debug.Assert(element != null); 
      //There can be only one patient element in the root level 
      element = ds.FindPreviousElement(null, false); 
      Debug.Assert(element == null); 
      element = ds.FindNextElement(null, false); 
      Debug.Assert(element == null); 
      element = ds.FindFirstElement(null, DicomTag.PatientName, false); 
      //Since the patient name element is in the root level, 
      //GetRootElement will return the same element. 
      DicomElement element1 = ds.GetRootElement(element); 
      Debug.Assert((element1.Tag == element.Tag), "GetRootElement should return same element"); 
      //Since the patient name element has no parent then GetParentElement will return null 
      element1 = ds.GetParentElement(element); 
      Debug.Assert(element1 == null, "GetParentElement should return null"); 
      //Since the patient name element has no children then GetChildElement will return null 
      element1 = ds.GetChildElement(element, false); 
      Debug.Assert(element1 == null, "GetChildElement should return null"); 
      element1 = ds.GetFirstElement(element, false, false); 
      Debug.Assert(element1 != null, "GetFirstElement Can't return null in this case"); 
      element1 = ds.GetLastElement(element, false, false); 
      Debug.Assert(element1 != null, "GetLastElement Can't return null in this case"); 
      element1 = ds.GetPreviousElement(element, false, true); 
      DicomElement element2 = ds.GetNextElement(element, false, true); 
      Debug.Assert(ds.GetElementLevel(element) == 0); 
      Debug.Assert(ds.IsVolatileElement(element) == false); 
      //Patient Name is not the only element in this level 
      Debug.Assert((element1 != null) && (element2 != null)); 
      //Delete the patient name element 
static class LEAD_VARS 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom Assembly