4 \page dcmpsmk Create DICOM grayscale softcopy presentation state
6 \page dcmpsmk dcmpsmk: Create DICOM grayscale softcopy presentation state
9 \section synopsis SYNOPSIS
12 dcmpsmk [options] dcmfile-in dcmfile-out
15 \section description DESCRIPTION
17 The \b dcmpsmk utility reads a DICOM image file and creates a grayscale
18 softcopy presentation state object according to Supplement 33. The
19 presentation state object is written back to file. A number of command line
20 options allow to specify how certain constructs that might be present in
21 the image file should be referenced or activated in the presentation state.
22 The newly created presentation state references the source image and
23 contains values that should allow for a "reasonable" display of the image
24 when rendered under control of the presentation state.
26 \section parameters PARAMETERS
29 dcmfile-in DICOM image file to be read
31 dcmfile-out DICOM presentation state file to be created
34 \section options OPTIONS
36 \subsection general_options general options
39 print this help text and exit
42 print version information and exit
45 print expanded command line arguments
48 quiet mode, print no warnings and errors
51 verbose mode, print processing details
54 debug mode, print debug information
56 -ll --log-level [l]evel: string constant
57 (fatal, error, warn, info, debug, trace)
58 use level l for the logger
60 -lc --log-config [f]ilename: string
61 use config file f for the logger
64 \subsection input_options input optons
69 read file format or data set (default)
75 read data set without file meta information
77 input transfer syntax:
80 use TS recognition (default)
82 -td --read-xfer-detect
83 ignore TS specified in the file meta header
85 -te --read-xfer-little
86 read with explicit VR little endian TS
89 read with explicit VR big endian TS
91 -ti --read-xfer-implicit
92 read with implicit VR little endian TS
95 \subsection processing_options processing options
97 VOI transform handling:
100 use first VOI LUT if present (default)
103 use first window center/width if present
106 ignore VOI LUT and window center/width
111 activate curve data if present (default)
119 copy overlays if not embedded, activate otherwise (default)
121 +oa --overlay-activate
129 +s --shutter-activate
130 use shutter if present in image (default)
135 presentation LUT shape handling:
138 use presentation LUT shape if present (default)
141 ignore presentation LUT shape
146 all curves and overlays are in one layer
149 one layer for curves, one for overlays (default)
152 separate layers for each curve and overlay
154 location of referenced image:
157 image reference without location (default)
159 -ln --location-network [a]etitle: string
160 image located at application entity a
162 -lm --location-media [f]ilesetID, fileset[UID]: string
163 image located on storage medium
166 \subsection output_options output options
168 output transfer syntax:
170 +t= --write-xfer-same
171 write with same TS as image file (default)
173 +te --write-xfer-little
174 write with explicit VR little endian TS
177 write with explicit VR big endian TS
179 +ti --write-xfer-implicit
180 write with implicit VR little endian TS
183 \section logging LOGGING
185 The level of logging output of the various command line tools and underlying
186 libraries can be specified by the user. By default, only errors and warnings
187 are written to the standard error stream. Using option \e --verbose also
188 informational messages like processing details are reported. Option
189 \e --debug can be used to get more details on the internal activity, e.g. for
190 debugging purposes. Other logging levels can be selected using option
191 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
192 very severe error events, the application will usually terminate. For more
193 details on the different logging levels, see documentation of module "oflog".
195 In case the logging output should be written to file (optionally with logfile
196 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
197 can be used. This configuration file also allows for directing only certain
198 messages to a particular output stream and for filtering certain messages
199 based on the module or application where they are generated. An example
200 configuration file is provided in <em><etcdir>/logger.cfg</em>).
202 \section command_line COMMAND LINE
204 All command line tools use the following notation for parameters: square
205 brackets enclose optional values (0-1), three trailing dots indicate that
206 multiple values are allowed (1-n), a combination of both means 0 to n values.
208 Command line options are distinguished from parameters by a leading '+' or '-'
209 sign, respectively. Usually, order and position of command line options are
210 arbitrary (i.e. they can appear anywhere). However, if options are mutually
211 exclusive the rightmost appearance is used. This behaviour conforms to the
212 standard evaluation rules of common Unix shells.
214 In addition, one or more command files can be specified using an '@' sign as a
215 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
216 is replaced by the content of the corresponding text file (multiple
217 whitespaces are treated as a single separator unless they appear between two
218 quotation marks) prior to any further evaluation. Please note that a command
219 file cannot contain another command file. This simple but effective approach
220 allows to summarize common combinations of options/parameters and avoids
221 longish and confusing command lines (an example is provided in file
222 <em><datadir>/dumppat.txt</em>).
224 \section environment ENVIRONMENT
226 The \b dcmpsmk utility will attempt to load DICOM data dictionaries specified
227 in the \e DCMDICTPATH environment variable. By default, i.e. if the
228 \e DCMDICTPATH environment variable is not set, the file
229 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
230 into the application (default for Windows).
232 The default behaviour should be preferred and the \e DCMDICTPATH environment
233 variable only used when alternative data dictionaries are required. The
234 \e DCMDICTPATH environment variable has the same format as the Unix shell
235 \e PATH variable in that a colon (":") separates entries. On Windows systems,
236 a semicolon (";") is used as a separator. The data dictionary code will
237 attempt to load each file specified in the \e DCMDICTPATH environment variable.
238 It is an error if no data dictionary can be loaded.
240 \section copyright COPYRIGHT
242 Copyright (C) 1998-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.