4 \page dcmcrle Encode DICOM file to RLE transfer syntax
6 \page dcmcrle dcmcrle: Encode DICOM file to RLE transfer syntax
9 \section synopsis SYNOPSIS
12 dcmcrle [options] dcmfile-in dcmfile-out
15 \section description DESCRIPTION
17 The \b dcmcrle utility reads an uncompressed DICOM image (\e dcmfile-in),
18 performs RLE compression (i.e. conversion to an encapsulated DICOM transfer
19 syntax) and writes the converted image to an output file (\e dcmfile-out).
21 \section parameters PARAMETERS
24 dcmfile-in DICOM input filename to be converted
26 dcmfile-out DICOM output filename
29 \section options OPTIONS
31 \subsection general_options general options
34 print this help text and exit
37 print version information and exit
40 print expanded command line arguments
43 quiet mode, print no warnings and errors
46 verbose mode, print processing details
49 debug mode, print debug information
51 -ll --log-level [l]evel: string constant
52 (fatal, error, warn, info, debug, trace)
53 use level l for the logger
55 -lc --log-config [f]ilename: string
56 use config file f for the logger
59 \subsection input_options input options
64 read file format or data set (default)
70 read data set without file meta information
72 input transfer syntax:
75 use TS recognition (default)
77 -td --read-xfer-detect
78 ignore TS specified in the file meta header
80 -te --read-xfer-little
81 read with explicit VR little endian TS
84 read with explicit VR big endian TS
86 -ti --read-xfer-implicit
87 read with implicit VR little endian TS
90 \subsection enc_pix_data_encoding_opt encapsulated pixel data encoding options
92 pixel data fragmentation:
94 +ff --fragment-per-frame
95 encode each frame as one fragment (default)
97 +fs --fragment-size [s]ize: integer
98 limit fragment size to s kbytes (non-standard)
100 basic offset table encoding:
102 +ot --offset-table-create
103 create offset table (default)
105 -ot --offset-table-empty
106 leave offset table empty
111 keep SOP Class UID (default)
114 convert to Secondary Capture Image (implies --uid-always)
118 never assign new UID (default)
121 always assign new UID
124 \subsection output_options output options
126 post-1993 value representations:
129 enable support for new VRs (UN/UT) (default)
132 disable support for new VRs, convert to OB
134 group length encoding:
136 +g= --group-length-recalc
137 recalculate group lengths if present (default)
139 +g --group-length-create
140 always write with group length elements
142 -g --group-length-remove
143 always write without group length elements
145 length encoding in sequences and items:
148 write with explicit lengths (default)
150 -e --length-undefined
151 write with undefined lengths
153 data set trailing padding:
156 do not change padding (default)
161 +p --padding-create [f]ile-pad [i]tem-pad: integer
162 align file on multiple of f bytes
163 and items on multiple of i bytes
166 \section transfer_syntaxes TRANSFER SYNTAXES
168 \b dcmcrle supports the following transfer syntaxes for input
172 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
173 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1
174 DeflatedExplicitVRLittleEndianTransferSyntax 1.2.840.10008.1.2.1.99 (*)
175 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
178 (*) if compiled with zlib support enabled
180 \b dcmcrle supports the following transfer syntaxes for output
184 RLELosslessTransferSyntax 1.2.840.10008.1.2.5
187 \section logging LOGGING
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".
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>).
206 \section command_line COMMAND LINE
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.
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.
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>).
228 \section environment ENVIRONMENT
230 The \b dcmcrle 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).
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.
244 \section see_also SEE ALSO
248 \section copyright COPYRIGHT
250 Copyright (C) 2002-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.