OFFIS DCMTK  Version 3.6.0
dcmpsmk.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmpsmk Create DICOM grayscale softcopy presentation state
5 \else
6 \page dcmpsmk dcmpsmk: Create DICOM grayscale softcopy presentation state
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmpsmk [options] dcmfile-in dcmfile-out
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
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.
25 
26 \section parameters PARAMETERS
27 
28 \verbatim
29 dcmfile-in DICOM image file to be read
30 
31 dcmfile-out DICOM presentation state file to be created
32 \endverbatim
33 
34 \section options OPTIONS
35 
36 \subsection general_options general options
37 \verbatim
38  -h --help
39  print this help text and exit
40 
41  --version
42  print version information and exit
43 
44  --arguments
45  print expanded command line arguments
46 
47  -q --quiet
48  quiet mode, print no warnings and errors
49 
50  -v --verbose
51  verbose mode, print processing details
52 
53  -d --debug
54  debug mode, print debug information
55 
56  -ll --log-level [l]evel: string constant
57  (fatal, error, warn, info, debug, trace)
58  use level l for the logger
59 
60  -lc --log-config [f]ilename: string
61  use config file f for the logger
62 \endverbatim
63 
64 \subsection input_options input optons
65 \verbatim
66 input file format:
67 
68  +f --read-file
69  read file format or data set (default)
70 
71  +fo --read-file-only
72  read file format only
73 
74  -f --read-dataset
75  read data set without file meta information
76 
77 input transfer syntax:
78 
79  -t= --read-xfer-auto
80  use TS recognition (default)
81 
82  -td --read-xfer-detect
83  ignore TS specified in the file meta header
84 
85  -te --read-xfer-little
86  read with explicit VR little endian TS
87 
88  -tb --read-xfer-big
89  read with explicit VR big endian TS
90 
91  -ti --read-xfer-implicit
92  read with implicit VR little endian TS
93 \endverbatim
94 
95 \subsection processing_options processing options
96 \verbatim
97 VOI transform handling:
98 
99  +Vl --voi-lut
100  use first VOI LUT if present (default)
101 
102  +Vw --voi-window
103  use first window center/width if present
104 
105  -V --voi-ignore
106  ignore VOI LUT and window center/width
107 
108 curve handling:
109 
110  +c --curve-activate
111  activate curve data if present (default)
112 
113  -c --curve-ignore
114  ignore curve data
115 
116 overlay handling:
117 
118  +oc --overlay-copy
119  copy overlays if not embedded, activate otherwise (default)
120 
121  +oa --overlay-activate
122  activate overlays
123 
124  -o --overlay-ignore
125  ignore overlays
126 
127 shutter handling:
128 
129  +s --shutter-activate
130  use shutter if present in image (default)
131 
132  -s --shutter-ignore
133  ignore shutter
134 
135 presentation LUT shape handling:
136 
137  +p --plut-activate
138  use presentation LUT shape if present (default)
139 
140  -p --plut-ignore
141  ignore presentation LUT shape
142 
143 layering:
144 
145  +l1 --layer-single
146  all curves and overlays are in one layer
147 
148  +l2 --layer-double
149  one layer for curves, one for overlays (default)
150 
151  +ls --layer-separate
152  separate layers for each curve and overlay
153 
154 location of referenced image:
155 
156  -lx --location-none
157  image reference without location (default)
158 
159  -ln --location-network [a]etitle: string
160  image located at application entity a
161 
162  -lm --location-media [f]ilesetID, fileset[UID]: string
163  image located on storage medium
164 \endverbatim
165 
166 \subsection output_options output options
167 \verbatim
168 output transfer syntax:
169 
170  +t= --write-xfer-same
171  write with same TS as image file (default)
172 
173  +te --write-xfer-little
174  write with explicit VR little endian TS
175 
176  +tb --write-xfer-big
177  write with explicit VR big endian TS
178 
179  +ti --write-xfer-implicit
180  write with implicit VR little endian TS
181 \endverbatim
182 
183 \section logging LOGGING
184 
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".
194 
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>).
201 
202 \section command_line COMMAND LINE
203 
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.
207 
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.
213 
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>).
223 
224 \section environment ENVIRONMENT
225 
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).
231 
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.
239 
240 \section copyright COPYRIGHT
241 
242 Copyright (C) 1998-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
243 
244 */


Generated on Sun Aug 23 2015 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.9.1