1dsr2html(1) OFFIS DCMTK dsr2html(1)
2
6 dsr2html - Render DICOM SR file and data set to HTML/XHTML
7
10 dsr2html [options] dsrfile-in [htmlfile-out]
11
13 The dsr2html utility renders the contents of a DICOM Structured
14 Reporting (SR) document (file format or raw data set) to HTML (Hyper
15 Text Markup Language) version 3.2 or 4.01 as well as to XHTML
16 (Extensible Hyper Text Markup Language) version 1.1.
17 If dsr2html reads a raw data set (DICOM data without a file format
19 meta-header) it will attempt to guess the transfer syntax by examining
20 the first few bytes of the file. It is not always possible to correctly
21 guess the transfer syntax and it is better to convert a data set to a
22 file format whenever possible (using the dcmconv utility). It is also
23 possible to use the -f and -t[ieb] options to force dsr2html to read a
24 dataset with a particular transfer syntax.
25
27 dsrfile-in DICOM SR input filename to be rendered
28 htmlfile-out HTML/XHTML output filename (default: stdout)
30
32 general options
33 -h --help
34 print this help text and exit
35 --version
37 print version information and exit
38 --arguments
40 print expanded command line arguments
41 -q --quiet
43 quiet mode, print no warnings and errors
44 -v --verbose
46 verbose mode, print processing details
47 -d --debug
49 debug mode, print debug information
50 -ll --log-level [l]evel: string constant
52 (fatal, error, warn, info, debug, trace)
53 use level l for the logger
54 -lc --log-config [f]ilename: string
56 use config file f for the logger
57 input options
59 input file format:
60 +f --read-file
62 read file format or data set (default)
63 +fo --read-file-only
65 read file format only
66 -f --read-dataset
68 read data set without file meta information
69 input transfer syntax:
71 -t= --read-xfer-auto
73 use TS recognition (default)
74 -td --read-xfer-detect
76 ignore TS specified in the file meta header
77 -te --read-xfer-little
79 read with explicit VR little endian TS
80 -tb --read-xfer-big
82 read with explicit VR big endian TS
83 -ti --read-xfer-implicit
85 read with implicit VR little endian TS
86 processing options
88 additional information:
89 -Ip --processing-details
91 show currently processed content item
92 error handling:
94 -Er --unknown-relationship
96 accept unknown/missing relationship type
97 -Ev --invalid-item-value
99 accept invalid content item value
100 (e.g. violation of VR or VM definition)
101 -Ec --ignore-constraints
103 ignore relationship content constraints
104 -Ee --ignore-item-errors
106 do not abort on content item errors, just warn
107 (e.g. missing value type specific attributes)
108 -Ei --skip-invalid-items
110 skip invalid content items (incl. sub-tree)
111 -Dv --disable-vr-checker
113 disable check for VR-conformant string values
114 specific character set:
116 +Cr --charset-require
118 require declaration of extended charset (default)
119 +Ca --charset-assume [c]harset: string
121 assume charset c if no extended charset declared
122 --charset-check-all
124 check all data elements with string values
125 (default: only PN, LO, LT, SH, ST, UC and UT)
126 # this option is only used for the mapping to an appropriate
128 # HTML/XHTML character encoding, but not for the conversion
129 # to UTF-8
130 +U8 --convert-to-utf8
132 convert all element values that are affected
133 by Specific Character Set (0008,0005) to UTF-8
134 # requires support from an underlying character encoding library
136 # (see output of --version on which one is available)
137 output options
139 HTML/XHTML compatibility:
140 +H3 --html-3.2
142 use only HTML version 3.2 compatible features
143 +H4 --html-4.0
145 allow all HTML version 4.01 features (default)
146 +X1 --xhtml-1.1
148 comply with XHTML version 1.1 specification
149 +Hd --add-document-type
151 add reference to SGML document type definition
152 cascading style sheet (CSS), not with HTML 3.2:
154 +Sr --css-reference URL: string
156 add reference to specified CSS to document
157 +Sf --css-file [f]ilename: string
159 embed content of specified CSS into document
160 general rendering:
162 +Ri --expand-inline
164 expand short content items inline (default)
165 -Ri --never-expand-inline
167 never expand content items inline
168 +Ra --always-expand-inline
170 always expand content items inline
171 +Rd --render-full-data
173 render full data of content items
174 +Rt --section-title-inline
176 render section titles inline, not separately
177 document rendering:
179 +Dt --document-type-title
181 use document type as document title (default)
182 +Dp --patient-info-title
184 use patient information as document title
185 -Dh --no-document-header
187 do not render general document information
188 code rendering:
190 +Ci --render-inline-codes
192 render codes in continuous text blocks
193 +Cn --concept-name-codes
195 render code of concept names
196 +Cu --numeric-unit-codes
198 render code of numeric measurement units
199 +Cv --code-value-unit
201 use code value as measurement unit (default)
202 +Cm --code-meaning-unit
204 use code meaning as measurement unit
205 +Cc --render-all-codes
207 render all codes (implies +Ci, +Cn and +Cu)
208 +Ct --code-details-tooltip
210 render code details as a tooltip (implies +Cc)
211
213 DICOM Conformance
214 The dsr2html utility supports the following SOP Classes:
215 SpectaclePrescriptionReportStorage 1.2.840.10008.5.1.4.1.1.78.6
217 MacularGridThicknessAndVolumeReportStorage 1.2.840.10008.5.1.4.1.1.79.1
218 BasicTextSRStorage 1.2.840.10008.5.1.4.1.1.88.11
219 EnhancedSRStorage 1.2.840.10008.5.1.4.1.1.88.22
220 ComprehensiveSRStorage 1.2.840.10008.5.1.4.1.1.88.33
221 Comprehensive3DSRStorage 1.2.840.10008.5.1.4.1.1.88.34
222 ProcedureLogStorage 1.2.840.10008.5.1.4.1.1.88.40
223 MammographyCADSRStorage 1.2.840.10008.5.1.4.1.1.88.50
224 KeyObjectSelectionDocumentStorage 1.2.840.10008.5.1.4.1.1.88.59
225 ChestCADSRStorage 1.2.840.10008.5.1.4.1.1.88.65
226 XRayRadiationDoseSRStorage 1.2.840.10008.5.1.4.1.1.88.67
227 RadiopharmaceuticalRadiationDoseSRStorage 1.2.840.10008.5.1.4.1.1.88.68
228 ColonCADSRStorage 1.2.840.10008.5.1.4.1.1.88.69
229 ImplantationPlanSRDocumentStorage 1.2.840.10008.5.1.4.1.1.88.70
230 AcquisitionContextSRStorage 1.2.840.10008.5.1.4.1.1.88.71
231 SimplifiedAdultEchoSRStorage 1.2.840.10008.5.1.4.1.1.88.72
232 PatientRadiationDoseSRStorage 1.2.840.10008.5.1.4.1.1.88.73
233 PlannedImagingAgentAdministrationSRStorage 1.2.840.10008.5.1.4.1.1.88.74
234 PerformedImagingAgentAdministrationSRStorage 1.2.840.10008.5.1.4.1.1.88.75
235 Character Encoding
237 The HTML/XHTML encoding is determined automatically from the DICOM
238 attribute (0008,0005) 'Specific Character Set' using the following
239 mapping:
240 ASCII (ISO_IR 6) => (none)
242 UTF-8 "ISO_IR 192" => "UTF-8"
243 ISO Latin 1 "ISO_IR 100" => "ISO-8859-1"
244 ISO Latin 2 "ISO_IR 101" => "ISO-8859-2"
245 ISO Latin 3 "ISO_IR 109" => "ISO-8859-3"
246 ISO Latin 4 "ISO_IR 110" => "ISO-8859-4"
247 ISO Latin 5 "ISO_IR 148" => "ISO-8859-9"
248 Cyrillic "ISO_IR 144" => "ISO-8859-5"
249 Arabic "ISO_IR 127" => "ISO-8859-6"
250 Greek "ISO_IR 126" => "ISO-8859-7"
251 Hebrew "ISO_IR 138" => "ISO-8859-8"
252 Thai "ISO_IR 166" => "TIS-620"
253 Japanese "ISO 2022 IR 13ISO 2022 IR 87" => "ISO-2022-JP"
254 Korean "ISO 2022 IR 6ISO 2022 IR 149" => "ISO-2022-KR"
255 Chinese "ISO 2022 IR 6ISO 2022 IR 58" => "ISO-2022-CN"
256 Chinese "GB18030" => "GB18030"
257 Chinese "GBK" => "GBK"
258 If this DICOM attribute is missing in the input file, although needed,
260 option --charset-assume can be used to specify an appropriate character
261 set manually (using one of the DICOM defined terms). For reasons of
262 backward compatibility with previous versions of this tool, the
263 following terms are also supported and mapped automatically to the
264 associated DICOM defined terms: latin-1, latin-2, latin-3, latin-4,
265 latin-5, cyrillic, arabic, greek, hebrew.
266 Option --convert-to-utf8 can be used to convert the DICOM file or data
268 set to UTF-8 encoding prior to the rendering to HTML/XHTML format.
269
271 The level of logging output of the various command line tools and
272 underlying libraries can be specified by the user. By default, only
273 errors and warnings are written to the standard error stream. Using
274 option --verbose also informational messages like processing details
275 are reported. Option --debug can be used to get more details on the
276 internal activity, e.g. for debugging purposes. Other logging levels
277 can be selected using option --log-level. In --quiet mode only fatal
278 errors are reported. In such very severe error events, the application
279 will usually terminate. For more details on the different logging
280 levels, see documentation of module 'oflog'.
281 In case the logging output should be written to file (optionally with
283 logfile rotation), to syslog (Unix) or the event log (Windows) option
284 --log-config can be used. This configuration file also allows for
285 directing only certain messages to a particular output stream and for
286 filtering certain messages based on the module or application where
287 they are generated. An example configuration file is provided in
288 <etcdir>/logger.cfg.
289
291 All command line tools use the following notation for parameters:
292 square brackets enclose optional values (0-1), three trailing dots
293 indicate that multiple values are allowed (1-n), a combination of both
294 means 0 to n values.
295 Command line options are distinguished from parameters by a leading '+'
297 or '-' sign, respectively. Usually, order and position of command line
298 options are arbitrary (i.e. they can appear anywhere). However, if
299 options are mutually exclusive the rightmost appearance is used. This
300 behavior conforms to the standard evaluation rules of common Unix
301 shells.
302 In addition, one or more command files can be specified using an '@'
304 sign as a prefix to the filename (e.g. @command.txt). Such a command
305 argument is replaced by the content of the corresponding text file
306 (multiple whitespaces are treated as a single separator unless they
307 appear between two quotation marks) prior to any further evaluation.
308 Please note that a command file cannot contain another command file.
309 This simple but effective approach allows one to summarize common
310 combinations of options/parameters and avoids longish and confusing
311 command lines (an example is provided in file <datadir>/dumppat.txt).
312
314 The dsr2html utility will attempt to load DICOM data dictionaries
315 specified in the DCMDICTPATH environment variable. By default, i.e. if
316 the DCMDICTPATH environment variable is not set, the file
317 <datadir>/dicom.dic will be loaded unless the dictionary is built into
318 the application (default for Windows).
319 The default behavior should be preferred and the DCMDICTPATH
321 environment variable only used when alternative data dictionaries are
322 required. The DCMDICTPATH environment variable has the same format as
323 the Unix shell PATH variable in that a colon (':') separates entries.
324 On Windows systems, a semicolon (';') is used as a separator. The data
325 dictionary code will attempt to load each file specified in the
326 DCMDICTPATH environment variable. It is an error if no data dictionary
327 can be loaded.
328
330 <datadir>/report.css - Sample Cascading Stylesheet file for HTML
331 <datadir>/reportx.css - Sample Cascading Stylesheet file for XHTML
332
334 dcmconv(1)
335
337 Copyright (C) 2000-2022 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
338 Germany.
339Version 3.6.7 Fri Apr 22 2022 dsr2html(1)