1dcmcrle(1) OFFIS DCMTK dcmcrle(1)
2
6 dcmcrle - Encode DICOM file to RLE transfer syntax
7
10 dcmcrle [options] dcmfile-in dcmfile-out
11
13 The dcmcrle utility reads an uncompressed DICOM image (dcmfile-in),
14 performs RLE compression (i.e. conversion to an encapsulated DICOM
15 transfer syntax) and writes the converted image to an output file
16 (dcmfile-out).
17
19 dcmfile-in DICOM input filename to be converted
20 dcmfile-out DICOM output filename
22
24 general options
25 -h --help
26 print this help text and exit
27 --version
29 print version information and exit
30 --arguments
32 print expanded command line arguments
33 -q --quiet
35 quiet mode, print no warnings and errors
36 -v --verbose
38 verbose mode, print processing details
39 -d --debug
41 debug mode, print debug information
42 -ll --log-level [l]evel: string constant
44 (fatal, error, warn, info, debug, trace)
45 use level l for the logger
46 -lc --log-config [f]ilename: string
48 use config file f for the logger
49 input options
51 input file format:
52 +f --read-file
54 read file format or data set (default)
55 +fo --read-file-only
57 read file format only
58 -f --read-dataset
60 read data set without file meta information
61 input transfer syntax:
63 -t= --read-xfer-auto
65 use TS recognition (default)
66 -td --read-xfer-detect
68 ignore TS specified in the file meta header
69 -te --read-xfer-little
71 read with explicit VR little endian TS
72 -tb --read-xfer-big
74 read with explicit VR big endian TS
75 -ti --read-xfer-implicit
77 read with implicit VR little endian TS
78 encapsulated pixel data encoding options
80 pixel data fragmentation:
81 +ff --fragment-per-frame
83 encode each frame as one fragment (default)
84 +fs --fragment-size [s]ize: integer
86 limit fragment size to s kbytes (non-standard)
87 basic offset table encoding:
89 +ot --offset-table-create
91 create offset table (default)
92 -ot --offset-table-empty
94 leave offset table empty
95 SOP Class UID:
97 +cd --class-default
99 keep SOP Class UID (default)
100 +cs --class-sc
102 convert to Secondary Capture Image (implies --uid-always)
103 SOP Instance UID:
105 +un --uid-never
106 never assign new UID (default)
107 +ua --uid-always
109 always assign new UID
110 output options
112 post-1993 value representations:
113 +u --enable-new-vr
115 enable support for new VRs (UN/UT) (default)
116 -u --disable-new-vr
118 disable support for new VRs, convert to OB
119 group length encoding:
121 +g= --group-length-recalc
123 recalculate group lengths if present (default)
124 +g --group-length-create
126 always write with group length elements
127 -g --group-length-remove
129 always write without group length elements
130 length encoding in sequences and items:
132 +e --length-explicit
134 write with explicit lengths (default)
135 -e --length-undefined
137 write with undefined lengths
138 data set trailing padding:
140 -p= --padding-retain
142 do not change padding (default)
143 -p --padding-off
145 no padding
146 +p --padding-create [f]ile-pad [i]tem-pad: integer
148 align file on multiple of f bytes
149 and items on multiple of i bytes
150
152 The dcmcrle utility compresses DICOM images of all SOP classes. It
153 processes all Pixel Data (7fe0,0010) elements in the dataset, i.e.
154 compression is also performed on an icon image.
155 Please note that the DICOM standard does not allow for storing the
157 pixel data with multiple fragments per frame (when RLE compression is
158 used). So limiting the fragment size with option --fragment-size (or
159 +fs) may result in a non-standard compliant DICOM image.
160
162 dcmcrle supports the following transfer syntaxes for input (dcmfile-
163 in):
164 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
166 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1
167 DeflatedExplicitVRLittleEndianTransferSyntax 1.2.840.10008.1.2.1.99 (*)
168 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
169 (*) if compiled with zlib support enabled
171 dcmcrle supports the following transfer syntaxes for output (dcmfile-
173 out):
174 RLELosslessTransferSyntax 1.2.840.10008.1.2.5
176
178 The level of logging output of the various command line tools and
179 underlying libraries can be specified by the user. By default, only
180 errors and warnings are written to the standard error stream. Using
181 option --verbose also informational messages like processing details
182 are reported. Option --debug can be used to get more details on the
183 internal activity, e.g. for debugging purposes. Other logging levels
184 can be selected using option --log-level. In --quiet mode only fatal
185 errors are reported. In such very severe error events, the application
186 will usually terminate. For more details on the different logging
187 levels, see documentation of module 'oflog'.
188 In case the logging output should be written to file (optionally with
190 logfile rotation), to syslog (Unix) or the event log (Windows) option
191 --log-config can be used. This configuration file also allows for
192 directing only certain messages to a particular output stream and for
193 filtering certain messages based on the module or application where
194 they are generated. An example configuration file is provided in
195 <etcdir>/logger.cfg.
196
198 All command line tools use the following notation for parameters:
199 square brackets enclose optional values (0-1), three trailing dots
200 indicate that multiple values are allowed (1-n), a combination of both
201 means 0 to n values.
202 Command line options are distinguished from parameters by a leading '+'
204 or '-' sign, respectively. Usually, order and position of command line
205 options are arbitrary (i.e. they can appear anywhere). However, if
206 options are mutually exclusive the rightmost appearance is used. This
207 behavior conforms to the standard evaluation rules of common Unix
208 shells.
209 In addition, one or more command files can be specified using an '@'
211 sign as a prefix to the filename (e.g. @command.txt). Such a command
212 argument is replaced by the content of the corresponding text file
213 (multiple whitespaces are treated as a single separator unless they
214 appear between two quotation marks) prior to any further evaluation.
215 Please note that a command file cannot contain another command file.
216 This simple but effective approach allows one to summarize common
217 combinations of options/parameters and avoids longish and confusing
218 command lines (an example is provided in file <datadir>/dumppat.txt).
219
221 The dcmcrle utility will attempt to load DICOM data dictionaries
222 specified in the DCMDICTPATH environment variable. By default, i.e. if
223 the DCMDICTPATH environment variable is not set, the file
224 <datadir>/dicom.dic will be loaded unless the dictionary is built into
225 the application (default for Windows).
226 The default behavior should be preferred and the DCMDICTPATH
228 environment variable only used when alternative data dictionaries are
229 required. The DCMDICTPATH environment variable has the same format as
230 the Unix shell PATH variable in that a colon (':') separates entries.
231 On Windows systems, a semicolon (';') is used as a separator. The data
232 dictionary code will attempt to load each file specified in the
233 DCMDICTPATH environment variable. It is an error if no data dictionary
234 can be loaded.
235
237 dcmdrle(1)
238
240 Copyright (C) 2002-2022 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
241 Germany.
242Version 3.6.7 Fri Apr 22 2022 dcmcrle(1)