1pdf2dcm(1)                        OFFIS DCMTK                       pdf2dcm(1)
2
3
4

NAME

6       pdf2dcm - Convert PDF file to DICOM
7
8

SYNOPSIS

10       pdf2dcm [options] pdffile-in dcmfile-out
11

DESCRIPTION

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

PARAMETERS

18       pdffile-in   PDF input filename to be converted
19
20       dcmfile-out  DICOM output filename
21

OPTIONS

23   general options
24         -h   --help
25                print this help text and exit
26
27              --version
28                print version information and exit
29
30              --arguments
31                print expanded command line arguments
32
33         -q   --quiet
34                quiet mode, print no warnings and errors
35
36         -v   --verbose
37                verbose mode, print processing details
38
39         -d   --debug
40                debug mode, print debug information
41
42         -ll  --log-level  [l]evel: string constant
43                (fatal, error, warn, info, debug, trace)
44                use level l for the logger
45
46         -lc  --log-config  [f]ilename: string
47                use config file f for the logger
48
49   DICOM document options
50       burned-in annotation:
51
52         +an  --annotation-yes
53                PDF contains patient identifying data (default)
54
55         -an  --annotation-no
56                PDF does not contain patient identifying data
57
58       document title:
59
60         +t   --title  [t]itle: string (default: empty)
61                document title
62
63         +cn  --concept-name  [CSD] [CV] [CM]: string (default: empty)
64                document title as concept name code sequence with coding
65                scheme designator CSD, code value CV and code meaning CM
66
67       patient data:
68
69         +pn  --patient-name  [n]ame: string
70                patient's name in DICOM PN syntax
71
72         +pi  --patient-id  [i]d: string
73                patient identifier
74
75         +pb  --patient-birthdate  [d]ate: string (YYYYMMDD)
76                patient's birth date
77
78         +ps  --patient-sex  [s]ex: string (M, F or O)
79                patient's sex
80
81       study and series:
82
83         +sg  --generate
84                generate new study and series UIDs (default)
85
86         +st  --study-from  [f]ilename: string
87                read patient/study data from DICOM file
88
89         +se  --series-from  [f]ilename: string
90                read patient/study/series data from DICOM file
91
92       instance number:
93
94         +i1  --instance-one
95                use instance number 1 (default, not with +se)
96
97         +ii  --instance-inc
98                increment instance number (only with +se)
99
100         +is  --instance-set  [i]nstance number: integer
101                use instance number i
102

LOGGING

104       The  level  of  logging  output  of  the various command line tools and
105       underlying libraries can be specified by the  user.  By  default,  only
106       errors  and  warnings  are  written to the standard error stream. Using
107       option --verbose also informational messages  like  processing  details
108       are  reported.  Option  --debug  can be used to get more details on the
109       internal activity, e.g. for debugging purposes.  Other  logging  levels
110       can  be  selected  using option --log-level. In --quiet mode only fatal
111       errors are reported. In such very severe error events, the  application
112       will  usually  terminate.  For  more  details  on the different logging
113       levels, see documentation of module 'oflog'.
114
115       In case the logging output should be written to file  (optionally  with
116       logfile  rotation),  to syslog (Unix) or the event log (Windows) option
117       --log-config can be used.  This  configuration  file  also  allows  for
118       directing  only  certain messages to a particular output stream and for
119       filtering certain messages based on the  module  or  application  where
120       they  are  generated.  An  example  configuration  file  is provided in
121       <etcdir>/logger.cfg.
122

COMMAND LINE

124       All command line tools  use  the  following  notation  for  parameters:
125       square  brackets  enclose  optional  values  (0-1), three trailing dots
126       indicate that multiple values are allowed (1-n), a combination of  both
127       means 0 to n values.
128
129       Command line options are distinguished from parameters by a leading '+'
130       or '-' sign, respectively. Usually, order and position of command  line
131       options  are  arbitrary  (i.e.  they  can appear anywhere). However, if
132       options are mutually exclusive the rightmost appearance is  used.  This
133       behavior  conforms  to  the  standard  evaluation  rules of common Unix
134       shells.
135
136       In addition, one or more command files can be specified  using  an  '@'
137       sign  as  a  prefix to the filename (e.g. @command.txt). Such a command
138       argument is replaced by the content  of  the  corresponding  text  file
139       (multiple  whitespaces  are  treated  as a single separator unless they
140       appear between two quotation marks) prior to  any  further  evaluation.
141       Please  note  that  a command file cannot contain another command file.
142       This simple but effective  approach  allows  one  to  summarize  common
143       combinations  of  options/parameters  and  avoids longish and confusing
144       command lines (an example is provided in file <datadir>/dumppat.txt).
145

ENVIRONMENT

147       The pdf2dcm utility  will  attempt  to  load  DICOM  data  dictionaries
148       specified  in the DCMDICTPATH environment variable. By default, i.e. if
149       the  DCMDICTPATH  environment   variable   is   not   set,   the   file
150       <datadir>/dicom.dic  will be loaded unless the dictionary is built into
151       the application (default for Windows).
152
153       The  default  behavior  should  be  preferred   and   the   DCMDICTPATH
154       environment  variable  only used when alternative data dictionaries are
155       required. The DCMDICTPATH environment variable has the same  format  as
156       the  Unix  shell PATH variable in that a colon (':') separates entries.
157       On Windows systems, a semicolon (';') is used as a separator. The  data
158       dictionary  code  will  attempt  to  load  each  file  specified in the
159       DCMDICTPATH environment variable. It is an error if no data  dictionary
160       can be loaded.
161

SEE ALSO

163       dcm2pdf(1)
164
166       Copyright  (C)  2005-2014  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
167       Germany.
168
169
170
171Version 3.6.2                   Fri Jul 14 2017                     pdf2dcm(1)
Impressum