1dcmquant(1) OFFIS DCMTK dcmquant(1)
2
6 dcmquant - Convert DICOM color images to palette color
7
9 dcmquant [options] dcmfile-in dcmfile-out
10
12 The dcmquant utility reads a DICOM color image, computes a palette
13 color look-up table of the desired size for this image (based on the
14 median cut algorithm published by Paul Heckbert) and converts the color
15 image into a DICOM palette color image.
16
18 dcmfile-in DICOM input filename to be converted
19 dcmfile-out DICOM output filename to be written
21
23 general options
24 -h --help
25 print this help text and exit
26 --version
28 print version information and exit
29 --arguments
31 print expanded command line arguments
32 -q --quiet
34 quiet mode, print no warnings and errors
35 -v --verbose
37 verbose mode, print processing details
38 -d --debug
40 debug mode, print debug information
41 -ll --log-level [l]evel: string constant
43 (fatal, error, warn, info, debug, trace)
44 use level l for the logger
45 -lc --log-config [f]ilename: string
47 use config file f for the logger
48 input options
50 input file format:
51 +f --read-file
53 read file format or data set (default)
54 +fo --read-file-only
56 read file format only
57 -f --read-dataset
59 read data set without file meta information
60 input transfer syntax:
62 -t= --read-xfer-auto
64 use TS recognition (default)
65 -td --read-xfer-detect
67 ignore TS specified in the file meta header
68 -te --read-xfer-little
70 read with explicit VR little endian TS
71 -tb --read-xfer-big
73 read with explicit VR big endian TS
74 -ti --read-xfer-implicit
76 read with implicit VR little endian TS
77 processing options
79 frame selection:
80 +F --frame [n]umber: integer
82 select specified frame
83 +Fa --all-frames
85 select all frames (default)
86 compatibility:
88 +Mp --accept-palettes
90 accept incorrect palette attribute tags
91 (0028,111x) and (0028,121x)
92 median cut dimension selection:
94 +Dr --mc-dimension-rgb
96 max dimension from RGB range (default)
97 +Dl --mc-dimension-lum
99 max dimension from luminance
100 median cut representative color selection:
102 +Cb --mc-color-avgbox
104 average colors in box (default)
105 +Cp --mc-color-avgpixel
107 average pixels in box
108 +Cc --mc-color-center
110 select center of box
111 color palette creation:
113 +pw --write-ow
115 write Palette LUT as OW instead of US
116 +pe --lut-entries-word
118 write Palette LUT with 16-bit entries
119 +pf --floyd-steinberg
121 use Floyd-Steinberg error diffusion
122 +pc --colors number of colors: 2..65536 (default 256)
124 number of colors to quantize to
125 SOP Class UID:
127 +cd --class-default
129 keep SOP Class UID (default)
130 +cs --class-sc
132 convert to Secondary Capture Image
133 (implies --uid-always)
134 SOP Instance UID:
136 +ua --uid-always
138 always assign new UID (default)
139 +un --uid-never
141 never assign new UID
142 output options
144 output file format:
145 +F --write-file
147 write file format (default)
148 -F --write-dataset
150 write data set without file meta information
151 output transfer syntax:
153 +t= --write-xfer-same
155 write with same TS as input (default)
156 +te --write-xfer-little
158 write with explicit VR little endian TS
159 +tb --write-xfer-big
161 write with explicit VR big endian TS
162 +ti --write-xfer-implicit
164 write with implicit VR little endian TS
165 post-1993 value representations:
167 +u --enable-new-vr
169 enable support for new VRs (UN/UT) (default)
170 -u --disable-new-vr
172 disable support for new VRs, convert to OB
173 group length encoding:
175 +g= --group-length-recalc
177 recalculate group lengths if present (default)
178 +g --group-length-create
180 always write with group length elements
181 -g --group-length-remove
183 always write without group length elements
184 length encoding in sequences and items:
186 +e --length-explicit
188 write with explicit lengths (default)
189 -e --length-undefined
191 write with undefined lengths
192 data set trailing padding (not with --write-dataset):
194 -p= --padding-retain
196 do not change padding
197 (default if not --write-dataset)
198 -p --padding-off
200 no padding (implicit if --write-dataset)
201 +p --padding-create [f]ile-pad [i]tem-pad: integer
203 align file on multiple of f bytes and items on
204 multiple of i bytes
205
207 The level of logging output of the various command line tools and
208 underlying libraries can be specified by the user. By default, only
209 errors and warnings are written to the standard error stream. Using
210 option --verbose also informational messages like processing details
211 are reported. Option --debug can be used to get more details on the
212 internal activity, e.g. for debugging purposes. Other logging levels
213 can be selected using option --log-level. In --quiet mode only fatal
214 errors are reported. In such very severe error events, the application
215 will usually terminate. For more details on the different logging
216 levels, see documentation of module 'oflog'.
217 In case the logging output should be written to file (optionally with
219 logfile rotation), to syslog (Unix) or the event log (Windows) option
220 --log-config can be used. This configuration file also allows for
221 directing only certain messages to a particular output stream and for
222 filtering certain messages based on the module or application where
223 they are generated. An example configuration file is provided in
224 <etcdir>/logger.cfg).
225
227 All command line tools use the following notation for parameters:
228 square brackets enclose optional values (0-1), three trailing dots
229 indicate that multiple values are allowed (1-n), a combination of both
230 means 0 to n values.
231 Command line options are distinguished from parameters by a leading '+'
233 or '-' sign, respectively. Usually, order and position of command line
234 options are arbitrary (i.e. they can appear anywhere). However, if
235 options are mutually exclusive the rightmost appearance is used. This
236 behaviour conforms to the standard evaluation rules of common Unix
237 shells.
238 In addition, one or more command files can be specified using an '@'
240 sign as a prefix to the filename (e.g. @command.txt). Such a command
241 argument is replaced by the content of the corresponding text file
242 (multiple whitespaces are treated as a single separator unless they
243 appear between two quotation marks) prior to any further evaluation.
244 Please note that a command file cannot contain another command file.
245 This simple but effective approach allows to summarize common
246 combinations of options/parameters and avoids longish and confusing
247 command lines (an example is provided in file <datadir>/dumppat.txt).
248
250 The dcmquant utility will attempt to load DICOM data dictionaries
251 specified in the DCMDICTPATH environment variable. By default, i.e. if
252 the DCMDICTPATH environment variable is not set, the file
253 <datadir>/dicom.dic will be loaded unless the dictionary is built into
254 the application (default for Windows).
255 The default behaviour should be preferred and the DCMDICTPATH
257 environment variable only used when alternative data dictionaries are
258 required. The DCMDICTPATH environment variable has the same format as
259 the Unix shell PATH variable in that a colon (':') separates entries.
260 On Windows systems, a semicolon (';') is used as a separator. The data
261 dictionary code will attempt to load each file specified in the
262 DCMDICTPATH environment variable. It is an error if no data dictionary
263 can be loaded.
264
266 Copyright (C) 2001-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
267 Germany.
268Version 3.6.0 6 Jan 2011 dcmquant(1)