OFFIS DCMTK  Version 3.6.0
dcmdrle.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmdrle Decode RLE-compressed DICOM file
5 \else
6 \page dcmdrle dcmdrle: Decode RLE-compressed DICOM file
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmdrle [options] dcmfile-in dcmfile-out
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b dcmdrle utility reads a RLE-compressed DICOM image (\e dcmfile-in),
18 decompresses the image data (i.e. conversion to a native DICOM transfer syntax)
19 and writes the converted image to an output file (\e dcmfile-out).
20 
21 \section parameters PARAMETERS
22 
23 \verbatim
24 dcmfile-in DICOM input filename to be converted
25 
26 dcmfile-out DICOM output filename
27 \endverbatim
28 
29 \section options OPTIONS
30 
31 \subsection general_options general options
32 \verbatim
33  -h --help
34  print this help text and exit
35 
36  --version
37  print version information and exit
38 
39  --arguments
40  print expanded command line arguments
41 
42  -q --quiet
43  quiet mode, print no warnings and errors
44 
45  -v --verbose
46  verbose mode, print processing details
47 
48  -d --debug
49  debug mode, print debug information
50 
51  -ll --log-level [l]evel: string constant
52  (fatal, error, warn, info, debug, trace)
53  use level l for the logger
54 
55  -lc --log-config [f]ilename: string
56  use config file f for the logger
57 \endverbatim
58 
59 \subsection input_options input options
60 
61 \verbatim
62 input file format:
63 
64  +f --read-file
65  read file format or data set (default)
66 
67  +fo --read-file-only
68  read file format only
69 
70  -f --read-dataset
71  read data set without file meta information
72 
73  # This option allows to decompress RLE compressed DICOM objects that have
74  # been stored as dataset without meta-header. Such a thing should not exist
75  # since the transfer syntax cannot be reliably determined without meta-header,
76  # but unfortunately it does.
77 \endverbatim
78 
79 \subsection processing_options processing options
80 \verbatim
81 SOP Instance UID:
82 
83  +ud --uid-default
84  keep same SOP Instance UID (default)
85 
86  +ua --uid-always
87  always assign new UID
88 
89 RLE byte segment order:
90 
91  +bd --byte-order-default
92  most significant byte first (default)
93 
94  +br --byte-order-reverse
95  least significant byte first
96 
97  # This option allows to decompress RLE compressed DICOM files in which the
98  # order of byte segments is encoded in incorrect order. This only affects
99  # images with more than one byte per sample.
100 \endverbatim
101 
102 \subsection output_options output options
103 \verbatim
104 output file format:
105 
106  +F --write-file
107  write file format (default)
108 
109  -F --write-dataset
110  write data set without file meta information
111 
112 output transfer syntax:
113 
114  +te --write-xfer-little
115  write with explicit VR little endian (default)
116 
117  +tb --write-xfer-big
118  write with explicit VR big endian TS
119 
120  +ti --write-xfer-implicit
121  write with implicit VR little endian TS
122 
123 post-1993 value representations:
124 
125  +u --enable-new-vr
126  enable support for new VRs (UN/UT) (default)
127 
128  -u --disable-new-vr
129  disable support for new VRs, convert to OB
130 
131 group length encoding:
132 
133  +g= --group-length-recalc
134  recalculate group lengths if present (default)
135 
136  +g --group-length-create
137  always write with group length elements
138 
139  -g --group-length-remove
140  always write without group length elements
141 
142 length encoding in sequences and items:
143 
144  +e --length-explicit
145  write with explicit lengths (default)
146 
147  -e --length-undefined
148  write with undefined lengths
149 
150 data set trailing padding (not with --write-dataset):
151 
152  -p= --padding-retain
153  do not change padding (default if not --write-dataset)
154 
155  -p --padding-off
156  no padding (implicit if --write-dataset)
157 
158  +p --padding-create [f]ile-pad [i]tem-pad: integer
159  align file on multiple of f bytes
160  and items on multiple of i bytes
161 \endverbatim
162 
163 \section transfer_syntaxes TRANSFER SYNTAXES
164 
165 \b dcmdrle supports the following transfer syntaxes for input
166 (\e dcmfile-in):
167 
168 \verbatim
169 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
170 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1
171 DeflatedExplicitVRLittleEndianTransferSyntax 1.2.840.10008.1.2.1.99 (*)
172 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
173 RLELosslessTransferSyntax 1.2.840.10008.1.2.5
174 \endverbatim
175 
176 (*) if compiled with zlib support enabled
177 
178 \b dcmdrle supports the following transfer syntaxes for output
179 (\e dcmfile-out):
180 
181 \verbatim
182 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
183 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1
184 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
185 \endverbatim
186 
187 \section logging LOGGING
188 
189 The level of logging output of the various command line tools and underlying
190 libraries can be specified by the user. By default, only errors and warnings
191 are written to the standard error stream. Using option \e --verbose also
192 informational messages like processing details are reported. Option
193 \e --debug can be used to get more details on the internal activity, e.g. for
194 debugging purposes. Other logging levels can be selected using option
195 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
196 very severe error events, the application will usually terminate. For more
197 details on the different logging levels, see documentation of module "oflog".
198 
199 In case the logging output should be written to file (optionally with logfile
200 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
201 can be used. This configuration file also allows for directing only certain
202 messages to a particular output stream and for filtering certain messages
203 based on the module or application where they are generated. An example
204 configuration file is provided in <em><etcdir>/logger.cfg</em>).
205 
206 \section command_line COMMAND LINE
207 
208 All command line tools use the following notation for parameters: square
209 brackets enclose optional values (0-1), three trailing dots indicate that
210 multiple values are allowed (1-n), a combination of both means 0 to n values.
211 
212 Command line options are distinguished from parameters by a leading '+' or '-'
213 sign, respectively. Usually, order and position of command line options are
214 arbitrary (i.e. they can appear anywhere). However, if options are mutually
215 exclusive the rightmost appearance is used. This behaviour conforms to the
216 standard evaluation rules of common Unix shells.
217 
218 In addition, one or more command files can be specified using an '@' sign as a
219 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
220 is replaced by the content of the corresponding text file (multiple
221 whitespaces are treated as a single separator unless they appear between two
222 quotation marks) prior to any further evaluation. Please note that a command
223 file cannot contain another command file. This simple but effective approach
224 allows to summarize common combinations of options/parameters and avoids
225 longish and confusing command lines (an example is provided in file
226 <em><datadir>/dumppat.txt</em>).
227 
228 \section environment ENVIRONMENT
229 
230 The \b dcmdrle utility will attempt to load DICOM data dictionaries specified
231 in the \e DCMDICTPATH environment variable. By default, i.e. if the
232 \e DCMDICTPATH environment variable is not set, the file
233 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
234 into the application (default for Windows).
235 
236 The default behaviour should be preferred and the \e DCMDICTPATH environment
237 variable only used when alternative data dictionaries are required. The
238 \e DCMDICTPATH environment variable has the same format as the Unix shell
239 \e PATH variable in that a colon (":") separates entries. On Windows systems,
240 a semicolon (";") is used as a separator. The data dictionary code will
241 attempt to load each file specified in the \e DCMDICTPATH environment variable.
242 It is an error if no data dictionary can be loaded.
243 
244 \section see_also SEE ALSO
245 
246 <b>dcmcrle</b>(1)
247 
248 \section copyright COPYRIGHT
249 
250 Copyright (C) 2002-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany
251 
252 */


Generated on Sun Aug 23 2015 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.9.1