LEADTOOLS Medical (Leadtools.MedicalWebViewer.DICOMObjectRetrieve assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.25
DoGetDicom Method
See Also 
Leadtools.Dicom.Services.MedicalWebViewer Namespace > MedicalWebViewerObjectRetrieve Class : DoGetDicom Method



dicomFile
The physical path of the DICOM file.
stripImage
true to return the DICOM object without the image.
transferSyntax
Character string that contains the UID of the new Transfer Syntax, pass null or System.String.Empty to keep the original Transfer Syntax.
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. This value will be ignored if transferSyntax is null or System.String.Empty.
extraData
User custom data.

The DoGetDicom Method is available as an add-on to the LEADTOOLS Medical Imaging toolkits.

dicomFile
The physical path of the DICOM file.
stripImage
true to return the DICOM object without the image.
transferSyntax
Character string that contains the UID of the new Transfer Syntax, pass null or System.String.Empty to keep the original Transfer Syntax.
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. This value will be ignored if transferSyntax is null or System.String.Empty.
extraData
User custom data.
Retrieves a DICOM Object file.

Syntax

Visual Basic (Declaration) 
Overrides Protected Function DoGetDicom( _
   ByVal dicomFile As String, _
   ByVal stripImage As Boolean, _
   ByVal transferSyntax As String, _
   ByVal qualityFactor As Integer, _
   ByVal extraData As String _
) As Byte()
Visual Basic (Usage)Copy Code
Dim instance As MedicalWebViewerObjectRetrieve
Dim dicomFile As String
Dim stripImage As Boolean
Dim transferSyntax As String
Dim qualityFactor As Integer
Dim extraData As String
Dim value() As Byte
 
value = instance.DoGetDicom(dicomFile, stripImage, transferSyntax, qualityFactor, extraData)
C# 
protected override byte[] DoGetDicom( 
   string dicomFile,
   bool stripImage,
   string transferSyntax,
   int qualityFactor,
   string extraData
)
C++/CLI 
protected:
array<byte>^ DoGetDicom( 
   String^ dicomFile,
   bool stripImage,
   String^ transferSyntax,
   int qualityFactor,
   String^ extraData
) override 

Parameters

dicomFile
The physical path of the DICOM file.
stripImage
true to return the DICOM object without the image.
transferSyntax
Character string that contains the UID of the new Transfer Syntax, pass null or System.String.Empty to keep the original Transfer Syntax.
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. This value will be ignored if transferSyntax is null or System.String.Empty.
extraData
User custom data.

Return Value

An data buffer containing the DICOM Object.

Remarks

This method allows you to retrieve a DICOM object with or without the image data. This is useful when you are only interested in the DICOM information and don’t want the original image.

You can also retrieve the DICOM object with your preferred Transfer Syntax and compression quality factor.

Requirements

Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also