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

NAME

6       dcmmklut - Create DICOM look-up tables
7
8

SYNOPSIS

10       dcmmklut [options] dcmimg-out
11

DESCRIPTION

13       The  dcmmklut utility allows one to create a variety of DICOM Modality,
14       Presentation and VOI look-up tables  (LUT)  and  is  intended  for  the
15       creation  of test images. The utility is able to read an existing DICOM
16       image file, create a look  up  table  according  to  the  command  line
17       options,  and write the new object back to file. It is also possible to
18       create a new object containing the specified  LUT  without  reading  an
19       existing  DICOM  image  file.  This  is  e.g.  useful  to  simply store
20       different look-up tables in a DICOM-like structure. As  a  default  the
21       output file is encoded with the same transfer syntax used for the input
22       file, but the transfer syntax can also be specified as a  command  line
23       option.
24
25       The  LUT  data  can be derived from the shape of a gamma curve (default
26       for the gamma factor is 1) or imported from a file (currently  the  MAP
27       format   from   Ulead's  PhotoImpact  and  a  simple  text  format  are
28       supported). The input and output width of the LUT can also be specified
29       in  the  range  allowed by the DICOM standard. The interpolation of the
30       input range is done by a polynomial curve fitting algorithm.
31
32       In addition to the DICOM output file the LUT data can also be  exported
33       to a tabbed text file which allows the easy visualization of the curves
34       with a common spread sheet application (e.g. Microsoft Excel).
35

PARAMETERS

37       dcmimg-out  DICOM output filename
38

OPTIONS

40   general options
41         -h   --help
42                print this help text and exit
43
44              --version
45                print version information and exit
46
47              --arguments
48                print expanded command line arguments
49
50         -q   --quiet
51                quiet mode, print no warnings and errors
52
53         -v   --verbose
54                verbose mode, print processing details
55
56         -d   --debug
57                debug mode, print debug information
58
59         -ll  --log-level  [l]evel: string constant
60                (fatal, error, warn, info, debug, trace)
61                use level l for the logger
62
63         -lc  --log-config  [f]ilename: string
64                use config file f for the logger
65
66   LUT creation options
67       LUT type:
68
69         +Tm  --modality
70                create as Modality LUT
71
72         +Tp  --presentation
73                create as Presentation LUT
74
75         +Tv  --voi
76                create as VOI LUT (default)
77
78       LUT placement:
79
80         +Pa  --add
81                add to existing transform
82                (default for and only with --voi)
83
84         +Pr  --replace
85                replace existing transform
86                (default for --modality and --presentation)
87
88       LUT content:
89
90         +Cg  --gamma  [g]amma: float
91                use gamma value (default: 1.0)
92
93         +Cm  --map-file  [f]ilename: string
94                read input data from MAP file
95
96         +Ct  --text-file  [f]ilename: string
97                read input data from text file
98
99       LUT options:
100
101         +Og  --inverse-gsdf
102                apply inverse GSDF (print presentation LUT in OD)
103
104              --min-density  [v]alue: integer (0..65535, default: 20)
105                set min density to v (in hundreds of OD)
106
107              --max-density  [v]alue: integer (0..65535, default: 300)
108                set max density to v (in hundreds of OD)
109
110         +Oi  --illumination  [v]alue: integer (0..65535, default: 2000)
111                set illumination to v (in cd/m^2)
112
113         +Or  --reflection  [v]alue: integer (0..65535, default: 10)
114                set reflected ambient light to v (in cd/m^2)
115
116       LUT structure:
117
118         -b   --bits  [n]umber: integer
119                create LUT with n bit values (8..16, default: 16)
120
121         -e   --entries  [n]umber: integer
122                create LUT with n entries (1..65536, default: 256)
123
124         -f   --first-mapped  [n]umber: integer
125                first input value mapped (-31768..65535, default: 0)
126
127         -r   --random  [n]umber: unsigned integer
128                perform n randomly selected permutations on the LUT
129
130         -rs  --random-seed  [n]umber: unsigned integer
131                initialize the random-number generator with n
132                (default: 0, for reproducible results)
133
134         -o   --order  [n]umber: integer
135                use polynomial curve fitting algorithm with order n
136                (0..99, default: 5)
137
138         -E   --explanation  [n]ame: string
139                LUT explanation (default: automatically created)
140
141       LUT data alignment:
142
143         -a   --byte-align
144                create byte-aligned LUT
145                (default for and only with 8 bit values)
146
147         +a   --word-align
148                create word-aligned LUT
149                (default for 9-16 bit values)
150
151       LUT data VR:
152
153         +Dw  --data-ow
154                write LUT Data as OW (default)
155
156         +Du  --data-us
157                write LUT Data as US
158
159         +Ds  --data-ss
160                write LUT Data as SS (minimal support)
161
162   file options
163         +Fi  --dicom-input  [f]ilename: string
164                read dataset from DICOM file f
165
166         +Fo  --text-output  [f]ilename: string
167                write LUT data to tabbed text file f
168

NOTES

170       Please check the DICOM standard for further restrictions on the look-up
171       table structure. Especially the number of bits per table entry might be
172       restricted in particular IODs.
173

LOGGING

175       The level of logging output of  the  various  command  line  tools  and
176       underlying  libraries  can  be  specified by the user. By default, only
177       errors and warnings are written to the  standard  error  stream.  Using
178       option  --verbose  also  informational messages like processing details
179       are reported. Option --debug can be used to get  more  details  on  the
180       internal  activity,  e.g.  for debugging purposes. Other logging levels
181       can be selected using option --log-level. In --quiet  mode  only  fatal
182       errors  are reported. In such very severe error events, the application
183       will usually terminate. For  more  details  on  the  different  logging
184       levels, see documentation of module 'oflog'.
185
186       In  case  the logging output should be written to file (optionally with
187       logfile rotation), to syslog (Unix) or the event log  (Windows)  option
188       --log-config  can  be  used.  This  configuration  file also allows for
189       directing only certain messages to a particular output stream  and  for
190       filtering  certain  messages  based  on the module or application where
191       they are generated.  An  example  configuration  file  is  provided  in
192       <etcdir>/logger.cfg.
193

COMMAND LINE

195       All  command  line  tools  use  the  following notation for parameters:
196       square brackets enclose optional  values  (0-1),  three  trailing  dots
197       indicate  that multiple values are allowed (1-n), a combination of both
198       means 0 to n values.
199
200       Command line options are distinguished from parameters by a leading '+'
201       or  '-' sign, respectively. Usually, order and position of command line
202       options are arbitrary (i.e. they  can  appear  anywhere).  However,  if
203       options  are  mutually exclusive the rightmost appearance is used. This
204       behavior conforms to the  standard  evaluation  rules  of  common  Unix
205       shells.
206
207       In  addition,  one  or more command files can be specified using an '@'
208       sign as a prefix to the filename (e.g. @command.txt).  Such  a  command
209       argument  is  replaced  by  the  content of the corresponding text file
210       (multiple whitespaces are treated as a  single  separator  unless  they
211       appear  between  two  quotation marks) prior to any further evaluation.
212       Please note that a command file cannot contain  another  command  file.
213       This  simple  but  effective  approach  allows  one to summarize common
214       combinations of options/parameters and  avoids  longish  and  confusing
215       command lines (an example is provided in file <datadir>/dumppat.txt).
216

ENVIRONMENT

218       The  dcmmklut  utility  will  attempt  to  load DICOM data dictionaries
219       specified in the DCMDICTPATH environment variable. By default, i.e.  if
220       the   DCMDICTPATH   environment   variable   is   not   set,  the  file
221       <datadir>/dicom.dic will be loaded unless the dictionary is built  into
222       the application (default for Windows).
223
224       The   default   behavior   should  be  preferred  and  the  DCMDICTPATH
225       environment variable only used when alternative data  dictionaries  are
226       required.  The  DCMDICTPATH environment variable has the same format as
227       the Unix shell PATH variable in that a colon (':')  separates  entries.
228       On  Windows systems, a semicolon (';') is used as a separator. The data
229       dictionary code will  attempt  to  load  each  file  specified  in  the
230       DCMDICTPATH  environment variable. It is an error if no data dictionary
231       can be loaded.
232

FILES

234       <datadir>/philips.lut - sample LUT in text format
235
237       Copyright (C) 1998-2022 by OFFIS e.V., Escherweg  2,  26121  Oldenburg,
238       Germany.
239
240
241
242Version 3.6.7                   Fri Apr 22 2022                    dcmmklut(1)
Impressum