4 \page dcmpsprt Read DICOM images and presentation states and render print job
6 \page dcmpsprt dcmpsprt: Read DICOM images and presentation states and render print job
9 \section synopsis SYNOPSIS
12 dcmpsprt [options] dcmfile-in...
15 \section description DESCRIPTION
17 The \b dcmpsprt utility reads one or more DICOM images and presentation states
18 and creates a print job. The print job consists of one Stored Print object
19 and one or more Hardcopy Grayscale images and is written to the database
20 specified in the configuration file. The print job can optionally be spooled
21 to the printer. In this case, \b dcmpsprt calls the \b dcmprscu application
22 which performs communication with the printer.
24 \section parameters PARAMETERS
27 dcmfile-in DICOM image file(s) to be printed
30 \section options OPTIONS
32 \subsection general_options general options
35 print this help text and exit
38 print version information and exit
41 print expanded command line arguments
44 quiet mode, print no warnings and errors
47 verbose mode, print processing details
50 debug mode, print debug information
52 -ll --log-level [l]evel: string constant
53 (fatal, error, warn, info, debug, trace)
54 use level l for the logger
56 -lc --log-config [f]ilename: string
57 use config file f for the logger
60 \subsection processing_options processing options
62 +p --pstate [p]state file: string
63 render the following image with presentation state p
64 (this option can be specified multiple times)
66 -c --config [f]ilename: string
67 process using settings from configuration file f
69 -p --printer [n]ame: string (default: 1st printer in cfg file)
70 select printer with identifier n from cfg file
73 \subsection spooling_options spooling options
76 spool print job to DICOM printer
79 do not spool print job to DICOM printer (default)
82 \subsection film_orientation_options film orientation options
85 set portrait orientation
88 set landscape orientation
91 use printer default (default)
94 \subsection trim_border_options trim (border) options
103 use printer default (default)
106 \subsection behaviour_options requested decimate/crop behaviour options
118 use printer default (default)
121 \subsection print_presentation_LUT_options print presentation LUT options
124 do not create presentation LUT (default)
127 set IDENTITY presentation LUT shape
129 --plut [l]ut identifier: string
130 add LUT l to print job
133 render the inverse presentation LUT into the
134 bitmap of the hardcopy grayscale image
136 --illumination [v]alue: integer (0..65535)
137 set illumination to v (in cd/m^2)
139 --reflection [v]alue: integer (0..65535)
140 set reflected ambient light to v (in cd/m^2)
143 \subsection film_options basic film session options (only with --spool)
145 --copies [v]alue: integer (1..100, default: 1)
146 set number of copies to v
148 --medium-type [v]alue: string
151 --destination [v]alue: string
152 set film destination to v
154 --label [v]alue: string
155 set film session label to v
157 --priority [v]alue: string
158 set print priority to v
160 --owner [v]alue: string
161 set film session owner ID to v
164 \subsection annotation_options annotation options
167 do not create annotation (default)
169 -a --annotation [t]ext: string
170 create annotation with text t
173 prepend date/time to annotation (default)
176 do not prepend date/time to annotation
179 prepend printer name to annotation (default)
182 do not prepend printer name to annotation
185 prepend illumination to annotation (default)
187 -pl --print-no-lighting
188 do not prepend illumination to annotation
191 \subsection overlay_options overlay options
193 +O --overlay [f]ilename: string, [x] [y]: integer
194 load overlay data from PBM file f and display at position (x,y)
196 +Og --ovl-graylevel [v]alue: integer (0..4095)
197 use overlay gray level v (default: 4095 = white)
200 \subsection other_print_options
202 -l --layout [c]olumns [r]ows: integer (default: 1 1)
203 use 'STANDARD\c,r' image display format
205 --filmsize [v]alue: string
206 set film size ID to v
208 --magnification [v]alue: string
209 set magnification type to v
211 --smoothing [v]alue: string
212 set smoothing type to v
214 --configinfo [v]alue: string
215 set configuration information to v
217 --resolution [v]alue: string
218 set requested resolution ID to v
220 --border [v]alue: string
221 set border density to v
223 --empty-image [v]alue: string
224 set empty image density to v
226 --max-density [v]alue: string
229 --min-density [v]alue: string
232 --img-polarity [v]alue: string
233 set image box polarity to v (NORMAL or REVERSE)
235 --img-request-size [v]alue: string
236 set requested image size to v (width in mm)
238 --img-magnification [v]alue: string
239 set image box magnification type to v
241 --img-smoothing [v]alue: string
242 set image box smoothing type to v
244 --img-configinfo [v]alue: string
245 set image box configuration information to v
248 \section logging LOGGING
250 The level of logging output of the various command line tools and underlying
251 libraries can be specified by the user. By default, only errors and warnings
252 are written to the standard error stream. Using option \e --verbose also
253 informational messages like processing details are reported. Option
254 \e --debug can be used to get more details on the internal activity, e.g. for
255 debugging purposes. Other logging levels can be selected using option
256 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
257 very severe error events, the application will usually terminate. For more
258 details on the different logging levels, see documentation of module "oflog".
260 In case the logging output should be written to file (optionally with logfile
261 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
262 can be used. This configuration file also allows for directing only certain
263 messages to a particular output stream and for filtering certain messages
264 based on the module or application where they are generated. An example
265 configuration file is provided in <em><etcdir>/logger.cfg</em>).
267 \section command_line COMMAND LINE
269 All command line tools use the following notation for parameters: square
270 brackets enclose optional values (0-1), three trailing dots indicate that
271 multiple values are allowed (1-n), a combination of both means 0 to n values.
273 Command line options are distinguished from parameters by a leading '+' or '-'
274 sign, respectively. Usually, order and position of command line options are
275 arbitrary (i.e. they can appear anywhere). However, if options are mutually
276 exclusive the rightmost appearance is used. This behaviour conforms to the
277 standard evaluation rules of common Unix shells.
279 In addition, one or more command files can be specified using an '@' sign as a
280 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
281 is replaced by the content of the corresponding text file (multiple
282 whitespaces are treated as a single separator unless they appear between two
283 quotation marks) prior to any further evaluation. Please note that a command
284 file cannot contain another command file. This simple but effective approach
285 allows to summarize common combinations of options/parameters and avoids
286 longish and confusing command lines (an example is provided in file
287 <em><datadir>/dumppat.txt</em>).
289 \section environment ENVIRONMENT
291 The \b dcmpsprt utility will attempt to load DICOM data dictionaries specified
292 in the \e DCMDICTPATH environment variable. By default, i.e. if the
293 \e DCMDICTPATH environment variable is not set, the file
294 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
295 into the application (default for Windows).
297 The default behaviour should be preferred and the \e DCMDICTPATH environment
298 variable only used when alternative data dictionaries are required. The
299 \e DCMDICTPATH environment variable has the same format as the Unix shell
300 \e PATH variable in that a colon (":") separates entries. On Windows systems,
301 a semicolon (";") is used as a separator. The data dictionary code will
302 attempt to load each file specified in the \e DCMDICTPATH environment variable.
303 It is an error if no data dictionary can be loaded.
307 <em><etcdir>/dcmpstat.cfg</em>, <em><etcdir>/printers.cfg</em> - sample configuration files
309 \section see_also SEE ALSO
313 \section copyright COPYRIGHT
315 Copyright (C) 1999-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.