4 \page dcmdjpls Decode JPEG-LS compressed DICOM file
6 \page dcmdjpls dcmdjpls: Decode JPEG-LS compressed DICOM file
9 \section synopsis SYNOPSIS
12 dcmdjpls [options] dcmfile-in dcmfile-out
15 \section description DESCRIPTION
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).
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 # 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.
78 \subsection processing_options processing options
83 restore original planar configuration (default)
85 # If the compressed image is a color image, restore the planar
86 # configuration as described in the Planar Configuration attribute.
89 automatically determine planar configuration
90 from SOP class and color space
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
100 always store color-by-pixel
102 # If the compressed image is a color image, store in color-by-pixel
103 # planar configuration.
106 always store color-by-plane
108 # If the compressed image is a color image, store in color-by-plane
109 # planar configuration.
114 keep same SOP Instance UID (default)
116 # Never assigns a new SOP instance UID.
119 always assign new UID
121 # Always assigns a new SOP instance UID.
123 other processing options:
125 +io --ignore-offsettable
126 ignore offset table when decompressing
129 \subsection output_options output options
134 write file format (default)
137 write data set without file meta information
139 output transfer syntax:
141 +te --write-xfer-little
142 write with explicit VR little endian (default)
145 write with explicit VR big endian TS
147 +ti --write-xfer-implicit
148 write with implicit VR little endian TS
150 post-1993 value representations:
153 enable support for new VRs (UN/UT) (default)
156 disable support for new VRs, convert to OB
158 group length encoding:
160 +g= --group-length-recalc
161 recalculate group lengths if present (default)
163 +g --group-length-create
164 always write with group length elements
166 -g --group-length-remove
167 always write without group length elements
169 length encoding in sequences and items:
172 write with explicit lengths (default)
174 -e --length-undefined
175 write with undefined lengths
177 data set trailing padding (not with --write-dataset):
180 do not change padding (default if not --write-dataset)
183 no padding (implicit if --write-dataset)
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
190 \section transfer_syntaxes TRANSFER SYNTAXES
192 \b dcmdjpls supports the following transfer syntaxes for input
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
204 (*) if compiled with zlib support enabled
206 \b dcmdjpls supports the following transfer syntaxes for output
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
215 \section logging LOGGING
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".
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>).
234 \section command_line COMMAND LINE
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.
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.
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>).
256 \section environment ENVIRONMENT
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).
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.
272 \section see_also SEE ALSO
276 \section copyright COPYRIGHT
278 Copyright (C) 2009-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.