1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/*!
\if MANPAGES
\page dcmp2pgm Read DICOM image and presentation state and render bitmap
\else
\page dcmp2pgm dcmp2pgm: Read DICOM image and presentation state and render bitmap
\endif
\section synopsis SYNOPSIS
\verbatim
dcmp2pgm [options] dcmimage-in [bitmap-out]
\endverbatim
\section description DESCRIPTION
The \b dcmp2pgm utility renders a monochrome DICOM image under the control of
a grayscale softcopy presentation state object into a monochrome bitmap
with 8 bits/pixel. The bitmap is stored either as "Portable Gray Map" (PGM)
or as a DICOM secondary capture image object. If no presentation state is
read from file, a default presentation state is created. The utility allows
to read a configuration file of the Softcopy Presentation State Viewer upon
startup. In this case, the settings from the configuration file affecting
the rendering of the presentation state are used, e.g. a correction of the
gray scale range according to Barten's model (DICOM part 14) can be
performed if the characteristic curve of the display system is available
and defined in the configuration file.
\section parameters PARAMETERS
\verbatim
dcmimage-in input DICOM image
bitmap-out output DICOM image or PGM bitmap
\endverbatim
\section options OPTIONS
\subsection general_options general options
\verbatim
-h --help
print this help text and exit
--version
print version information and exit
--arguments
print expanded command line arguments
-q --quiet
quiet mode, print no warnings and errors
-v --verbose
verbose mode, print processing details
-d --debug
debug mode, print debug information
-ll --log-level [l]evel: string constant
(fatal, error, warn, info, debug, trace)
use level l for the logger
-lc --log-config [f]ilename: string
use config file f for the logger
\endverbatim
\subsection processing_options processing options
\verbatim
-p --pstate [f]ilename: string
process using presentation state file
-c --config [f]ilename: string
process using settings from configuration file
-f --frame [f]rame: integer
process using image frame f (default: 1)
\endverbatim
\subsection output_format output format
\verbatim
-D --pgm
save image as PGM (default)
+D --dicom
save image as DICOM secondary capture
\endverbatim
\subsection output_options output options
\verbatim
+S --save-pstate [f]ilename: string
save presentation state to file
\endverbatim
\section logging LOGGING
The level of logging output of the various command line tools and underlying
libraries can be specified by the user. By default, only errors and warnings
are written to the standard error stream. Using option \e --verbose also
informational messages like processing details are reported. Option
\e --debug can be used to get more details on the internal activity, e.g. for
debugging purposes. Other logging levels can be selected using option
\e --log-level. In \e --quiet mode only fatal errors are reported. In such
very severe error events, the application will usually terminate. For more
details on the different logging levels, see documentation of module "oflog".
In case the logging output should be written to file (optionally with logfile
rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
can be used. This configuration file also allows for directing only certain
messages to a particular output stream and for filtering certain messages
based on the module or application where they are generated. An example
configuration file is provided in <em>\<etcdir\>/logger.cfg</em>).
\section command_line COMMAND LINE
All command line tools use the following notation for parameters: square
brackets enclose optional values (0-1), three trailing dots indicate that
multiple values are allowed (1-n), a combination of both means 0 to n values.
Command line options are distinguished from parameters by a leading '+' or '-'
sign, respectively. Usually, order and position of command line options are
arbitrary (i.e. they can appear anywhere). However, if options are mutually
exclusive the rightmost appearance is used. This behaviour conforms to the
standard evaluation rules of common Unix shells.
In addition, one or more command files can be specified using an '@' sign as a
prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
is replaced by the content of the corresponding text file (multiple
whitespaces are treated as a single separator unless they appear between two
quotation marks) prior to any further evaluation. Please note that a command
file cannot contain another command file. This simple but effective approach
allows to summarize common combinations of options/parameters and avoids
longish and confusing command lines (an example is provided in file
<em>\<datadir\>/dumppat.txt</em>).
\section environment ENVIRONMENT
The \b dcmp2pgm utility will attempt to load DICOM data dictionaries specified
in the \e DCMDICTPATH environment variable. By default, i.e. if the
\e DCMDICTPATH environment variable is not set, the file
<em>\<datadir\>/dicom.dic</em> will be loaded unless the dictionary is built
into the application (default for Windows).
The default behaviour should be preferred and the \e DCMDICTPATH environment
variable only used when alternative data dictionaries are required. The
\e DCMDICTPATH environment variable has the same format as the Unix shell
\e PATH variable in that a colon (":") separates entries. On Windows systems,
a semicolon (";") is used as a separator. The data dictionary code will
attempt to load each file specified in the \e DCMDICTPATH environment variable.
It is an error if no data dictionary can be loaded.
\section files FILES
<em>\<etcdir\>/dcmpstat.cfg</em> - sample configuration file
\section copyright COPYRIGHT
Copyright (C) 1998-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
*/
|
