OFFIS DCMTK  Version 3.6.0
dcmconv.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmconv Convert DICOM file encoding
5 \else
6 \page dcmconv dcmconv: Convert DICOM file encoding
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmconv [options] dcmfile-in dcmfile-out
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b dcmconv utility reads a DICOM file (\e dcmfile-in), performs an encoding
18 conversion and writes the converted data to an output file (\e dcmfile-out).
19 
20 \section parameters PARAMETERS
21 
22 \verbatim
23 dcmfile-in DICOM input filename to be converted
24 
25 dcmfile-out DICOM output filename to write to
26 \endverbatim
27 
28 \section options OPTIONS
29 
30 \subsection general_options general options
31 \verbatim
32  -h --help
33  print this help text and exit
34 
35  --version
36  print version information and exit
37 
38  --arguments
39  print expanded command line arguments
40 
41  -q --quiet
42  quiet mode, print no warnings and errors
43 
44  -v --verbose
45  verbose mode, print processing details
46 
47  -d --debug
48  debug mode, print debug information
49 
50  -l --log-level [l]evel: string constant
51  (fatal, error, warn, info, debug, trace)
52  use level l for the logger
53 
54  -l --log-config [f]ilename: string
55  use config file f for the logger
56 \endverbatim
57 
58 \subsection input_options input options
59 \verbatim
60 input file format:
61 
62  +f --read-file
63  read file format or data set (default)
64 
65  +fo --read-file-only
66  read file format only
67 
68  -f --read-dataset
69  read data set without file meta information
70 
71 input transfer syntax:
72 
73  -t= --read-xfer-auto
74  use TS recognition (default)
75 
76  -td --read-xfer-detect
77  ignore TS specified in the file meta header
78 
79  -te --read-xfer-little
80  read with explicit VR little endian TS
81 
82  -tb --read-xfer-big
83  read with explicit VR big endian TS
84 
85  -ti --read-xfer-implicit
86  read with implicit VR little endian TS
87 
88 parsing of file meta information:
89 
90  +ml --use-meta-length
91  use file meta information group length (default)
92 
93  -ml --ignore-meta-length
94  ignore file meta information group length
95 
96 parsing of odd-length attributes:
97 
98  +ao --accept-odd-length
99  accept odd length attributes (default)
100 
101  +ae --assume-even-length
102  assume real length is one byte larger
103 
104 handling of non-standard VR:
105 
106  +vr --treat-as-unknown
107  treat non-standard VR as unknown (default)
108 
109  -vr --assume-implicit
110  try to read with implicit VR little endian TS
111 
112 handling of undefined length UN elements:
113 
114  +ui --enable-cp246
115  read undefined len UN as implicit VR (default)
116 
117  -ui --disable-cp246
118  read undefined len UN as explicit VR
119 
120 handling of defined length UN elements:
121 
122  -uc --retain-un
123  retain elements as UN (default)
124 
125  +uc --convert-un
126  convert to real VR if known
127 
128 handling of private max-length elements (implicit VR):
129 
130  -sq --maxlength-dict
131  read as defined in dictionary (default)
132 
133  +sq --maxlength-seq
134  read as sequence with undefined length
135 
136 general handling of parser errors:
137 
138  +Ep --ignore-parse-errors
139  try to recover from parse errors
140 
141  -Ep --handle-parse-errors
142  handle parse errors and stop parsing (default)
143 
144 other parsing options:
145 
146  +st --stop-after-elem [t]ag: "gggg,eeee" or dictionary name
147  stop parsing after element specified by t
148 
149 automatic data correction:
150 
151  +dc --enable-correction
152  enable automatic data correction (default)
153 
154  -dc --disable-correction
155  disable automatic data correction
156 
157 bitstream format of deflated input:
158 
159  +bd --bitstream-deflated
160  expect deflated bitstream (default)
161 
162  +bz --bitstream-zlib
163  expect deflated zlib bitstream
164 \endverbatim
165 
166 \subsection output_options output options
167 \verbatim
168 output file format:
169 
170  +F --write-file
171  write file format (default)
172 
173  +Fm --write-new-meta-info
174  write file format with new meta information
175 
176  -F --write-dataset
177  write data set without file meta information
178 
179 output transfer syntax:
180 
181  +t= --write-xfer-same
182  write with same TS as input (default)
183 
184  +te --write-xfer-little
185  write with explicit VR little endian TS
186 
187  +tb --write-xfer-big
188  write with explicit VR big endian TS
189 
190  +ti --write-xfer-implicit
191  write with implicit VR little endian TS
192 
193  +td --write-xfer-deflated
194  write with deflated explicit VR little endian TS
195 
196 post-1993 value representations:
197 
198  +u --enable-new-vr
199  enable support for new VRs (UN/UT) (default)
200 
201  -u --disable-new-vr
202  disable support for new VRs, convert to OB
203 
204 group length encoding:
205 
206  +g= --group-length-recalc
207  recalculate group lengths if present (default)
208 
209  +g --group-length-create
210  always write with group length elements
211 
212  -g --group-length-remove
213  always write without group length elements
214 
215 length encoding in sequences and items:
216 
217  +e --length-explicit
218  write with explicit lengths (default)
219 
220  -e --length-undefined
221  write with undefined lengths
222 
223  +eo --write-oversized
224  write oversized explicit length sequences
225  and items with undefined length (default)
226 
227  -eo --abort-oversized
228  abort on oversized explicit sequences/items
229 
230 data set trailing padding (not with --write-dataset):
231 
232  -p= --padding-retain
233  do not change padding (default if not --write-dataset)
234 
235  -p --padding-off
236  no padding (implicit if --write-dataset)
237 
238  +p --padding-create [f]ile-pad [i]tem-pad: integer
239  align file on multiple of f bytes
240  and items on multiple of i bytes
241 
242 deflate compression level (only with --write-xfer-deflated):
243 
244  +cl --compression-level [l]evel: integer (default: 6)
245  0=uncompressed, 1=fastest, 9=best compression
246 
247 other output options:
248 
249  -ig --no-invalid-groups
250  don't write elements with invalid group number
251 \endverbatim
252 
253 \section logging LOGGING
254 
255 The level of logging output of the various command line tools and underlying
256 libraries can be specified by the user. By default, only errors and warnings
257 are written to the standard error stream. Using option \e --verbose also
258 informational messages like processing details are reported. Option
259 \e --debug can be used to get more details on the internal activity, e.g. for
260 debugging purposes. Other logging levels can be selected using option
261 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
262 very severe error events, the application will usually terminate. For more
263 details on the different logging levels, see documentation of module "oflog".
264 
265 In case the logging output should be written to file (optionally with logfile
266 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
267 can be used. This configuration file also allows for directing only certain
268 messages to a particular output stream and for filtering certain messages
269 based on the module or application where they are generated. An example
270 configuration file is provided in <em><etcdir>/logger.cfg</em>).
271 
272 \section command_line COMMAND LINE
273 
274 All command line tools use the following notation for parameters: square
275 brackets enclose optional values (0-1), three trailing dots indicate that
276 multiple values are allowed (1-n), a combination of both means 0 to n values.
277 
278 Command line options are distinguished from parameters by a leading '+' or '-'
279 sign, respectively. Usually, order and position of command line options are
280 arbitrary (i.e. they can appear anywhere). However, if options are mutually
281 exclusive the rightmost appearance is used. This behaviour conforms to the
282 standard evaluation rules of common Unix shells.
283 
284 In addition, one or more command files can be specified using an '@' sign as a
285 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
286 is replaced by the content of the corresponding text file (multiple
287 whitespaces are treated as a single separator unless they appear between two
288 quotation marks) prior to any further evaluation. Please note that a command
289 file cannot contain another command file. This simple but effective approach
290 allows to summarize common combinations of options/parameters and avoids
291 longish and confusing command lines (an example is provided in file
292 <em><datadir>/dumppat.txt</em>).
293 
294 \section environment ENVIRONMENT
295 
296 The \b dcmconv utility will attempt to load DICOM data dictionaries specified
297 in the \e DCMDICTPATH environment variable. By default, i.e. if the
298 \e DCMDICTPATH environment variable is not set, the file
299 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
300 into the application (default for Windows).
301 
302 The default behaviour should be preferred and the \e DCMDICTPATH environment
303 variable only used when alternative data dictionaries are required. The
304 \e DCMDICTPATH environment variable has the same format as the Unix shell
305 \e PATH variable in that a colon (":") separates entries. On Windows systems,
306 a semicolon (";") is used as a separator. The data dictionary code will
307 attempt to load each file specified in the \e DCMDICTPATH environment variable.
308 It is an error if no data dictionary can be loaded.
309 
310 \section see_also SEE ALSO
311 
312 <b>dcmdump</b>(1)
313 
314 \section copyright COPYRIGHT
315 
316 Copyright (C) 1994-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
317 
318 */


Generated on Wed Dec 28 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.8