1dcmmklut(1) OFFIS DCMTK dcmmklut(1)
2
6 dcmmklut - Create DICOM look-up tables
7
9 dcmmklut [options] dcmimg-out
10
12 The dcmmklut utility allows to create a variety of DICOM Modality,
13 Presentation and VOI look-up tables (LUT) and is intended for the
14 creation of test images. The utility is able to read an existing DICOM
15 image file, create a look up table according to the command line
16 options, and write the new object back to file. It is also possible to
17 create a new object containing the specified LUT without reading an
18 existing DICOM image file. This is e.g. useful to simply store
19 different look-up tables in a DICOM-like structure. As a default the
20 output file is encoded with the same transfer syntax used for the input
21 file, but the transfer syntax can also be specified as a command line
22 option.
23 The LUT data can be derived from the shape of a gamma curve (default
25 for the gamma factor is 1) or imported from a file (currently the MAP
26 format from Ulead's PhotoImpact and a simple text format are
27 supported). The input and output width of the LUT can also be specified
28 in the range allowed by the DICOM standard. The interpolation of the
29 input range is done by a polynomial curve fitting algorithm.
30 In addition to the DICOM output file the LUT data can also be exported
32 to a tabbed text file which allows the easy visualization of the curves
33 with a common spread sheet application (e.g. Microsoft Excel).
34
36 dcmimg-out DICOM output filename
37
39 general options
40 -h --help
41 print this help text and exit
42 --version
44 print version information and exit
45 --arguments
47 print expanded command line arguments
48 -q --quiet
50 quiet mode, print no warnings and errors
51 -v --verbose
53 verbose mode, print processing details
54 -d --debug
56 debug mode, print debug information
57 -ll --log-level [l]evel: string constant
59 (fatal, error, warn, info, debug, trace)
60 use level l for the logger
61 -lc --log-config [f]ilename: string
63 use config file f for the logger
64 LUT creation options
66 LUT type:
67 +Tm --modality
69 create as Modality LUT
70 +Tp --presentation
72 create as Presentation LUT
73 +Tv --voi
75 create as VOI LUT (default)
76 LUT placement:
78 +Pa --add
80 add to existing transform
81 (default for and only with --voi)
82 +Pr --replace
84 replace existing transform
85 (default for --modality and --presentation)
86 LUT content:
88 +Cg --gamma [g]amma: float
90 use gamma value (default: 1.0)
91 +Cm --map-file [f]ilename: string
93 read input data from MAP file
94 +Ct --text-file [f]ilename: string
96 read input data from text file
97 LUT options:
99 +Og --inverse-gsdf
101 apply inverse GSDF (print presentation LUT in OD)
102 --min-density [v]alue: integer (0..65535, default: 20)
104 set min density to v (in hundreds of OD)
105 --max-density [v]alue: integer (0..65535, default: 300)
107 set max density to v (in hundreds of OD)
108 +Oi --illumination [v]alue: integer (0..65535, default: 2000)
110 set illumination to v (in cd/m^2)
111 +Or --reflection [v]alue: integer (0..65535, default: 10)
113 set reflected ambient light to v (in cd/m^2)
114 LUT structure:
116 -b --bits [n]umber: integer
118 create LUT with n bit values (8..16, default: 16)
119 -e --entries [n]umber: integer
121 create LUT with n entries (1..65536, default: 256)
122 -f --first-mapped [n]umber: integer
124 first input value mapped (-31768..65535, default: 0)
125 -r --random [n]umber: unsigned integer
127 perform n randomly selected permutations on the LUT
128 -rs --random-seed [n]umber: unsigned integer
130 initialize the random-number generator with n
131 (default: 0, for reproducible results)
132 -o --order [n]umber: integer
134 use polynomial curve fitting algorithm with order n
135 (0..99, default: 5)
136 -E --explanation [n]ame: string
138 LUT explanation (default: automatically created)
139 LUT data alignment:
141 -a --byte-align
143 create byte-aligned LUT
144 (default for and only with 8 bit values)
145 +a --word-align
147 create word-aligned LUT
148 (default for 9-16 bit values)
149 LUT data VR:
151 +Dw --data-ow
153 write LUT Data as OW (default)
154 +Du --data-us
156 write LUT Data as US
157 +Ds --data-ss
159 write LUT Data as SS (minimal support)
160 file options
162 +Fi --dicom-input [f]ilename: string
163 read dataset from DICOM file f
164 +Fo --text-output [f]ilename: string
166 write LUT data to tabbed text file f
167
169 Please check the DICOM standard for further restrictions on the look-up
170 table structure. Especially the number of bits per table entry might be
171 restricted in particular IODs.
172
174 The level of logging output of the various command line tools and
175 underlying libraries can be specified by the user. By default, only
176 errors and warnings are written to the standard error stream. Using
177 option --verbose also informational messages like processing details
178 are reported. Option --debug can be used to get more details on the
179 internal activity, e.g. for debugging purposes. Other logging levels
180 can be selected using option --log-level. In --quiet mode only fatal
181 errors are reported. In such very severe error events, the application
182 will usually terminate. For more details on the different logging
183 levels, see documentation of module 'oflog'.
184 In case the logging output should be written to file (optionally with
186 logfile rotation), to syslog (Unix) or the event log (Windows) option
187 --log-config can be used. This configuration file also allows for
188 directing only certain messages to a particular output stream and for
189 filtering certain messages based on the module or application where
190 they are generated. An example configuration file is provided in
191 <etcdir>/logger.cfg).
192
194 All command line tools use the following notation for parameters:
195 square brackets enclose optional values (0-1), three trailing dots
196 indicate that multiple values are allowed (1-n), a combination of both
197 means 0 to n values.
198 Command line options are distinguished from parameters by a leading '+'
200 or '-' sign, respectively. Usually, order and position of command line
201 options are arbitrary (i.e. they can appear anywhere). However, if
202 options are mutually exclusive the rightmost appearance is used. This
203 behaviour conforms to the standard evaluation rules of common Unix
204 shells.
205 In addition, one or more command files can be specified using an '@'
207 sign as a prefix to the filename (e.g. @command.txt). Such a command
208 argument is replaced by the content of the corresponding text file
209 (multiple whitespaces are treated as a single separator unless they
210 appear between two quotation marks) prior to any further evaluation.
211 Please note that a command file cannot contain another command file.
212 This simple but effective approach allows to summarize common
213 combinations of options/parameters and avoids longish and confusing
214 command lines (an example is provided in file <datadir>/dumppat.txt).
215
217 The dcmmklut utility will attempt to load DICOM data dictionaries
218 specified in the DCMDICTPATH environment variable. By default, i.e. if
219 the DCMDICTPATH environment variable is not set, the file
220 <datadir>/dicom.dic will be loaded unless the dictionary is built into
221 the application (default for Windows).
222 The default behaviour should be preferred and the DCMDICTPATH
224 environment variable only used when alternative data dictionaries are
225 required. The DCMDICTPATH environment variable has the same format as
226 the Unix shell PATH variable in that a colon (':') separates entries.
227 On Windows systems, a semicolon (';') is used as a separator. The data
228 dictionary code will attempt to load each file specified in the
229 DCMDICTPATH environment variable. It is an error if no data dictionary
230 can be loaded.
231
233 <datadir>/philips.lut - sample LUT in text format
234
236 Copyright (C) 1998-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
237 Germany.
238Version 3.6.0 6 Jan 2011 dcmmklut(1)