4 \page dsr2html Render DICOM SR file and data set to HTML/XHTML
6 \page dsr2html dsr2html: Render DICOM SR file and data set to HTML/XHTML
9 \section synopsis SYNOPSIS
12 dsr2html [options] dsrfile-in [htmlfile-out]
15 \section description DESCRIPTION
17 The \b dsr2html utility renders the contents of a DICOM Structured Reporting
18 (SR) document (file format or raw data set) to HTML (Hyper Text Markup
19 Language) version 3.2 or 4.01 as well as to XHTML (Extensible Hyper Text Markup
20 Language) version 1.1.
22 If \b dsr2html reads a raw data set (DICOM data without a file format
23 meta-header) it will attempt to guess the transfer syntax by examining the
24 first few bytes of the file. It is not always possible to correctly guess the
25 transfer syntax and it is better to convert a data set to a file format
26 whenever possible (using the \b dcmconv utility). It is also possible to use
27 the \e -f and <em>-t[ieb]</em> options to force \b dsr2html to read a dataset
28 with a particular transfer syntax.
30 \section parameters PARAMETERS
33 dsrfile-in DICOM SR input filename to be rendered
35 htmlfile-out HTML/XHTML output filename (default: stdout)
38 \section options OPTIONS
40 \subsection general_options general options
43 print this help text and exit
46 print version information and exit
49 print expanded command line arguments
52 quiet mode, print no warnings and errors
55 verbose mode, print processing details
58 debug mode, print debug information
60 -ll --log-level [l]evel: string constant
61 (fatal, error, warn, info, debug, trace)
62 use level l for the logger
64 -lc --log-config [f]ilename: string
65 use config file f for the logger
68 \subsection input_options input options
73 read file format or data set (default)
79 read data set without file meta information
81 input transfer syntax:
84 use TS recognition (default)
86 -td --read-xfer-detect
87 ignore TS specified in the file meta header
89 -te --read-xfer-little
90 read with explicit VR little endian TS
93 read with explicit VR big endian TS
95 -ti --read-xfer-implicit
96 read with implicit VR little endian TS
99 \subsection parsing_options parsing options
101 additional information:
103 -Ip --processing-details
104 show currently processed content item
108 -Er --unknown-relationship
109 accept unknown/missing relationship type
111 -Ec --ignore-constraints
112 ignore relationship content constraints
114 -Ee --ignore-item-errors
115 do not abort on content item errors, just warn
116 (e.g. missing value type specific attributes)
118 -Ei --skip-invalid-items
119 skip invalid content items (incl. sub-tree)
123 +Cr --charset-require
124 require declaration of extended charset (default)
126 +Ca --charset-assume [c]harset: string constant
127 (latin-1 to -5, greek, cyrillic, arabic, hebrew)
128 assume c if undeclared extended charset found
131 \subsection output_options output options
133 HTML/XHTML compatibility:
136 use only HTML version 3.2 compatible features
139 allow all HTML version 4.01 features (default)
142 comply with XHTML version 1.1 specification
144 +Hd --add-document-type
145 add reference to SGML document type definition
147 cascading style sheet (CSS), not with HTML 3.2:
149 +Sr --css-reference URL: string
150 add reference to specified CSS to document
152 +Sf --css-file [f]ilename: string
153 embed content of specified CSS into document
158 expand short content items inline (default)
160 -Ri --never-expand-inline
161 never expand content items inline
163 +Ra --always-expand-inline
164 always expand content items inline
166 +Rd --render-full-data
167 render full data of content items
169 +Rt --section-title-inline
170 render section titles inline, not separately
174 +Dt --document-type-title
175 use document type as document title (default)
177 +Dp --patient-info-title
178 use patient information as document title
180 -Dh --no-document-header
181 do not render general document information
185 +Ci --render-inline-codes
186 render codes in continuous text blocks
188 +Cn --concept-name-codes
189 render code of concept names
191 +Cu --numeric-unit-codes
192 render code of numeric measurement units
194 +Cv --code-value-unit
195 use code value as measurement unit (default)
197 +Cm --code-meaning-unit
198 use code meaning as measurement unit
200 +Cc --render-all-codes
201 render all codes (implies +Ci, +Cn and +Cu)
203 +Ct --code-details-tooltip
204 render code details as a tooltip (implies +Cc)
209 \subsection dicom_conformance DICOM Conformance
211 The \b dsr2html utility supports the following SOP Classes:
214 SpectaclePrescriptionReportStorage 1.2.840.10008.5.1.4.1.1.78.6
215 MacularGridThicknessAndVolumeReportStorage 1.2.840.10008.5.1.4.1.1.79.1
216 BasicTextSRStorage 1.2.840.10008.5.1.4.1.1.88.11
217 EnhancedSRStorage 1.2.840.10008.5.1.4.1.1.88.22
218 ComprehensiveSRStorage 1.2.840.10008.5.1.4.1.1.88.33
219 ProcedureLogStorage 1.2.840.10008.5.1.4.1.1.88.40
220 MammographyCADSRStorage 1.2.840.10008.5.1.4.1.1.88.50
221 KeyObjectSelectionDocumentStorage 1.2.840.10008.5.1.4.1.1.88.59
222 ChestCADSRStorage 1.2.840.10008.5.1.4.1.1.88.65
223 XRayRadiationDoseSRStorage 1.2.840.10008.5.1.4.1.1.88.67
224 ColonCADSRStorage 1.2.840.10008.5.1.4.1.1.88.69
225 ImplantationPlanSRDocumentStorage 1.2.840.10008.5.1.4.1.1.88.70
228 \section logging LOGGING
230 The level of logging output of the various command line tools and underlying
231 libraries can be specified by the user. By default, only errors and warnings
232 are written to the standard error stream. Using option \e --verbose also
233 informational messages like processing details are reported. Option
234 \e --debug can be used to get more details on the internal activity, e.g. for
235 debugging purposes. Other logging levels can be selected using option
236 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
237 very severe error events, the application will usually terminate. For more
238 details on the different logging levels, see documentation of module "oflog".
240 In case the logging output should be written to file (optionally with logfile
241 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
242 can be used. This configuration file also allows for directing only certain
243 messages to a particular output stream and for filtering certain messages
244 based on the module or application where they are generated. An example
245 configuration file is provided in <em><etcdir>/logger.cfg</em>).
247 \section command_line COMMAND LINE
249 All command line tools use the following notation for parameters: square
250 brackets enclose optional values (0-1), three trailing dots indicate that
251 multiple values are allowed (1-n), a combination of both means 0 to n values.
253 Command line options are distinguished from parameters by a leading '+' or '-'
254 sign, respectively. Usually, order and position of command line options are
255 arbitrary (i.e. they can appear anywhere). However, if options are mutually
256 exclusive the rightmost appearance is used. This behaviour conforms to the
257 standard evaluation rules of common Unix shells.
259 In addition, one or more command files can be specified using an '@' sign as a
260 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
261 is replaced by the content of the corresponding text file (multiple
262 whitespaces are treated as a single separator unless they appear between two
263 quotation marks) prior to any further evaluation. Please note that a command
264 file cannot contain another command file. This simple but effective approach
265 allows to summarize common combinations of options/parameters and avoids
266 longish and confusing command lines (an example is provided in file
267 <em><datadir>/dumppat.txt</em>).
269 \section environment ENVIRONMENT
271 The \b dsr2html utility will attempt to load DICOM data dictionaries specified
272 in the \e DCMDICTPATH environment variable. By default, i.e. if the
273 \e DCMDICTPATH environment variable is not set, the file
274 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
275 into the application (default for Windows).
277 The default behaviour should be preferred and the \e DCMDICTPATH environment
278 variable only used when alternative data dictionaries are required. The
279 \e DCMDICTPATH environment variable has the same format as the Unix shell
280 \e PATH variable in that a colon (":") separates entries. On Windows systems,
281 a semicolon (";") is used as a separator. The data dictionary code will
282 attempt to load each file specified in the \e DCMDICTPATH environment variable.
283 It is an error if no data dictionary can be loaded.
287 <em><datadir>/report.css</em> - Sample Cascading Stylesheet file for HTML
288 <em><datadir>/reportx.css</em> - Sample Cascading Stylesheet file for XHTML
290 \section see_also SEE ALSO
294 \section copyright COPYRIGHT
296 Copyright (C) 2000-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.