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

NAME

6       pdf2dcm - Convert PDF file to DICOM
7

SYNOPSIS

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

DESCRIPTION

12       The  pdf2dcm  utility  reads  a PDF file (pdffile-in), converts it to a
13       DICOM Encapsulated PDF Storage SOP instance and  stores  the  converted
14       data to an output file (dcmfile-out).
15

PARAMETERS

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

OPTIONS

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

LOGGING

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

COMMAND LINE

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

ENVIRONMENT

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

SEE ALSO

162       dcm2pdf(1)
163
165       Copyright  (C)  2005-2010  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
166       Germany.
167
168
169
170Version 3.6.0                     6 Jan 2011                        pdf2dcm(1)
Impressum