1dcmgpdir(1) OFFIS DCMTK dcmgpdir(1)
2
6 dcmgpdir - Create a general purpose DICOMDIR
7
9 dcmgpdir [options] [dcmfile-in...]
10
12 The dcmgpdir 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:
17 · General Purpose CD-R Interchange (STD-GEN-CD)
19 · General Purpose Interchange on DVD-RAM Media (STD-GEN-DVD-RAM)
20 dcmmkdir is an extended version of this tool which also supports other
21 Media Storage Application Profiles than the general purpose one (e.g.
22 both cardio profiles requiring the use of icon images).
24 dcmfile-in referenced DICOM file
26 general options
27 -h --help
28 print this help text and exit
29 --version
31 print version information and exit
32 --arguments
34 print expanded command line arguments
35 -q --quiet
37 quiet mode, print no warnings and errors
38 -v --verbose
40 verbose mode, print processing details
41 -d --debug
43 debug mode, print debug information
44 -ll --log-level [l]evel: string constant
46 (fatal, error, warn, info, debug, trace)
47 use level l for the logger
48 -lc --log-config [f]ilename: string
50 use config file f for the logger
51 input options
52 DICOMDIR identifiers:
53 +D --output-file [f]ilename: string
55 generate specific DICOMDIR file
56 (default: DICOMDIR in current directory)
57 +F --fileset-id [i]d: string (default: DCMTK_MEDIA_DEMO)
59 use specific file set ID
60 +R --descriptor [f]ilename: string
62 add a file set descriptor file ID
63 (e.g. README, default: no descriptor)
64 +C --char-set [c]harset: string
66 add a specific character set for descriptor
67 (default: "ISO_IR 100" if descriptor present)
68 reading:
70 +id --input-directory [d]irectory: string
72 read referenced DICOM files from directory d
73 (default for --recurse: current directory)
74 -m --keep-filenames
76 expect filenames to be in DICOM format (default)
77 +m --map-filenames
79 map to DICOM filenames (lowercase->uppercase,
80 and remove trailing period)
81 -r --no-recurse
83 do not recurse within directories (default)
84 +r --recurse
86 recurse within filesystem directories
87 +p --pattern [p]attern: string (only with --recurse)
89 pattern for filename matching (wildcards)
90 # possibly not available on all systems
92 processing options
93 consistency check:
94 -W --no-consistency-check
96 do not check files for consistency
97 +W --warn-inconsist-files
99 warn about inconsistent files (default)
100 -a --abort-inconsist-file
102 abort on first inconsistent file
103 type 1 attributes:
105 -I --strict
107 exit with error if DICOMDIR type 1 attributes
108 are missing in DICOM file (default)
109 +I --invent
111 invent DICOMDIR type 1 attributes if missing in DICOM file
112 +Ipi --invent-patient-id
114 invent new PatientID in case of inconsistent
115 PatientName attributes
116 other checks:
118 +Nrs --allow-retired-sop
120 allow retired SOP classes defined in previous editions
121 of the DICOM standard
122 -Nxc --no-xfer-check
124 do not reject images with non-standard transfer syntax
125 (just warn)
126 output options
127 writing:
128 -A --replace
130 replace existing DICOMDIR (default)
131 +A --append
133 append to existing DICOMDIR
134 +U --update
136 update existing DICOMDIR
137 -w --discard
139 do not write out DICOMDIR
140 -nb --no-backup
142 do not create a backup of existing DICOMDIR
143 post-1993 value representations:
145 +u --enable-new-vr
147 enable support for new VRs (UN/UT) (default)
148 -u --disable-new-vr
150 disable support for new VRs, convert to OB
151 group length encoding:
153 -g --group-length-remove
155 write without group length elements (default)
156 +g --group-length-create
158 write with group length elements
159 length encoding in sequences and items:
161 +e --length-explicit
163 write with explicit lengths (default)
164 -e --length-undefined
166 write with undefined lengths
168 All files specified on the command line (or discovered by recursivly
169 examining the contents of directories with the +r option) are first
170 evaluated for their compatibility with the General Purpose CD-R Image
171 Interchange Profile (Supplement 19). Only appropriate files encoded
172 using the Explicit VR Little Endian Uncompressed Transfer Syntax will
173 be accepted. Files having invalid filenames will be rejected (the rules
174 can be relaxed via the +m option). Files missing required attributes
175 will be rejected (the +I option can relax this behaviour).
176 A DICOMDIR file will only be constructed if all files have passed
177 initial tests.
178 The dcmgpdir utility also allows to append new entries to and to update
179 existing entries in a DICOMDIR file. Using option +A new entries are
180 only appended to the DICOMDIR, i.e. existing records like the ones for
181 PATIENT information are not updated. Using option +U also existing
182 records are updated according to the information found in the
183 referenced DICOM files. Please note that this update process might be
184 slower than just appending new entries. However, it makes sure that
185 additional information that is required for the selected application
186 profile is also added to existing records.
188 The level of logging output of the various command line tools and
189 underlying libraries can be specified by the user. By default, only
190 errors and warnings are written to the standard error stream. Using
191 option --verbose also informational messages like processing details
192 are reported. Option --debug can be used to get more details on the
193 internal activity, e.g. for debugging purposes. Other logging levels
194 can be selected using option --log-level. In --quiet mode only fatal
195 errors are reported. In such very severe error events, the application
196 will usually terminate. For more details on the different logging
197 levels, see documentation of module 'oflog'.
198 In case the logging output should be written to file (optionally with
199 logfile rotation), to syslog (Unix) or the event log (Windows) option
200 --log-config can be used. This configuration file also allows for
201 directing only certain messages to a particular output stream and for
202 filtering certain messages based on the module or application where
203 they are generated. An example configuration file is provided in
204 <etcdir>/logger.cfg).
206 All command line tools use the following notation for parameters:
207 square brackets enclose optional values (0-1), three trailing dots
208 indicate that multiple values are allowed (1-n), a combination of both
209 means 0 to n values.
210 Command line options are distinguished from parameters by a leading '+'
211 or '-' sign, respectively. Usually, order and position of command line
212 options are arbitrary (i.e. they can appear anywhere). However, if
213 options are mutually exclusive the rightmost appearance is used. This
214 behaviour conforms to the standard evaluation rules of common Unix
215 shells.
216 In addition, one or more command files can be specified using an '@'
217 sign as a prefix to the filename (e.g. @command.txt). Such a command
218 argument is replaced by the content of the corresponding text file
219 (multiple whitespaces are treated as a single separator unless they
220 appear between two quotation marks) prior to any further evaluation.
221 Please note that a command file cannot contain another command file.
222 This simple but effective approach allows to summarize common
223 combinations of options/parameters and avoids longish and confusing
224 command lines (an example is provided in file <datadir>/dumppat.txt).
226 The dcmgpdir utility will attempt to load DICOM data dictionaries
227 specified in the DCMDICTPATH environment variable. By default, i.e. if
228 the DCMDICTPATH environment variable is not set, the file
229 <datadir>/dicom.dic will be loaded unless the dictionary is built into
230 the application (default for Windows).
231 The default behaviour should be preferred and the DCMDICTPATH
232 environment variable only used when alternative data dictionaries are
233 required. The DCMDICTPATH environment variable has the same format as
234 the Unix shell PATH variable in that a colon (':') separates entries.
235 On Windows systems, a semicolon (';') is used as a separator. The data
236 dictionary code will attempt to load each file specified in the
237 DCMDICTPATH environment variable. It is an error if no data dictionary
238 can be loaded.
240 dcmmkdir(1)
242 Copyright (C) 1996-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
243 Germany.
244Version 3.6.0 6 Jan 2011 dcmgpdir(1)