1pdf2dcm(1) OFFIS DCMTK pdf2dcm(1)
2
6 pdf2dcm - Encapsulate PDF file into DICOM file format
7
10 pdf2dcm [options] pdffile-in dcmfile-out
11
13 The pdf2dcm utility reads a PDF file (pdffile-in), converts it to a
14 DICOM Encapsulated PDF Storage SOP instance and stores the converted
15 data to an output file (dcmfile-out).
16
18 pdffile-in PDF input filename to be encapsulated
19 dcmfile-out DICOM output filename
21
23 general options
24 -h --help
25 print this help text and exit
26 --version
28 print version information and exit
29 --arguments
31 print expanded command line arguments
32 -q --quiet
34 quiet mode, print no warnings and errors
35 -v --verbose
37 verbose mode, print processing details
38 -d --debug
40 debug mode, print debug information
41 -ll --log-level [l]evel: string constant
43 (fatal, error, warn, info, debug, trace)
44 use level l for the logger
45 -lc --log-config [f]ilename: string
47 use config file f for the logger
48 DICOM document options
50 document title:
51 +t --title [t]itle: string (default: empty)
53 document title
54 +cn --concept-name [CSD] [CV] [CM]: string (default: empty)
56 coded representation of document title defined by coding
57 scheme designator CSD, code value CV and code meaning CM
58 patient data:
60 +pn --patient-name [n]ame: string
62 patient's name in DICOM PN syntax
63 +pi --patient-id [i]d: string
65 patient identifier
66 +pb --patient-birthdate [d]ate: string (YYYYMMDD)
68 patient's birth date
69 +ps --patient-sex [s]ex: string (M, F or O)
71 patient's sex
72 study and series:
74 +sg --generate
76 generate new study and series UIDs (default)
77 +st --study-from [f]ilename: string
79 read patient/study data from DICOM file
80 +se --series-from [f]ilename: string
82 read patient/study/series data from DICOM file
83 instance number:
85 +i1 --instance-one
87 use instance number 1 (default, not with +se)
88 +ii --instance-inc
90 increment instance number (only with +se)
91 +is --instance-set [i]nstance number: integer
93 use instance number i
94 burned-in annotation:
96 +an --annotation-yes
98 document contains patient identifying data (default)
99 -an --annotation-no
101 document does not contain patient identifying data
102 processing options
104 other processing options:
105 -k --key [k]ey: gggg,eeee="str", path or dictionary name="str"
107 add further attribute
108 output options
110 output file format:
111 +F --write-file
113 write file format (default)
114 -F --write-dataset
116 write data set without file meta information
117 group length encoding:
119 +g= --group-length-recalc
121 recalculate group lengths if present (default)
122 +g --group-length-create
124 always write with group length elements
125 -g --group-length-remove
127 always write without group length elements
128 length encoding in sequences and items:
130 +e --length-explicit
132 write with explicit lengths (default)
133 -e --length-undefined
135 write with undefined lengths
136 data set trailing padding (not with --write-dataset):
138 -p --padding-off
140 no padding (implicit if --write-dataset)
141 +p --padding-create [f]ile-pad [i]tem-pad: integer
143 align file on multiple of f bytes
144 and items on multiple of i bytes
145
147 Attribute Sources
148 The application may be fed with some additional input for filling
149 mandatory (and optional) attributes in the new DICOM file like patient,
150 study and series information:
151 • The --key option can be used to add further attributes to the DICOM
153 output file.
154 • It is also possible to specify sequences, items and nested attributes
155 using the --key option. In these cases, a special 'path' notation has
156 to be used. Details on this path notation can be found in the
157 documentation of dcmodify.
158 • The --key option can be present more than once.
159 • The value part (after the '=') may be absent causing the attribute to
160 be set with zero length.
161 • Please be advised that the --key option is applied at the very end,
162 just before saving the DICOM file, so there is no value checking
163 whatsoever.
165 The level of logging output of the various command line tools and
166 underlying libraries can be specified by the user. By default, only
167 errors and warnings are written to the standard error stream. Using
168 option --verbose also informational messages like processing details
169 are reported. Option --debug can be used to get more details on the
170 internal activity, e.g. for debugging purposes. Other logging levels
171 can be selected using option --log-level. In --quiet mode only fatal
172 errors are reported. In such very severe error events, the application
173 will usually terminate. For more details on the different logging
174 levels, see documentation of module 'oflog'.
175 In case the logging output should be written to file (optionally with
176 logfile rotation), to syslog (Unix) or the event log (Windows) option
177 --log-config can be used. This configuration file also allows for
178 directing only certain messages to a particular output stream and for
179 filtering certain messages based on the module or application where
180 they are generated. An example configuration file is provided in
181 <etcdir>/logger.cfg.
183 All command line tools use the following notation for parameters:
184 square brackets enclose optional values (0-1), three trailing dots
185 indicate that multiple values are allowed (1-n), a combination of both
186 means 0 to n values.
187 Command line options are distinguished from parameters by a leading '+'
188 or '-' sign, respectively. Usually, order and position of command line
189 options are arbitrary (i.e. they can appear anywhere). However, if
190 options are mutually exclusive the rightmost appearance is used. This
191 behavior conforms to the standard evaluation rules of common Unix
192 shells.
193 In addition, one or more command files can be specified using an '@'
194 sign as a prefix to the filename (e.g. @command.txt). Such a command
195 argument is replaced by the content of the corresponding text file
196 (multiple whitespaces are treated as a single separator unless they
197 appear between two quotation marks) prior to any further evaluation.
198 Please note that a command file cannot contain another command file.
199 This simple but effective approach allows one to summarize common
200 combinations of options/parameters and avoids longish and confusing
201 command lines (an example is provided in file <datadir>/dumppat.txt).
203 The pdf2dcm utility uses the following exit codes when terminating.
204 This enables the user to check for the reason why the application
205 terminated.
206 general
207 EXITCODE_NO_ERROR 0
208 EXITCODE_COMMANDLINE_SYNTAX_ERROR 1
209 EXITCODE_MEMORY_EXHAUSTED 4
210 input file errors
211 EXITCODE_CANNOT_READ_INPUT_FILE 20
212 EXITCODE_NO_INPUT_FILES 21
213 EXITCODE_INVALID_INPUT_FILE 22
214 output file errors
215 EXITCODE_CANNOT_WRITE_OUTPUT_FILE 40
217 The pdf2dcm utility will attempt to load DICOM data dictionaries
218 specified in the DCMDICTPATH environment variable. By default, i.e. if
219 the DCMDICTPATH environment variable is not set, the file
220 <datadir>/dicom.dic will be loaded unless the dictionary is built into
221 the application (default for Windows).
222 The default behavior should be preferred and the DCMDICTPATH
223 environment variable only used when alternative data dictionaries are
224 required. The DCMDICTPATH environment variable has the same format as
225 the Unix shell PATH variable in that a colon (':') separates entries.
226 On Windows systems, a semicolon (';') is used as a separator. The data
227 dictionary code will attempt to load each file specified in the
228 DCMDICTPATH environment variable. It is an error if no data dictionary
229 can be loaded.
231 dcm2pdf(1)
233 Copyright (C) 2005-2022 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
234 Germany.
235Version 3.6.7 Fri Apr 22 2022 pdf2dcm(1)