←Select platform

GetDicom Method (DICOMObjectRetrieve)

Summary

Retrieves a DICOM object with options.

Syntax

C++

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

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()

public: 
virtual 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

An data buffer containing the requested DICOM Object.

Remarks

Retrieves 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

See Also