File: dcmpsprt.1

package info (click to toggle)
dcmtk 3.6.7-9~deb12u3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 60,000 kB
  • sloc: cpp: 298,501; ansic: 47,533; makefile: 5,556; sh: 4,341; xml: 482; perl: 277; lex: 103
file content (277 lines) | stat: -rw-r--r-- 9,572 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
.TH "dcmpsprt" 1 "Fri Apr 22 2022" "Version 3.6.7" "OFFIS DCMTK" \" -*- nroff -*-
.nh
.SH NAME
dcmpsprt \- Read DICOM images and presentation states and render print job

.SH "SYNOPSIS"
.PP
.PP
.nf
dcmpsprt [options] dcmfile-in...
.fi
.PP
.SH "DESCRIPTION"
.PP
The \fBdcmpsprt\fP utility reads one or more DICOM images and presentation states and creates a print job\&. The print job consists of one Stored Print object and one or more Hardcopy Grayscale images and is written to the database specified in the configuration file\&. The print job can optionally be spooled to the printer\&. In this case, \fBdcmpsprt\fP calls the \fBdcmprscu\fP application which performs communication with the printer\&.
.SH "PARAMETERS"
.PP
.PP
.nf
dcmfile-in  DICOM image file(s) to be printed
.fi
.PP
.SH "OPTIONS"
.PP
.SS "general options"
.PP
.nf
  -h   --help
         print this help text and exit

       --version
         print version information and exit

       --arguments
         print expanded command line arguments

  -q   --quiet
         quiet mode, print no warnings and errors

  -v   --verbose
         verbose mode, print processing details

  -d   --debug
         debug mode, print debug information

  -ll  --log-level  [l]evel: string constant
         (fatal, error, warn, info, debug, trace)
         use level l for the logger

  -lc  --log-config  [f]ilename: string
         use config file f for the logger
.fi
.PP
.SS "processing options"
.PP
.nf
  +p   --pstate  [p]state file: string
         render the following image with presentation state p
         (this option can be specified multiple times)

  -c   --config  [f]ilename: string
         process using settings from configuration file f

  -p   --printer  [n]ame: string (default: 1st printer in cfg file)
         select printer with identifier n from cfg file
.fi
.PP
.SS "spooling options"
.PP
.nf
  -s   --spool
         spool print job to DICOM printer

       --nospool
         do not spool print job to DICOM printer (default)
.fi
.PP
.SS "film orientation options"
.PP
.nf
       --portrait
         set portrait orientation

       --landscape
         set landscape orientation

       --default-orientation
         use printer default (default)
.fi
.PP
.SS "trim (border) options"
.PP
.nf
       --trim
         set trim on

       --no-trim
         set trim off

       --default-trim
         use printer default (default)
.fi
.PP
.SS "requested decimate/crop behavior options"
.PP
.nf
       --request-decimate
         request decimate

       --request-crop
         request crop

       --request-fail
         request failure

       --default-request
         use printer default (default)
.fi
.PP
.SS "print presentation LUT options"
.PP
.nf
       --default-plut
         do not create presentation LUT (default)

       --identity
         set IDENTITY presentation LUT shape

       --plut  [l]ut identifier: string
         add LUT l to print job

       --inverse-plut
         render the inverse presentation LUT into the
         bitmap of the hardcopy grayscale image

       --illumination  [v]alue: integer (0..65535)
         set illumination to v (in cd/m^2)

       --reflection  [v]alue: integer (0..65535)
         set reflected ambient light to v (in cd/m^2)
.fi
.PP
.SS "basic film session options (only with –spool)"
.PP
.nf
       --copies  [v]alue: integer (1..100, default: 1)
         set number of copies to v

       --medium-type  [v]alue: string
         set medium type to v

       --destination  [v]alue: string
         set film destination to v

       --label  [v]alue: string
         set film session label to v

       --priority  [v]alue: string
         set print priority to v

       --owner  [v]alue: string
         set film session owner ID to v
.fi
.PP
.SS "annotation options"
.PP
.nf
       --no-annotation
         do not create annotation (default)

  -a   --annotation  [t]ext: string
         create annotation with text t

  +pd  --print-date
         prepend date/time to annotation (default)

  -pd  --print-no-date
         do not prepend date/time to annotation

  +pn  --print-name
         prepend printer name to annotation (default)

  -pn  --print-no-name
         do not prepend printer name to annotation

  +pl  --print-lighting
         prepend illumination to annotation (default)

  -pl  --print-no-lighting
         do not prepend illumination to annotation
.fi
.PP
.SS "overlay options"
.PP
.nf
  +O   --overlay  [f]ilename: string, [x] [y]: integer
         load overlay data from PBM file f and display at position (x,y)

  +Og  --ovl-graylevel  [v]alue: integer (0..4095)
         use overlay gray level v (default: 4095 = white)
.fi
.PP
.SS "other print options"
.PP
.nf
  -l   --layout  [c]olumns [r]ows: integer (default: 1 1)
         use 'STANDARD\c,r' image display format

       --filmsize  [v]alue: string
         set film size ID to v

       --magnification  [v]alue: string
         set magnification type to v

       --smoothing  [v]alue: string
         set smoothing type to v

       --configinfo  [v]alue: string
         set configuration information to v

       --resolution  [v]alue: string
         set requested resolution ID to v

       --border  [v]alue: string
         set border density to v

       --empty-image  [v]alue: string
         set empty image density to v

       --max-density  [v]alue: string
         set max density to v

       --min-density  [v]alue: string
         set min density to v

       --img-polarity  [v]alue: string
         set image box polarity to v (NORMAL or REVERSE)

       --img-request-size  [v]alue: string
         set requested image size to v (width in mm)

       --img-magnification  [v]alue: string
         set image box magnification type to v

       --img-smoothing  [v]alue: string
         set image box smoothing type to v

       --img-configinfo  [v]alue: string
         set image box configuration information to v
.fi
.PP
.SH "LOGGING"
.PP
The level of logging output of the various command line tools and underlying libraries can be specified by the user\&. By default, only errors and warnings are written to the standard error stream\&. Using option \fI--verbose\fP also informational messages like processing details are reported\&. Option \fI--debug\fP can be used to get more details on the internal activity, e\&.g\&. for debugging purposes\&. Other logging levels can be selected using option \fI--log-level\fP\&. In \fI--quiet\fP mode only fatal errors are reported\&. In such very severe error events, the application will usually terminate\&. For more details on the different logging levels, see documentation of module 'oflog'\&.
.PP
In case the logging output should be written to file (optionally with logfile rotation), to syslog (Unix) or the event log (Windows) option \fI--log-config\fP can be used\&. This configuration file also allows for directing only certain messages to a particular output stream and for filtering certain messages based on the module or application where they are generated\&. An example configuration file is provided in \fI<etcdir>/logger\&.cfg\fP\&.
.SH "COMMAND LINE"
.PP
All command line tools use the following notation for parameters: square brackets enclose optional values (0-1), three trailing dots indicate that multiple values are allowed (1-n), a combination of both means 0 to n values\&.
.PP
Command line options are distinguished from parameters by a leading '+' or '-' sign, respectively\&. Usually, order and position of command line options are arbitrary (i\&.e\&. they can appear anywhere)\&. However, if options are mutually exclusive the rightmost appearance is used\&. This behavior conforms to the standard evaluation rules of common Unix shells\&.
.PP
In addition, one or more command files can be specified using an '@' sign as a prefix to the filename (e\&.g\&. \fI@command\&.txt\fP)\&. Such a command argument is replaced by the content of the corresponding text file (multiple whitespaces are treated as a single separator unless they appear between two quotation marks) prior to any further evaluation\&. Please note that a command file cannot contain another command file\&. This simple but effective approach allows one to summarize common combinations of options/parameters and avoids longish and confusing command lines (an example is provided in file \fI<datadir>/dumppat\&.txt\fP)\&.
.SH "ENVIRONMENT"
.PP
The \fBdcmpsprt\fP utility will attempt to load DICOM data dictionaries specified in the \fIDCMDICTPATH\fP environment variable\&. By default, i\&.e\&. if the \fIDCMDICTPATH\fP environment variable is not set, the file \fI<datadir>/dicom\&.dic\fP will be loaded unless the dictionary is built into the application (default for Windows)\&.
.PP
The default behavior should be preferred and the \fIDCMDICTPATH\fP environment variable only used when alternative data dictionaries are required\&. The \fIDCMDICTPATH\fP environment variable has the same format as the Unix shell \fIPATH\fP variable in that a colon (':') separates entries\&. On Windows systems, a semicolon (';') is used as a separator\&. The data dictionary code will attempt to load each file specified in the \fIDCMDICTPATH\fP environment variable\&. It is an error if no data dictionary can be loaded\&.
.SH "FILES"
.PP
\fI<etcdir>/dcmpstat\&.cfg\fP, \fI<etcdir>/printers\&.cfg\fP - sample configuration files
.SH "SEE ALSO"
.PP
\fBdcmprscu\fP(1)
.SH "COPYRIGHT"
.PP
Copyright (C) 1999-2022 by OFFIS e\&.V\&., Escherweg 2, 26121 Oldenburg, Germany\&.