Contents
Navigation
Home User Reference Other Resources


This module allows you to perform common tasks connected with Dicom files management. You can determine if a file is Dicom compliant, open it and load the data in memory; also you can export the content of Dicom files as text or xml, create anonymous copies of such a files or just extract their meta informations. Furthermore the module provides some facility to create UIDs and IDs.

Since version 6.3 of the plugin this module can be used in Console Applications





specifies the Dicom document mimetype as specified in IETF RFC3240

(srcFile as folderitem) as boolean
determines whether the file specified by the srcFile parameter can be handled by the plugin as a a dicom file. In this case you can use the function to obtain a reference to its data structure
returns true if the QTPluginDicom can open the specified file as a dicom file, otherwise returns false
(srcFile as folderitem) as
use this method if you just want to extract from the file specified by the srcFile parameter the informations stored into the File Meta Elements of the dicom file
returns a class instance if the specified file is a dicom file, otherwise returns nil
(srcFile as folderitem, description as string) as integer
this method allows you to add to the built–in Standard Data Element dictionary data elements originally not included into it. This can be useful to deal with sets of private data elements or if the built–in dictionary lacks of some data element included into older versions of the Standard. The srcFile parameter must point to a text file where each data element is stored in a separate line of text with the following simple format:

gggg,eeee_dicomKey_vr_multeplicity

where gggg,eeee represent the data element tag in hexadecimal, dicomKey is a string describing the data element, vr is a two characters string representing the value representation field, multeplicity is a string indicating the value multeplicity and, finally, _ represents a single white space. As an example the following line could be represent a single valid entry:

0019,0001 test1 LO 1-n

Lines beginning with # will be ignored by the parser. The description parameter allows you to associate a descriptive text to the loaded data elements (at time is not used)
returns an error code (0=no error)
(srcFile as folderitem, dstFile as folderitem) as integer
if does the selected file can be read by the plugin (use the method to check it), you can use this method to dump the the dicom data stored into the binary file specified by the srcFile parameter to a text file specified by the dstFile parameter.
returns an error code (0=no error)
(srcFile as folderitem, dstFile as folderitem) as integer
if does the selected file can be read by the plugin (use the method to check it), you can use this method to dump the the dicom data stored into the binary file specified by the srcFile parameter to a xml file specified by the dstFile parameter.
returns an error code (0=no error)
(srcFile as folderitem, dstFile as folderitem) as integer
if does the selected file can be read by the plugin (use the method to check it), you can use this method to create an "anonymous" copy of the dicom data stored into the file specified by the srcFile parameter and to save them into the file specified by the dstFile
returns an error code (0=no error)
(srcFile as folderitem) as
if does the selected file can be read by the plugin (use the method to check it), you can use this method to obtain a reference to the data structure of the dicom file specified by the srcFile parameter. Then, you can extract information or display the image data, if present, by using the appropriate dicom classes featured by the plugin. You can check the type of dicom document returned by this function using the RealBasic isA operator
returns a reference to the dicom data structure as a class instance; if the specified file is not a dicom file or some other error occurs returns nil
() as string
use this method to create an identifier to use during the process of "anonymization" of a Dicom file
returns a string
([prefix as string=""]) as string
use this method to generate an unique identifier string to use with Dicom data elements that need it. You can specify the part of the UID that represents your organization by passing it into the prefix parameter. To know more about Unique Identifiers in Dicom see the Part 5 of the Standard
returns a string


specifies the version of the QTPluginDicom currently used (i.e the value of this constant for the version 6.0.0 of the plugin is 600). You can use this value for pre–processor instructions as well
a dot separated text (major.minor.revision) specifying the version of the QTPluginDicom currently used