ChangeTransferSyntax(string,string,int,ChangeTransferSyntaxFlags,DicomDataSetSaveFlags) Method

Summary

Changes the Transfer Syntax of the Data Set, and saves resulting DicomDataSet to a file.

Syntax

C++

public void ChangeTransferSyntax( 
   string outFile, 
   string uid, 
   int qualityFactor, 
   ChangeTransferSyntaxFlags flags, 
   DicomDataSetSaveFlags saveFlags 
)

Public Overloads Sub ChangeTransferSyntax( _ 
   ByVal outFile As String, _ 
   ByVal uid As String, _ 
   ByVal qualityFactor As Integer, _ 
   ByVal flags As ChangeTransferSyntaxFlags, _ 
   ByVal saveFlags As DicomDataSetSaveFlags _ 
)

public: 
void ChangeTransferSyntax(  
   String^ outFile, 
   String^ uid, 
   int qualityFactor, 
   ChangeTransferSyntaxFlags flags, 
   DicomDataSetSaveFlags saveFlags 
)

Parameters

outFile
Character string that contains the name of the output file.

uid
Character string that contains the UID of the new Transfer Syntax. For possible values, refer to Transfer Syntax Values.

qualityFactor
The quality factor (Q factor) is a number that determines the degree of loss in the compression process. You can set a value from 2 to 255, where 2 is the highest quality and 255 is the most compression. This parameter only applies when the new Transfer Syntax will involve compressing pixel data using a lossy compression.

flags
Indicates how the compression will be performed.

saveFlags
Flags that indicate the file characteristics to use when saving the file.

Remarks

This method will convert the DicomDataSet Transfer Syntax to the Transfer Syntax specified in [uid](" id="uidparameterlink" class="popuplink.html), maintaining all elements and values in the DicomDataSet. Additionally, the resulting DicomDataSet is saved as a file outFile using the characteristics specified by saveFlags.

This method does everything the function to ChangeTransferSyntax does, but additionally saves a DicomDataSet with the new transfer syntax at the location outFile with save options specified by saveFlags. Note that this overload should be used when trying to produce a file with the new transfer syntax, as opposed to the ChangeTransferSyntax overload followed by calling Save. Using this overload that produces a file directly will be significantly faster and use fewer resources (memory and disk), especially for large files.

Only the following DicomDataSetSaveFlags flags affect how the DicomDataSet is saved to disk.

The following DicomDataSetSaveFlags flags are ignored, and have no effect with how DicomDataSet is saved to disk. These flags are ignored because the transfer syntax specified by [uid](" id="uidparameterlink" class="popuplink.html) determines little endian versus big endian, as implicit VR versus explicit VR.

Passing null for outFile if you do not want to save the result as a file. In this case, the saveFlags are ignored. This is functionally equivalent to using the ChangeTransferSyntax overload .

For more details about changing the transfer syntax, see ChangeTransferSyntax.

Example

This example will change the trasfer syntax of a DicomDataSet and save the result as a file.

using Leadtools; 
using Leadtools.Dicom; 
 
///  
public void Test_DicomDataSet_ChangeTransferSyntaxSample() 
{ 
   string dicomFileName = Path.Combine(LEAD_VARS.ImagesDir, "IMAGE2.dcm"); 
   string dicomResultFileHame = Path.Combine(LEAD_VARS.ImagesDir, "Result.dcm"); 
   DicomEngine.Startup(); 
   using (DicomDataSet ds = new DicomDataSet()) 
   { 
      ds.Load(dicomFileName, DicomDataSetLoadFlags.None); 
      ds.ChangeTransferSyntax(dicomResultFileHame, DicomUidType.ExplicitVRBigEndian, 0, ChangeTransferSyntaxFlags.None, DicomDataSetSaveFlags.None); 
   } 
   DicomEngine.Shutdown(); 
} 
///  
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Dicom 
 
'''  
Public Sub Test_DicomDataSet_ChangeTransferSyntaxSample() 
   Dim dicomFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "IMAGE2.dcm") 
   Dim dicomResultFileHame As String = Path.Combine(LEAD_VARS.ImagesDir, "Result.dcm") 
   DicomEngine.Startup() 
   Using ds As New DicomDataSet() 
      ds.Load(dicomFileName, DicomDataSetLoadFlags.None) 
      ds.ChangeTransferSyntax(dicomResultFileHame, DicomUidType.ExplicitVRBigEndian, 0, ChangeTransferSyntaxFlags.None, DicomDataSetSaveFlags.None) 
   End Using 
   DicomEngine.Shutdown() 
End Sub 
  '''  
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

DicomDataSet Class

DicomDataSet Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Dicom Assembly

Introduction

Getting Started

Namespaces

Leadtools.Dicom Namespace

Assemblies