OFFIS DCMTK  Version 3.6.0
pdf2dcm.man
1 /*!
2 
3 \if MANPAGES
4 \page pdf2dcm Convert PDF file to DICOM
5 \else
6 \page pdf2dcm pdf2dcm: Convert PDF file to DICOM
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 pdf2dcm [options] pdffile-in dcmfile-out
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b pdf2dcm utility reads a PDF file (\e pdffile-in), converts it to a
18 DICOM Encapsulated PDF Storage SOP instance and stores the converted data
19 to an output file (\e dcmfile-out).
20 
21 \section parameters PARAMETERS
22 
23 \verbatim
24 pdffile-in PDF input filename to be converted
25 
26 dcmfile-out DICOM output filename
27 \endverbatim
28 
29 \section options OPTIONS
30 
31 \subsection general_options general options
32 \verbatim
33  -h --help
34  print this help text and exit
35 
36  --version
37  print version information and exit
38 
39  --arguments
40  print expanded command line arguments
41 
42  -q --quiet
43  quiet mode, print no warnings and errors
44 
45  -v --verbose
46  verbose mode, print processing details
47 
48  -d --debug
49  debug mode, print debug information
50 
51  -ll --log-level [l]evel: string constant
52  (fatal, error, warn, info, debug, trace)
53  use level l for the logger
54 
55  -lc --log-config [f]ilename: string
56  use config file f for the logger
57 \endverbatim
58 
59 \subsection dicom_document_options DICOM document options
60 \verbatim
61 burned-in annotation:
62 
63  +an --annotation-yes
64  PDF contains patient identifying data (default)
65 
66  -an --annotation-no
67  PDF does not contain patient identifying data
68 
69 document title:
70 
71  +t --title [t]itle: string (default: empty)
72  document title
73 
74  +cn --concept-name [CSD] [CV] [CM]: string (default: empty)
75  document title as concept name code sequence with coding
76  scheme designator CSD, code value CV and code meaning CM
77 
78 patient data:
79 
80  +pn --patient-name [n]ame: string
81  patient's name in DICOM PN syntax
82 
83  +pi --patient-id [i]d: string
84  patient identifier
85 
86  +pb --patient-birthdate [d]ate: string (YYYYMMDD)
87  patient's birth date
88 
89  +ps --patient-sex [s]ex: string (M, F or O)
90  patient's sex
91 
92 study and series:
93 
94  +sg --generate
95  generate new study and series UIDs (default)
96 
97  +st --study-from [f]ilename: string
98  read patient/study data from DICOM file
99 
100  +se --series-from [f]ilename: string
101  read patient/study/series data from DICOM file
102 
103 instance number:
104 
105  +i1 --instance-one
106  use instance number 1 (default, not with +se)
107 
108  +ii --instance-inc
109  increment instance number (only with +se)
110 
111  +is --instance-set [i]nstance number: integer
112  use instance number i
113 \endverbatim
114 
115 \section logging LOGGING
116 
117 The level of logging output of the various command line tools and underlying
118 libraries can be specified by the user. By default, only errors and warnings
119 are written to the standard error stream. Using option \e --verbose also
120 informational messages like processing details are reported. Option
121 \e --debug can be used to get more details on the internal activity, e.g. for
122 debugging purposes. Other logging levels can be selected using option
123 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
124 very severe error events, the application will usually terminate. For more
125 details on the different logging levels, see documentation of module "oflog".
126 
127 In case the logging output should be written to file (optionally with logfile
128 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
129 can be used. This configuration file also allows for directing only certain
130 messages to a particular output stream and for filtering certain messages
131 based on the module or application where they are generated. An example
132 configuration file is provided in <em><etcdir>/logger.cfg</em>).
133 
134 \section command_line COMMAND LINE
135 
136 All command line tools use the following notation for parameters: square
137 brackets enclose optional values (0-1), three trailing dots indicate that
138 multiple values are allowed (1-n), a combination of both means 0 to n values.
139 
140 Command line options are distinguished from parameters by a leading '+' or '-'
141 sign, respectively. Usually, order and position of command line options are
142 arbitrary (i.e. they can appear anywhere). However, if options are mutually
143 exclusive the rightmost appearance is used. This behaviour conforms to the
144 standard evaluation rules of common Unix shells.
145 
146 In addition, one or more command files can be specified using an '@' sign as a
147 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
148 is replaced by the content of the corresponding text file (multiple
149 whitespaces are treated as a single separator unless they appear between two
150 quotation marks) prior to any further evaluation. Please note that a command
151 file cannot contain another command file. This simple but effective approach
152 allows to summarize common combinations of options/parameters and avoids
153 longish and confusing command lines (an example is provided in file
154 <em><datadir>/dumppat.txt</em>).
155 
156 \section environment ENVIRONMENT
157 
158 The \b pdf2dcm utility will attempt to load DICOM data dictionaries specified
159 in the \e DCMDICTPATH environment variable. By default, i.e. if the
160 \e DCMDICTPATH environment variable is not set, the file
161 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
162 into the application (default for Windows).
163 
164 The default behaviour should be preferred and the \e DCMDICTPATH environment
165 variable only used when alternative data dictionaries are required. The
166 \e DCMDICTPATH environment variable has the same format as the Unix shell
167 \e PATH variable in that a colon (":") separates entries. On Windows systems,
168 a semicolon (";") is used as a separator. The data dictionary code will
169 attempt to load each file specified in the \e DCMDICTPATH environment variable.
170 It is an error if no data dictionary can be loaded.
171 
172 \section see_also SEE ALSO
173 
174 <b>dcm2pdf</b>(1)
175 
176 \section copyright COPYRIGHT
177 
178 Copyright (C) 2005-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
179 
180 */


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