1dcmmkdir(1) OFFIS DCMTK dcmmkdir(1)
2
6 dcmmkdir - Create a DICOMDIR file
7
9 dcmmkdir [options] [dcmfile-in...]
10
12 The dcmmkdir utility creates a DICOMDIR file from the specified
13 referenced DICOM files according to the DICOM Part 11 Media Storage
14 Application Profiles.
15 Currently the following profiles are supported (others might be added
17 later):
18 · General Purpose CD-R Interchange (STD-GEN-CD)
20 · General Purpose Interchange on DVD-RAM Media (STD-GEN-DVD-RAM)
21 · General Purpose DVD with Compression Interchange (STD-GEN-DVD-
22 JPEG/J2K)
23 · General Purpose MIME Interchange (STD-GEN-MIME)
24 · General Purpose USB and Flash Memory with Compression Interchange
25 (STD-GEN-USB/MMC/CF/SD-JPEG/J2K)
26 · DVD Interchange with MPEG2 MP@ML (STD-DVD-MPEG2-MPML)
27 · Basic Cardiac X-Ray Angiographic Studies on CD-R Media (STD-XABC-CD)
28 · 1024 X-Ray Angiographic Studies on CD-R Media (STD-XA1K-CD)
29 · 1024 X-Ray Angiographic Studies on DVD Media (STD-XA1K-DVD)
30 · Dental Radiograph Interchange (STD-DEN-CD)
31 · CT/MR Studies on various Media (STD-CTMR-xxxx)
32 · Ultrasound Single Frame for Image Display (STD-US-ID-SF-xxxx)
33 · Ultrasound Single Frame with Spatial Calibration (STD-US-SC-SF-xxxx)
34 · Ultrasound Single Frame with Combined Calibration (STD-US-CC-SF-xxxx)
35 · Ultrasound Single & Multi-Frame for Image Display (STD-US-ID-MF-xxxx)
36 · Ultrasound Single & Multi-Frame with Spatial Calibration (STD-US-SC-
37 MF-xxxx)
38 · Ultrasound Single & Multi-Frame with Combined Calibration (STD-US-CC-
39 MF-xxxx)
40 · 12-lead ECG Interchange on Diskette (STD-WVFM-ECG-FD)
41 · Hemodynamic Waveform Interchange on Diskette (STD-WVFM-HD-FD)
42 This tool extends dcmgpdir which can only create General Purpose
43 DICOMDIR files. The default behaviour of dcmmkdir (with --general-
44 purpose) is equivalent to that of dcmgpdir.
46 dcmfile-in referenced DICOM file
48 general options
49 -h --help
50 print this help text and exit
51 --version
53 print version information and exit
54 --arguments
56 print expanded command line arguments
57 -q --quiet
59 quiet mode, print no warnings and errors
60 -v --verbose
62 verbose mode, print processing details
63 -d --debug
65 debug mode, print debug information
66 -ll --log-level [l]evel: string constant
68 (fatal, error, warn, info, debug, trace)
69 use level l for the logger
70 -lc --log-config [f]ilename: string
72 use config file f for the logger
73 input options
74 DICOMDIR identifiers:
75 +D --output-file [f]ilename: string
77 generate specific DICOMDIR file
78 (default: DICOMDIR in current directory)
79 +F --fileset-id [i]d: string (default: DCMTK_MEDIA_DEMO)
81 use specific file set ID
82 +R --descriptor [f]ilename: string
84 add a file set descriptor file ID
85 (e.g. README, default: no descriptor)
86 +C --char-set [c]harset: string
88 add a specific character set for descriptor
89 (default: "ISO_IR 100" if descriptor present)
90 reading:
92 +id --input-directory [d]irectory: string
94 read referenced DICOM files from directory d
95 (default for --recurse: current directory)
96 -m --keep-filenames
98 expect filenames to be in DICOM format (default)
99 +m --map-filenames
101 map to DICOM filenames (lowercase->uppercase,
102 and remove trailing period)
103 -r --no-recurse
105 do not recurse within directories (default)
106 +r --recurse
108 recurse within filesystem directories
109 +p --pattern [p]attern: string (only with --recurse)
111 pattern for filename matching (wildcards)
112 # possibly not available on all systems
114 processing options
115 consistency check:
116 -W --no-consistency-check
118 do not check files for consistency
119 +W --warn-inconsist-files
121 warn about inconsistent files (default)
122 -a --abort-inconsist-file
124 abort on first inconsistent file
125 type 1 attributes:
127 -I --strict
129 exit with error if DICOMDIR type 1 attributes
130 are missing in DICOM file (default)
131 +I --invent
133 invent DICOMDIR type 1 attributes if missing in DICOM file
134 +Ipi --invent-patient-id
136 invent new PatientID in case of inconsistent
137 PatientName attributes
138 other checks:
140 +Nrs --allow-retired-sop
142 allow retired SOP classes defined in previous editions
143 of the DICOM standard
144 -Nxc --no-xfer-check
146 do not reject images with non-standard transfer syntax
147 (just warn)
148 -Nec --no-encoding-check
150 do not reject images with non-standard pixel encoding
151 (just warn)
152 -Nrc --no-resolution-check
154 do not reject images with non-standard spatial resolution
155 (just warn)
156 icon images:
158 +X --add-icon-image
160 add monochrome icon image on IMAGE level
161 (default for cardiac profiles)
162 -Xs --icon-image-size [s]ize: integer (1..128)
164 width and height of the icon image (in pixel)
165 (fixed: 128 for XA, 64 for CT/MR profile)
166 -Xi --icon-file-prefix [p]refix: string
168 use PGM image 'prefix'+'dcmfile-in' as icon
169 (default: create icon from DICOM image)
170 -Xd --default-icon [f]ilename: string
172 use specified PGM image if icon cannot be
173 created automatically (default: black image)
174 output options
175 profiles:
176 -Pgp --general-purpose
178 General Purpose Interchange on CD-R or
179 DVD-RAM Media (STD-GEN-CD/DVD-RAM, default)
180 -Pdv --general-purpose-dvd
182 General Purpose DVD with Compression Interchange
183 (STD-GEN-DVD-JPEG/J2K)
184 -Pmi --general-purpose-mime
186 General Purpose MIME Interchange (STD-GEN-MIME)
187 -Pfl --usb-and-flash
189 General Purpose USB/Flash Memory with Compression
190 Interchange (STD-GEN-USB/MMC/CF/SD-JPEG/J2K)
191 -Pmp --mpeg2-mpml-dvd
193 DVD Interchange with MPEG2 Main Profile @ Main
194 Level (STD-DVD-MPEG2-MPML)
195 -Pbc --basic-cardiac
197 Basic Cardiac X-Ray Angiographic Studies on
198 CD-R Media (STD-XABC-CD)
199 -Pxa --xray-angiographic
201 1024 X-Ray Angiographic Studies on CD-R Media
202 (STD-XA1K-CD)
203 -Pxd --xray-angiographic-dvd
205 1024 X-Ray Angiographic Studies on DVD Media
206 (STD-XA1K-DVD)
207 -Pde --dental-radiograph
209 Dental Radiograph Interchange (STD-DEN-CD)
210 -Pcm --ct-and-mr
212 CT/MR Studies (STD-CTMR-xxxx)
213 -Pus --ultrasound-id-sf
215 Ultrasound Single Frame for Image Display
216 (STD-US-ID-SF-xxxx)
217 --ultrasound-sc-sf
219 Ultrasound Single Frame with Spatial
220 Calibration (STD-US-SC-SF-xxxx)
221 --ultrasound-cc-sf
223 Ultrasound Single Frame with Combined
224 Calibration (STD-US-CC-SF-xxxx)
225 -Pum --ultrasound-id-mf
227 Ultrasound Single & Multi-Frame for Image
228 Display (STD-US-ID-MF-xxxx)
229 --ultrasound-sc-mf
231 Ultrasound Single & Multi-Frame with Spatial
232 Calibration (STD-UD-SC-MF-xxxx)
233 --ultrasound-cc-mf
235 Ultrasound Single & Multi-Frame with Combined
236 Calibration (STD-UD-CC-MF-xxxx)
237 -Pec --12-lead-ecg
239 12-lead ECG Interchange on Diskette
240 (STD-WVFM-ECG-FD)
241 -Phd --hemodynamic-waveform
243 Hemodynamic Waveform Interchange on Diskette
244 (STD-WVFM-HD-FD)
245 writing:
247 -A --replace
249 replace existing DICOMDIR (default)
250 +A --append
252 append to existing DICOMDIR
253 +U --update
255 update existing DICOMDIR
256 -w --discard
258 do not write out DICOMDIR
259 -nb --no-backup
261 do not create a backup of existing DICOMDIR
262 post-1993 value representations:
264 +u --enable-new-vr
266 enable support for new VRs (UN/UT) (default)
267 -u --disable-new-vr
269 disable support for new VRs, convert to OB
270 group length encoding:
272 -g --group-length-remove
274 write without group length elements (default)
275 +g --group-length-create
277 write with group length elements
278 length encoding in sequences and items:
280 +e --length-explicit
282 write with explicit lengths (default)
283 -e --length-undefined
285 write with undefined lengths
287 All files specified on the command line (or discovered by recursivly
288 examining the contents of directories with the +r option) are first
289 evaluated for their compatibility with the specified Media Storage
290 Application Profile (Part 11). Only appropriate files encoded using one
291 of the allowed Transfer Syntaxes will be accepted. Files having invalid
292 filenames will be rejected (the rules can be relaxed via the +m
293 option). Files missing required attributes will be rejected (the +I
294 option can relax this behaviour).
295 A DICOMDIR file will only be constructed if all files have passed
296 initial tests.
297 The dcmmkdir utility also allows to append new entries to and to update
298 existing entries in a DICOMDIR file. Using option +A new entries are
299 only appended to the DICOMDIR, i.e. existing records like the ones for
300 PATIENT information are not updated. Using option +U also existing
301 records are updated according to the information found in the
302 referenced DICOM files. Please note that this update process might be
303 slower than just appending new entries. However, it makes sure that
304 additional information that is required for the selected application
305 profile is also added to existing records.
306 The support for icon images is currently restricted to monochrome
307 images. This might change in the future. Till then, color images are
308 automatically converted to grayscale mode. The icon size is 128*128
309 pixels for the cardiac profiles (as required by the DICOM standard) and
310 64*64 for all others.
312 The level of logging output of the various command line tools and
313 underlying libraries can be specified by the user. By default, only
314 errors and warnings are written to the standard error stream. Using
315 option --verbose also informational messages like processing details
316 are reported. Option --debug can be used to get more details on the
317 internal activity, e.g. for debugging purposes. Other logging levels
318 can be selected using option --log-level. In --quiet mode only fatal
319 errors are reported. In such very severe error events, the application
320 will usually terminate. For more details on the different logging
321 levels, see documentation of module 'oflog'.
322 In case the logging output should be written to file (optionally with
323 logfile rotation), to syslog (Unix) or the event log (Windows) option
324 --log-config can be used. This configuration file also allows for
325 directing only certain messages to a particular output stream and for
326 filtering certain messages based on the module or application where
327 they are generated. An example configuration file is provided in
328 <etcdir>/logger.cfg).
330 All command line tools use the following notation for parameters:
331 square brackets enclose optional values (0-1), three trailing dots
332 indicate that multiple values are allowed (1-n), a combination of both
333 means 0 to n values.
334 Command line options are distinguished from parameters by a leading '+'
335 or '-' sign, respectively. Usually, order and position of command line
336 options are arbitrary (i.e. they can appear anywhere). However, if
337 options are mutually exclusive the rightmost appearance is used. This
338 behaviour conforms to the standard evaluation rules of common Unix
339 shells.
340 In addition, one or more command files can be specified using an '@'
341 sign as a prefix to the filename (e.g. @command.txt). Such a command
342 argument is replaced by the content of the corresponding text file
343 (multiple whitespaces are treated as a single separator unless they
344 appear between two quotation marks) prior to any further evaluation.
345 Please note that a command file cannot contain another command file.
346 This simple but effective approach allows to summarize common
347 combinations of options/parameters and avoids longish and confusing
348 command lines (an example is provided in file <datadir>/dumppat.txt).
350 The dcmmkdir utility will attempt to load DICOM data dictionaries
351 specified in the DCMDICTPATH environment variable. By default, i.e. if
352 the DCMDICTPATH environment variable is not set, the file
353 <datadir>/dicom.dic will be loaded unless the dictionary is built into
354 the application (default for Windows).
355 The default behaviour should be preferred and the DCMDICTPATH
356 environment variable only used when alternative data dictionaries are
357 required. The DCMDICTPATH environment variable has the same format as
358 the Unix shell PATH variable in that a colon (':') separates entries.
359 On Windows systems, a semicolon (';') is used as a separator. The data
360 dictionary code will attempt to load each file specified in the
361 DCMDICTPATH environment variable. It is an error if no data dictionary
362 can be loaded.
364 dcmgpdir(1)
366 Copyright (C) 2001-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
367 Germany.
368Version 3.6.0 6 Jan 2011 dcmmkdir(1)