DicomEdit
DicomEdit is a software library that provides the ability to read DICOM objects, transform their contents based on a scripted list of commands, and to output the transformed DICOM. Scripts are created by users in the small custom language defined by DicomEdit. Scripts can be general purpose, providing a general anonymization, or they can be customized to handle unique requirements posed by a specific project and its unique data sources.
DicomEdit 6.x is written in ANTLR and Java and is open source (BSD license), and depends on the dcm4che2 DICOM Toolkit. DicomEdit is embedded within each XNAT release, meaning that there is no action required for XNAT admins to enable the functionality described in this documentation. DicomEdit can also be packaged to provide a runnable jar providing a stand-alone command-line tool. See instructions in the DicomEdit6 code repository for details.
Code Repository: https://bitbucket.org/xnatdcm/dicom-edit6/src/master/
Language Reference
The language is described in detail in the DicomEdit 6 Language Reference.
Documentation for the previous version is documented here: DicomEdit 4.2 Language Reference.
Note: DicomEdit version 6.0 introduced some changes to the scripting language that are not backward compatible with previous versions of DicomEdit. See the DicomEdit 6.0 Release Notes for details.
Version Compatibility Matrix
Anonymization script features described in these docs are dependent on the version of DicomEdit that is supported by the version of XNAT that you are running. Each function reference refers to a DicomEdit version.
XNAT Versions | Supported DicomEdit Versions |
|---|---|
1.8.10 | DicomEdit 6.0 – 6.6 and DicomEdit 4.2 |
1.8.8 – 1.8.9.x | DicomEdit 6.0 – 6.5 and DicomEdit 4.2 |
1.8.7.x | DicomEdit 6.0 – 6.4 and DicomEdit 4.2 |
1.8.0 – 1.8.6.x | DicomEdit 6.0 – 6.3 and DicomEdit 4.2 |
1.7.4 – 1.7.6.x | DicomEdit 6.0 – 6.1 and DicomEdit 4.2 |
1.7.0 – 1.7.3 | DicomEdit 6.0 – 6.1 only |