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

NAME

6       dcmpsmk - Create DICOM grayscale softcopy presentation state
7

SYNOPSIS

9       dcmpsmk [options] dcmfile-in dcmfile-out
10

DESCRIPTION

12       The  dcmpsmk  utility  reads a DICOM image file and creates a grayscale
13       softcopy presentation state object  according  to  Supplement  33.  The
14       presentation  state object is written back to file. A number of command
15       line options allow to specify how  certain  constructs  that  might  be
16       present  in  the  image  file  should be referenced or activated in the
17       presentation state. The newly created presentation state references the
18       source  image  and contains values that should allow for a 'reasonable'
19       display of the image when rendered under control  of  the  presentation
20       state.
21

PARAMETERS

23       dcmfile-in   DICOM image file to be read
24
25       dcmfile-out  DICOM presentation state file to be created
26

OPTIONS

28   general options
29         -h   --help
30                print this help text and exit
31
32              --version
33                print version information and exit
34
35              --arguments
36                print expanded command line arguments
37
38         -q   --quiet
39                quiet mode, print no warnings and errors
40
41         -v   --verbose
42                verbose mode, print processing details
43
44         -d   --debug
45                debug mode, print debug information
46
47         -ll  --log-level  [l]evel: string constant
48                (fatal, error, warn, info, debug, trace)
49                use level l for the logger
50
51         -lc  --log-config  [f]ilename: string
52                use config file f for the logger
53
54   input options
55       input file format:
56
57         +f   --read-file
58                read file format or data set (default)
59
60         +fo  --read-file-only
61                read file format only
62
63         -f   --read-dataset
64                read data set without file meta information
65
66       input transfer syntax:
67
68         -t=  --read-xfer-auto
69                use TS recognition (default)
70
71         -td  --read-xfer-detect
72                ignore TS specified in the file meta header
73
74         -te  --read-xfer-little
75                read with explicit VR little endian TS
76
77         -tb  --read-xfer-big
78                read with explicit VR big endian TS
79
80         -ti  --read-xfer-implicit
81                read with implicit VR little endian TS
82
83   processing options
84       VOI transform handling:
85
86         +Vl  --voi-lut
87                use first VOI LUT if present (default)
88
89         +Vw  --voi-window
90                use first window center/width if present
91
92         -V   --voi-ignore
93                ignore VOI LUT and window center/width
94
95       curve handling:
96
97         +c   --curve-activate
98                activate curve data if present (default)
99
100         -c   --curve-ignore
101                ignore curve data
102
103       overlay handling:
104
105         +oc  --overlay-copy
106                copy overlays if not embedded, activate otherwise (default)
107
108         +oa  --overlay-activate
109                activate overlays
110
111         -o   --overlay-ignore
112                ignore overlays
113
114       shutter handling:
115
116         +s   --shutter-activate
117                use shutter if present in image (default)
118
119         -s   --shutter-ignore
120                ignore shutter
121
122       presentation LUT shape handling:
123
124         +p   --plut-activate
125                use presentation LUT shape if present (default)
126
127         -p   --plut-ignore
128                ignore presentation LUT shape
129
130       layering:
131
132         +l1  --layer-single
133                all curves and overlays are in one layer
134
135         +l2  --layer-double
136                one layer for curves, one for overlays (default)
137
138         +ls  --layer-separate
139                separate layers for each curve and overlay
140
141       location of referenced image:
142
143         -lx  --location-none
144                image reference without location (default)
145
146         -ln  --location-network  [a]etitle: string
147                image located at application entity a
148
149         -lm  --location-media  [f]ilesetID, fileset[UID]: string
150                image located on storage medium
151
152   output options
153       output transfer syntax:
154
155         +t=   --write-xfer-same
156                 write with same TS as image file (default)
157
158         +te   --write-xfer-little
159                 write with explicit VR little endian TS
160
161         +tb   --write-xfer-big
162                 write with explicit VR big endian TS
163
164         +ti   --write-xfer-implicit
165                 write with implicit VR little endian TS
166

LOGGING

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

COMMAND LINE

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

ENVIRONMENT

211       The dcmpsmk utility  will  attempt  to  load  DICOM  data  dictionaries
212       specified  in the DCMDICTPATH environment variable. By default, i.e. if
213       the  DCMDICTPATH  environment   variable   is   not   set,   the   file
214       <datadir>/dicom.dic  will be loaded unless the dictionary is built into
215       the application (default for Windows).
216
217       The  default  behaviour  should  be  preferred  and   the   DCMDICTPATH
218       environment  variable  only used when alternative data dictionaries are
219       required. The DCMDICTPATH environment variable has the same  format  as
220       the  Unix  shell PATH variable in that a colon (':') separates entries.
221       On Windows systems, a semicolon (';') is used as a separator. The  data
222       dictionary  code  will  attempt  to  load  each  file  specified in the
223       DCMDICTPATH environment variable. It is an error if no data  dictionary
224       can be loaded.
225
227       Copyright  (C)  1998-2010  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
228       Germany.
229
230
231
232Version 3.6.0                     6 Jan 2011                        dcmpsmk(1)
Impressum