OFFIS DCMTK  Version 3.6.0
dcmcrle.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmcrle Encode DICOM file to RLE transfer syntax
5 \else
6 \page dcmcrle dcmcrle: Encode DICOM file to RLE transfer syntax
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmcrle [options] dcmfile-in dcmfile-out
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
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).
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 \verbatim
61 input file format:
62 
63  +f --read-file
64  read file format or data set (default)
65 
66  +fo --read-file-only
67  read file format only
68 
69  -f --read-dataset
70  read data set without file meta information
71 
72 input transfer syntax:
73 
74  -t= --read-xfer-auto
75  use TS recognition (default)
76 
77  -td --read-xfer-detect
78  ignore TS specified in the file meta header
79 
80  -te --read-xfer-little
81  read with explicit VR little endian TS
82 
83  -tb --read-xfer-big
84  read with explicit VR big endian TS
85 
86  -ti --read-xfer-implicit
87  read with implicit VR little endian TS
88 \endverbatim
89 
90 \subsection enc_pix_data_encoding_opt encapsulated pixel data encoding options
91 \verbatim
92 pixel data fragmentation:
93 
94  +ff --fragment-per-frame
95  encode each frame as one fragment (default)
96 
97  +fs --fragment-size [s]ize: integer
98  limit fragment size to s kbytes (non-standard)
99 
100 basic offset table encoding:
101 
102  +ot --offset-table-create
103  create offset table (default)
104 
105  -ot --offset-table-empty
106  leave offset table empty
107 
108 SOP Class UID:
109 
110  +cd --class-default
111  keep SOP Class UID (default)
112 
113  +cs --class-sc
114  convert to Secondary Capture Image (implies --uid-always)
115 
116 SOP Instance UID:
117  +un --uid-never
118  never assign new UID (default)
119 
120  +ua --uid-always
121  always assign new UID
122 \endverbatim
123 
124 \subsection output_options output options
125 \verbatim
126 post-1993 value representations:
127 
128  +u --enable-new-vr
129  enable support for new VRs (UN/UT) (default)
130 
131  -u --disable-new-vr
132  disable support for new VRs, convert to OB
133 
134 group length encoding:
135 
136  +g= --group-length-recalc
137  recalculate group lengths if present (default)
138 
139  +g --group-length-create
140  always write with group length elements
141 
142  -g --group-length-remove
143  always write without group length elements
144 
145 length encoding in sequences and items:
146 
147  +e --length-explicit
148  write with explicit lengths (default)
149 
150  -e --length-undefined
151  write with undefined lengths
152 
153 data set trailing padding:
154 
155  -p= --padding-retain
156  do not change padding (default)
157 
158  -p --padding-off
159  no padding
160 
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
164 \endverbatim
165 
166 \section transfer_syntaxes TRANSFER SYNTAXES
167 
168 \b dcmcrle supports the following transfer syntaxes for input
169 (\e dcmfile-in):
170 
171 \verbatim
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
176 \endverbatim
177 
178 (*) if compiled with zlib support enabled
179 
180 \b dcmcrle supports the following transfer syntaxes for output
181 (\e dcmfile-out):
182 
183 \verbatim
184 RLELosslessTransferSyntax 1.2.840.10008.1.2.5
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 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).
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>dcmdrle</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 Thu Aug 27 2015 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.9.1