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

NAME

6       dcmpsmk - Create DICOM grayscale softcopy presentation state
7
8

SYNOPSIS

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

DESCRIPTION

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

PARAMETERS

24       dcmfile-in   DICOM image file(s) to be read
25
26       dcmfile-out  DICOM presentation state file to be created
27

OPTIONS

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

NOTES

169       If  more  than one input file (dcmfile-in) is specified, the additional
170       image files are only referenced from  the  created  presentation  state
171       file, but no further (e.g. display-related) information is taken over.
172

LOGGING

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
185       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

COMMAND LINE

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
199       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       behavior  conforms  to  the  standard  evaluation  rules of common Unix
204       shells.
205
206       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  one  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

ENVIRONMENT

217       The dcmpsmk 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
223       The  default  behavior  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       Copyright  (C)  1998-2014  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
234       Germany.
235
236
237
238Version 3.6.2                   Fri Jul 14 2017                     dcmpsmk(1)
Impressum