SaveJson(DicomDataSet,string,DicomDataSetSaveJsonFlags,SaveJsonCallback) Method

Saves the contents of the DICOM data set in the DICOM JSON model format (specified in PS3.18) to the specified output file.
public static void SaveJson( 
   this DicomDataSet ds, 
   string fileName, 
   DicomDataSetSaveJsonFlags jsonFlags, 
   SaveJsonCallback cb 
static void SaveJson(  
   DicomDataSet^ ds, 
   String^ fileName, 
   DicomDataSetSaveJsonFlags jsonFlags, 
   SaveJsonCallback^ cb 


The contents of this data set to be saved

The name of the output JSON file.

Flags that affect how binary data and other information is saved in the JSON output file.

Optional callback that allows you to change the element names, attributes, and values of the JSON output file.


Use this method to export a DicomDataSet as a human-readable JSON file. By default, all binary data is using BulkDataUri with dummy URIs, but this behavior can be modified by passing appropriate DicomDataSetSaveJsonFlags

The output JSON format is the DICOM JSON Model defined in the DICOM specification in PS3.18.F.

Note: When saving the pixel data of multipage compressed files to JSON, only the first frame is saved. This is because of the restriction specified in PS3.18.F.2.7 that states "There is a single InlineBinary value representing the entire Value Field, and not one per Value".

using Leadtools.Dicom; 
using Leadtools.Dicom.Common; 
using Leadtools.Dicom.Common.Extensions; 
using Leadtools; 
using Leadtools.Dicom.Common.Linq.BasicDirectory; 
using Leadtools.Dicom.Common.DataTypes; 
using Leadtools.Codecs; 
public void SaveJsonCallbackExample() 
   uriIndex = 0; 
   string dicomFileNameIn = Path.Combine(LEAD_VARS.ImagesDir, "DICOM", "IMAGE3.dcm"); 
   string xmlFileNameOut = Path.Combine(LEAD_VARS.ImagesDir, "test.json"); 
   DicomDataSet ds = new DicomDataSet(); 
   // Load an existing DICOM file 
   ds.Load(dicomFileNameIn, DicomDataSetLoadFlags.None); 
   // Keep the JSON output file size small by writing binary data as BulkDataUri  
   // The URI written is modified in the callback 
   ds.SaveJson(xmlFileNameOut, DicomDataSetSaveJsonFlags.BulkDataUri, MySaveJsonCallback); 
public static int uriIndex = 0; 
public static string GenerateUri() 
   return string.Format(@"http://MySampleUri/{0}", uriIndex); 
public static bool MySaveJsonCallback(SaveJsonData d) 
   if (d.DicomElement == null) 
      return true; 
   DicomVRType vr = d.DicomElement.VR; 
   bool isBinary = ( 
                      vr == DicomVRType.OB || 
                      vr == DicomVRType.OD || 
                      vr == DicomVRType.OF || 
                      vr == DicomVRType.OW || 
                      vr == DicomVRType.UN 
   if (isBinary) 
      // Set a URI 
      d.BulkDataUri = GenerateUri(); 
   return true; 
static class LEAD_VARS 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 

Target Platforms

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

Leadtools.Dicom.Common Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.