GetDicom Method (IDICOMObjectRetrieve)

'Declaration
 
Function GetDicom( _
   ByVal sopInstanceUID As String, _
   ByVal stripImage As Boolean, _
   ByVal transferSyntax As String, _
   ByVal qualityFactor As Integer, _
   ByVal extraData As String _
) As Byte()

'Usage
 
Dim instance As IDICOMObjectRetrieve
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)

byte[] GetDicom( 
   string sopInstanceUID,
   bool stripImage,
   string transferSyntax,
   int qualityFactor,
   string extraData
)

array<byte>^ GetDicom( 
   String^ sopInstanceUID,
   bool stripImage,
   String^ transferSyntax,
   int qualityFactor,
   String^ extraData
) 

Parameters

sopInstanceUID

A System.String representing the SOP Instance UID of the DICOM object to match.

stripImage

true to return the DICOM object without the image data.

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

Retrieves a DICOM object with or without the image data. This is useful when you are only interested in the DICOM information and do not want the original image.

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

Target Platforms

Reference

IDICOMObjectRetrieve Interface
IDICOMObjectRetrieve Members