1dcmquant(1)                       OFFIS DCMTK                      dcmquant(1)
2
3
4

NAME

6       dcmquant - Convert DICOM color images to palette color
7
8

SYNOPSIS

10       dcmquant [options] dcmfile-in dcmfile-out
11

DESCRIPTION

13       The  dcmquant  utility  reads  a  DICOM color image, computes a palette
14       color look-up table of the desired size for this image  (based  on  the
15       median cut algorithm published by Paul Heckbert) and converts the color
16       image into a DICOM palette color image.
17

PARAMETERS

19       dcmfile-in   DICOM input filename to be converted
20
21       dcmfile-out  DICOM output filename to be written
22

OPTIONS

24   general options
25         -h   --help
26                print this help text and exit
27
28              --version
29                print version information and exit
30
31              --arguments
32                print expanded command line arguments
33
34         -q   --quiet
35                quiet mode, print no warnings and errors
36
37         -v   --verbose
38                verbose mode, print processing details
39
40         -d   --debug
41                debug mode, print debug information
42
43         -ll  --log-level  [l]evel: string constant
44                (fatal, error, warn, info, debug, trace)
45                use level l for the logger
46
47         -lc  --log-config  [f]ilename: string
48                use config file f for the logger
49
50   input options
51       input file format:
52
53         +f   --read-file
54                read file format or data set (default)
55
56         +fo  --read-file-only
57                read file format only
58
59         -f   --read-dataset
60                read data set without file meta information
61
62       input transfer syntax:
63
64         -t=  --read-xfer-auto
65                use TS recognition (default)
66
67         -td  --read-xfer-detect
68                ignore TS specified in the file meta header
69
70         -te  --read-xfer-little
71                read with explicit VR little endian TS
72
73         -tb  --read-xfer-big
74                read with explicit VR big endian TS
75
76         -ti  --read-xfer-implicit
77                read with implicit VR little endian TS
78
79   image processing and encoding options
80       frame selection:
81
82         +F   --frame  [n]umber: integer
83                select specified frame
84
85         +Fa  --all-frames
86                select all frames (default)
87
88       compatibility:
89
90         +Mp  --accept-palettes
91                accept incorrect palette attribute tags
92                (0028,111x) and (0028,121x)
93
94       median cut dimension selection:
95
96         +Dr  --mc-dimension-rgb
97                max dimension from RGB range (default)
98
99         +Dl  --mc-dimension-lum
100                max dimension from luminance
101
102       median cut representative color selection:
103
104         +Cb  --mc-color-avgbox
105                average colors in box (default)
106
107         +Cp  --mc-color-avgpixel
108                average pixels in box
109
110         +Cc  --mc-color-center
111                select center of box
112
113       color palette value representation:
114
115         +pw  --write-ow
116                write Palette LUT as OW (default)
117
118         +pu  --write-us
119                write Palette LUT as US (retired)
120
121       color palette creation:
122
123         +pe  --lut-entries-word
124                write Palette LUT with 16-bit entries
125
126         +pf  --floyd-steinberg
127                use Floyd-Steinberg error diffusion
128
129         +pc  --colors  number of colors: 2..65536 (default 256)
130                number of colors to quantize to
131
132       SOP Class UID:
133
134         +cd  --class-default
135                keep SOP Class UID (default)
136
137         +cs  --class-sc
138                convert to Secondary Capture Image
139                (implies --uid-always)
140
141       SOP Instance UID:
142
143         +ua  --uid-always
144                always assign new UID (default)
145
146         +un  --uid-never
147                never assign new UID
148
149   output options
150       output file format:
151
152         +F   --write-file
153                write file format (default)
154
155         -F   --write-dataset
156                write data set without file meta information
157
158       output transfer syntax:
159
160         +t=  --write-xfer-same
161                write with same TS as input (default)
162
163         +te  --write-xfer-little
164                write with explicit VR little endian TS
165
166         +tb  --write-xfer-big
167                write with explicit VR big endian TS
168
169         +ti  --write-xfer-implicit
170                write with implicit VR little endian TS
171
172       post-1993 value representations:
173
174         +u   --enable-new-vr
175                enable support for new VRs (UN/UT) (default)
176
177         -u   --disable-new-vr
178                disable support for new VRs, convert to OB
179
180       group length encoding:
181
182         +g=  --group-length-recalc
183                recalculate group lengths if present (default)
184
185         +g   --group-length-create
186                always write with group length elements
187
188         -g   --group-length-remove
189                always write without group length elements
190
191       length encoding in sequences and items:
192
193         +e   --length-explicit
194                write with explicit lengths (default)
195
196         -e   --length-undefined
197                write with undefined lengths
198
199       data set trailing padding (not with --write-dataset):
200
201         -p=  --padding-retain
202                do not change padding
203                (default if not --write-dataset)
204
205         -p   --padding-off
206                no padding (implicit if --write-dataset)
207
208         +p   --padding-create  [f]ile-pad [i]tem-pad: integer
209                align file on multiple of f bytes and items on
210                multiple of i bytes
211

LOGGING

213       The level of logging output of  the  various  command  line  tools  and
214       underlying  libraries  can  be  specified by the user. By default, only
215       errors and warnings are written to the  standard  error  stream.  Using
216       option  --verbose  also  informational messages like processing details
217       are reported. Option --debug can be used to get  more  details  on  the
218       internal  activity,  e.g.  for debugging purposes. Other logging levels
219       can be selected using option --log-level. In --quiet  mode  only  fatal
220       errors  are reported. In such very severe error events, the application
221       will usually terminate. For  more  details  on  the  different  logging
222       levels, see documentation of module 'oflog'.
223
224       In  case  the logging output should be written to file (optionally with
225       logfile rotation), to syslog (Unix) or the event log  (Windows)  option
226       --log-config  can  be  used.  This  configuration  file also allows for
227       directing only certain messages to a particular output stream  and  for
228       filtering  certain  messages  based  on the module or application where
229       they are generated.  An  example  configuration  file  is  provided  in
230       <etcdir>/logger.cfg.
231

COMMAND LINE

233       All  command  line  tools  use  the  following notation for parameters:
234       square brackets enclose optional  values  (0-1),  three  trailing  dots
235       indicate  that multiple values are allowed (1-n), a combination of both
236       means 0 to n values.
237
238       Command line options are distinguished from parameters by a leading '+'
239       or  '-' sign, respectively. Usually, order and position of command line
240       options are arbitrary (i.e. they  can  appear  anywhere).  However,  if
241       options  are  mutually exclusive the rightmost appearance is used. This
242       behavior conforms to the  standard  evaluation  rules  of  common  Unix
243       shells.
244
245       In  addition,  one  or more command files can be specified using an '@'
246       sign as a prefix to the filename (e.g. @command.txt).  Such  a  command
247       argument  is  replaced  by  the  content of the corresponding text file
248       (multiple whitespaces are treated as a  single  separator  unless  they
249       appear  between  two  quotation marks) prior to any further evaluation.
250       Please note that a command file cannot contain  another  command  file.
251       This  simple  but  effective  approach  allows  one to summarize common
252       combinations of options/parameters and  avoids  longish  and  confusing
253       command lines (an example is provided in file <datadir>/dumppat.txt).
254

ENVIRONMENT

256       The  dcmquant  utility  will  attempt  to  load DICOM data dictionaries
257       specified in the DCMDICTPATH environment variable. By default, i.e.  if
258       the   DCMDICTPATH   environment   variable   is   not   set,  the  file
259       <datadir>/dicom.dic will be loaded unless the dictionary is built  into
260       the application (default for Windows).
261
262       The   default   behavior   should  be  preferred  and  the  DCMDICTPATH
263       environment variable only used when alternative data  dictionaries  are
264       required.  The  DCMDICTPATH environment variable has the same format as
265       the Unix shell PATH variable in that a colon (':')  separates  entries.
266       On  Windows systems, a semicolon (';') is used as a separator. The data
267       dictionary code will  attempt  to  load  each  file  specified  in  the
268       DCMDICTPATH  environment variable. It is an error if no data dictionary
269       can be loaded.
270
272       Copyright (C) 2001-2017 by OFFIS e.V., Escherweg  2,  26121  Oldenburg,
273       Germany.
274
275
276
277Version 3.6.6                   Thu Jan 14 2021                    dcmquant(1)
Impressum