1GDCMCLEAN(1)                  DICOM Manipulation.                 GDCMCLEAN(1)
2
3
4

NAME

6       gdcmclean - Tool to clean a DICOM file.
7

SYNOPSIS

9           gdcmclean [options] file-in file-out
10           gdcmclean [options] dir-in  dir-out
11

DESCRIPTION

13       The gdcmclean tool is an cleaning tool.
14

PARAMETERS

16           file-in   DICOM input filename
17
18           file-out  DICOM output filename
19
20       or
21
22           file-in   DICOM input directory
23
24           file-out  DICOM output directory
25

OPTIONS

27       You need to :
28
29   specific options
30             -i --input                  DICOM filename / directory
31             -o --output                 DICOM filename / directory
32             -r --recursive              recursively process (sub-)directories.
33                --continue               Do not stop when file found is not DICOM.
34
35   Editing mode options
36                --empty    %d,%d         DICOM tag(s) to empty
37                           %d,%d,%s      DICOM private tag(s) to empty
38                           %s            DICOM keyword/path(s) to empty
39                --remove   %d,%d         DICOM tag(s) to remove
40                           %d,%d,%s      DICOM private tag(s) to remove
41                           %s            DICOM keyword/path(s) to remove
42                --scrub    %d,%d         DICOM tag(s) to scrub
43                           %d,%d,%s      DICOM private tag(s) to scrub
44                           %s            DICOM keyword/path(s) to scrub
45                --preserve %s            DICOM path(s) to preserve
46                --preserve-missing-private-creator             Whether or not preserve private attributes with missing private creator.
47                --preserve-group-length                        Whether or not preserve deprecated group length attributes (will not be re-computed).
48                --preserve-illegal                             Whether or not preserve illegal attributes (eg. group 0003...).
49
50   general options
51             -h   --help
52                    print this help text and exit
53
54             -v   --version
55                    print version information and exit
56
57             -V   --verbose
58                    verbose mode (warning+error).
59
60             -W   --warning
61                    warning mode, print warning information
62
63             -E   --error
64                    error mode, print error information
65
66             -D   --debug
67                    debug mode, print debug information
68

TYPICAL USAGE

70   Editing mode
71       This functionality is not described in the DICOM standard.
72
73       The following example shows how to use editing mode and achieve
74       multiple operations at the same time:
75
76       •   Preserve illegal attributes (removed by default),
77
78       •   Empty any 'PN' attributes anywhere in the hierarchy tree, but
79           preserve the DICOM attribute value only at location "0010,0010",
80
81       •   Empty the tag (0010,0020) Patient ID, (only if keyword is know
82           internally),
83
84       •   Empty the tag (0070,0084),
85
86       •   Remove the private attributes: (0029,20, SIEMENS MEDCOM HEADER) /
87           (0033,02,MITRA OBJECT UTF8 ATTRIBUTES 1.0) /
88           (0043,2a,GEMS_PARM_01). Since (0033,02,MITRA OBJECT UTF8 ATTRIBUTES
89           1.0) is defined internally in the private dictionary with Value
90           Representation = PN, this attribute will be skipped (since
91           redundant).
92
93       •   Scrub the private attributes: (0029,10,SIEMENS CSA HEADER) /
94           (0029,20,SIEMENS CSA HEADER) / (700d,08,TOSHIBA_MEC_MR3) /
95           (0029,90,PMTF INFORMATION DATA)
96
97           $ gdcmclean \
98               --recursive --continue \
99               --preserve-illegal \
100               --empty PN --preserve /0010,0010 \
101               --empty PatientID --empty "0070,0084" \
102               --remove "0029,20,SIEMENS MEDCOM HEADER" --remove "0033,02,MITRA OBJECT UTF8 ATTRIBUTES 1.0" --remove "0043,2a,GEMS_PARM_01" \
103                --scrub "0029,10,SIEMENS CSA HEADER" --scrub "0029,20,SIEMENS CSA HEADER" \
104                --scrub "700d,08,TOSHIBA_MEC_MR3" \
105                --scrub "0029,90,PMTF INFORMATION DATA" --scrub "0029,90,TOSHIBA_MEC_MR3" \
106               input_folder output_folder
107
108   DICOM Path
109       For ease of use on shell cmmand the syntax allow for the '/' separator
110       in the DICOM Path notation. So the following is valid
111
112           "/0040,0100/1/0040,0006"
113
114       However Private Creator can use all of Value Representation LO
115       definition. So in some case you will be required to use backslash as
116       separator (since illegal in VR:LO):
117
118           "\\4109,2,Applicare/Centricity Radiology Web/Version 1.0"
119
120   Safe Private Attributes
121       It is currently not possible to empty/remove any private attribute
122       listed in the Safe Private Attributes table at:
123
124       https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.10.html#table_E.3.10-1
125

SEE ALSO

127       gdcmanon(1), gdcmdump(1), gdcmdiff(1)
128

AUTHOR

130       Mathieu Malaterre
131           Main developer
132

134       Copyright © 2006, 2011 Mathieu Malaterre
135
136
137
138GDCM 3.0.21                       02/06/2023                      GDCMCLEAN(1)
Impressum