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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/*!
\if MANPAGES
\page dcm2pdf Extract PDF file from DICOM encapsulated PDF
\else
\page dcm2pdf dcm2pdf: Extract PDF file from DICOM encapsulated PDF
\endif
\section synopsis SYNOPSIS
\verbatim
dcm2pdf [options] dcmfile-in pdffile-out
\endverbatim
\section description DESCRIPTION
The \b dcm2pdf utility reads a DICOM file of the Encapsulated PDF Storage SOP
Class (\e dcmfile-in), extracts the embedded PDF document and writes it to an
output file (\e pdffile-out). Optionally a command can be executed after the
creation of the PDF file.
\section parameters PARAMETERS
\verbatim
dcmfile-in DICOM input filename
pdffile-out PDF output filename
\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 input_options input options
\verbatim
input file format:
+f --read-file
read file format or data set (default)
+fo --read-file-only
read file format only
-f --read-dataset
read data set without file meta information
input transfer syntax:
-t= --read-xfer-auto
use TS recognition (default)
-td --read-xfer-detect
ignore TS specified in the file meta header
-te --read-xfer-little
read with explicit VR little endian TS
-tb --read-xfer-big
read with explicit VR big endian TS
-ti --read-xfer-implicit
read with implicit VR little endian TS
parsing of odd-length attributes:
+ao --accept-odd-length
accept odd length attributes (default)
+ae --assume-even-length
assume real length is one byte larger
handling of undefined length UN elements:
+ui --enable-cp246
read undefined len UN as implicit VR (default)
-ui --disable-cp246
read undefined len UN as explicit VR
handling of defined length UN elements:
-uc --retain-un
retain elements as UN (default)
+uc --convert-un
convert to real VR if known
automatic data correction:
+dc --enable-correction
enable automatic data correction (default)
-dc --disable-correction
disable automatic data correction
bitstream format of deflated input:
+bd --bitstream-deflated
expect deflated bitstream (default)
+bz --bitstream-zlib
expect deflated zlib bitstream
\endverbatim
\subsection execution_options execution options
\verbatim
-x --exec [c]ommand: string
execute command c after PDF extraction
\endverbatim
\section notes NOTES
Option \e --exec allows for the execution of a certain command line after the
creation of the PDF document. The command line to be executed is passed to
this option as a parameter. The specified command line may contain the
placeholder '\#f', which will be replaced by the PDF filename at run time.
The specified command line is executed in the foreground, i.e. \b pdf2dcm will
be blocked until the command terminates.
\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 dcm2pdf 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 see_also SEE ALSO
<b>pdf2dcm</b>(1)
\section copyright COPYRIGHT
Copyright (C) 2007-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
*/
|
