OFFIS DCMTK  Version 3.6.0
dcmdjpls.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmdjpls Decode JPEG-LS compressed DICOM file
5 \else
6 \page dcmdjpls dcmdjpls: Decode JPEG-LS compressed DICOM file
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmdjpls [options] dcmfile-in dcmfile-out
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b dcmdjpls utility reads a JPEG-ls compressed DICOM image (\e dcmfile-in),
18 decompresses the JPEG-LS data (i. e. conversion to a native 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  # This option allows to decompress JPEG-LS compressed DICOM objects that have
73  # been stored as dataset without meta-header. Such a thing should not exist
74  # since the transfer syntax cannot be reliably determined without meta-header,
75  # but unfortunately it does.
76 \endverbatim
77 
78 \subsection processing_options processing options
79 \verbatim
80 planar configuration:
81 
82  +pr --planar-restore
83  restore original planar configuration (default)
84 
85  # If the compressed image is a color image, restore the planar
86  # configuration as described in the Planar Configuration attribute.
87 
88  +pa --planar-auto
89  automatically determine planar configuration
90  from SOP class and color space
91 
92  # If the compressed image is a color image, store in color-by-plane
93  # planar configuration if required by the SOP class and photometric
94  # interpretation. Hardcopy Color images are always stored color-by-
95  # plane, and the revised Ultrasound image objects are stored color-by-
96  # plane if the color model is YBR_FULL. Everything else is stored
97  # color-by-pixel.
98 
99  +px --color-by-pixel
100  always store color-by-pixel
101 
102  # If the compressed image is a color image, store in color-by-pixel
103  # planar configuration.
104 
105  +pl --color-by-plane
106  always store color-by-plane
107 
108  # If the compressed image is a color image, store in color-by-plane
109  # planar configuration.
110 
111 SOP Instance UID:
112 
113  +ud --uid-default
114  keep same SOP Instance UID (default)
115 
116  # Never assigns a new SOP instance UID.
117 
118  +ua --uid-always
119  always assign new UID
120 
121  # Always assigns a new SOP instance UID.
122 
123 other processing options:
124 
125  +io --ignore-offsettable
126  ignore offset table when decompressing
127 \endverbatim
128 
129 \subsection output_options output options
130 \verbatim
131 output file format:
132 
133  +F --write-file
134  write file format (default)
135 
136  -F --write-dataset
137  write data set without file meta information
138 
139 output transfer syntax:
140 
141  +te --write-xfer-little
142  write with explicit VR little endian (default)
143 
144  +tb --write-xfer-big
145  write with explicit VR big endian TS
146 
147  +ti --write-xfer-implicit
148  write with implicit VR little endian TS
149 
150 post-1993 value representations:
151 
152  +u --enable-new-vr
153  enable support for new VRs (UN/UT) (default)
154 
155  -u --disable-new-vr
156  disable support for new VRs, convert to OB
157 
158 group length encoding:
159 
160  +g= --group-length-recalc
161  recalculate group lengths if present (default)
162 
163  +g --group-length-create
164  always write with group length elements
165 
166  -g --group-length-remove
167  always write without group length elements
168 
169 length encoding in sequences and items:
170 
171  +e --length-explicit
172  write with explicit lengths (default)
173 
174  -e --length-undefined
175  write with undefined lengths
176 
177 data set trailing padding (not with --write-dataset):
178 
179  -p= --padding-retain
180  do not change padding (default if not --write-dataset)
181 
182  -p --padding-off
183  no padding (implicit if --write-dataset)
184 
185  +p --padding-create [f]ile-pad [i]tem-pad: integer
186  align file on multiple of f bytes
187  and items on multiple of i bytes
188 \endverbatim
189 
190 \section transfer_syntaxes TRANSFER SYNTAXES
191 
192 \b dcmdjpls supports the following transfer syntaxes for input
193 (\e dcmfile-in):
194 
195 \verbatim
196 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
197 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1
198 DeflatedExplicitVRLittleEndianTransferSyntax 1.2.840.10008.1.2.1.99 (*)
199 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
200 JPEGLSLosslessTransferSyntax 1.2.840.10008.1.2.4.80
201 JPEGLSLossyTransferSyntax 1.2.840.10008.1.2.4.81
202 \endverbatim
203 
204 (*) if compiled with zlib support enabled
205 
206 \b dcmdjpls supports the following transfer syntaxes for output
207 (\e dcmfile-out):
208 
209 \verbatim
210 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
211 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1
212 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
213 \endverbatim
214 
215 \section logging LOGGING
216 
217 The level of logging output of the various command line tools and underlying
218 libraries can be specified by the user. By default, only errors and warnings
219 are written to the standard error stream. Using option \e --verbose also
220 informational messages like processing details are reported. Option
221 \e --debug can be used to get more details on the internal activity, e.g. for
222 debugging purposes. Other logging levels can be selected using option
223 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
224 very severe error events, the application will usually terminate. For more
225 details on the different logging levels, see documentation of module "oflog".
226 
227 In case the logging output should be written to file (optionally with logfile
228 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
229 can be used. This configuration file also allows for directing only certain
230 messages to a particular output stream and for filtering certain messages
231 based on the module or application where they are generated. An example
232 configuration file is provided in <em><etcdir>/logger.cfg</em>).
233 
234 \section command_line COMMAND LINE
235 
236 All command line tools use the following notation for parameters: square
237 brackets enclose optional values (0-1), three trailing dots indicate that
238 multiple values are allowed (1-n), a combination of both means 0 to n values.
239 
240 Command line options are distinguished from parameters by a leading '+' or '-'
241 sign, respectively. Usually, order and position of command line options are
242 arbitrary (i.e. they can appear anywhere). However, if options are mutually
243 exclusive the rightmost appearance is used. This behaviour conforms to the
244 standard evaluation rules of common Unix shells.
245 
246 In addition, one or more command files can be specified using an '@' sign as a
247 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
248 is replaced by the content of the corresponding text file (multiple
249 whitespaces are treated as a single separator unless they appear between two
250 quotation marks) prior to any further evaluation. Please note that a command
251 file cannot contain another command file. This simple but effective approach
252 allows to summarize common combinations of options/parameters and avoids
253 longish and confusing command lines (an example is provided in file
254 <em><datadir>/dumppat.txt</em>).
255 
256 \section environment ENVIRONMENT
257 
258 The \b dcmdjpls utility will attempt to load DICOM data dictionaries specified
259 in the \e DCMDICTPATH environment variable. By default, i.e. if the
260 \e DCMDICTPATH environment variable is not set, the file
261 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
262 into the application (default for Windows).
263 
264 The default behaviour should be preferred and the \e DCMDICTPATH environment
265 variable only used when alternative data dictionaries are required. The
266 \e DCMDICTPATH environment variable has the same format as the Unix shell
267 \e PATH variable in that a colon (":") separates entries. On Windows systems,
268 a semicolon (";") is used as a separator. The data dictionary code will
269 attempt to load each file specified in the \e DCMDICTPATH environment variable.
270 It is an error if no data dictionary can be loaded.
271 
272 \section see_also SEE ALSO
273 
274 <b>dcmcjpls</b>(1)
275 
276 \section copyright COPYRIGHT
277 
278 Copyright (C) 2009-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
279 
280 */


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11