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


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11