Leadtools.Dicom.WCF Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetDicom Method
See Also 
Leadtools.Dicom.WCF Namespace > DICOMService Class : GetDicom Method



sopInstanceUID
A String representing the SOP Instance UID of the DICOM object to match.
stripImage
true to return the DICOM object without the image data; otherwise false.
transferSyntax
Character string that contains the UID of the new Transfer Syntax, pass null or 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 Empty.
extraData
user custom data.
sopInstanceUID
A String representing the SOP Instance UID of the DICOM object to match.
stripImage
true to return the DICOM object without the image data; otherwise false.
transferSyntax
Character string that contains the UID of the new Transfer Syntax, pass null or 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 Empty.
extraData
user custom data.
Retrieve a DICOM object with options.

Syntax

Visual Basic (Declaration) 
Public Overridable Function GetDicom( _
   ByVal sopInstanceUID 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 DICOMService
Dim sopInstanceUID As String
Dim stripImage As Boolean
Dim transferSyntax As String
Dim qualityFactor As Integer
Dim extraData As String
Dim value() As Byte
 
value = instance.GetDicom(sopInstanceUID, stripImage, transferSyntax, qualityFactor, extraData)
C# 
public virtual byte[] GetDicom( 
   string sopInstanceUID,
   bool stripImage,
   string transferSyntax,
   int qualityFactor,
   string extraData
)
C++/CLI 
public:
virtual array<byte>^ GetDicom( 
   String^ sopInstanceUID,
   bool stripImage,
   String^ transferSyntax,
   int qualityFactor,
   String^ extraData
) 

Parameters

sopInstanceUID
A String representing the SOP Instance UID of the DICOM object to match.
stripImage
true to return the DICOM object without the image data; otherwise false.
transferSyntax
Character string that contains the UID of the new Transfer Syntax, pass null or 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 Empty.
extraData
user custom data.

Return Value

An data buffer containing the requested 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: Microsoft .NET Framework 3.0, Windows XP, Windows Vista, Windows Server 2003 family, Windows Server 2008 family

See Also

GetDicom requires a Web Viewer Framework Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features