4 \page dsrdump Dump DICOM SR file and data set
6 \page dsrdump dsrdump: Dump DICOM SR file and data set
9 \section synopsis SYNOPSIS
12 dsrdump [options] dsrfile-in...
15 \section description DESCRIPTION
17 The \b dsrdump utility dumps the contents of a DICOM Structured Reporting (SR)
18 document (file format or raw data set) to stdout in textual form. The output
19 of the document content follows the format proposed in David Clunie's book
20 "DICOM Structured Reporting" (PixelMed Publishing, 2000).
22 If \b dsrdump 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 dsrdump to read a dataset
28 with a particular transfer syntax.
30 \section parameters PARAMETERS
33 dsrfile-in DICOM SR input filename to be dumped
36 \section options OPTIONS
38 \subsection general_options general options
41 print this help text and exit
44 print version information and exit
47 print expanded command line arguments
50 quiet mode, print no warnings and errors
53 verbose mode, print processing details
56 debug mode, print debug information
58 -ll --log-level [l]evel: string constant
59 (fatal, error, warn, info, debug, trace)
60 use level l for the logger
62 -lc --log-config [f]ilename: string
63 use config file f for the logger
66 \subsection input_options input options
71 read file format or data set (default)
77 read data set without file meta information
79 input transfer syntax:
82 use TS recognition (default)
84 -td --read-xfer-detect
85 ignore TS specified in the file meta header
87 -te --read-xfer-little
88 read with explicit VR little endian TS
91 read with explicit VR big endian TS
93 -ti --read-xfer-implicit
94 read with implicit VR little endian TS
97 \subsection parsing_options parsing options
99 additional information:
101 -Ip --processing-details
102 show currently processed content item
106 -Er --unknown-relationship
107 accept unknown/missing relationship type
109 -Ec --ignore-constraints
110 ignore relationship content constraints
112 -Ee --ignore-item-errors
113 do not abort on content item errors, just warn
114 (e.g. missing value type specific attributes)
116 -Ei --skip-invalid-items
117 skip invalid content items (incl. sub-tree)
120 \subsection output_options output options
125 print header with filename for each document
127 -Ph --no-document-header
128 do not print general document information
130 +Pn --number-nested-items
131 print position string in front of each line
133 -Pn --indent-nested-items
134 indent nested items by spaces (default)
136 +Pl --print-long-values
137 print long item values completely
139 -Pl --shorten-long-values
140 print long item values shortened (default)
142 +Pu --print-instance-uid
143 print SOP instance UID of referenced objects
145 +Pc --print-all-codes
146 print all codes (incl. concept name codes)
148 +Pt --print-template-id
149 print template identification information
154 \subsection dicom_conformance DICOM Conformance
156 The \b dsrdump utility supports the following SOP Classes:
159 SpectaclePrescriptionReportStorage 1.2.840.10008.5.1.4.1.1.78.6
160 MacularGridThicknessAndVolumeReportStorage 1.2.840.10008.5.1.4.1.1.79.1
161 BasicTextSRStorage 1.2.840.10008.5.1.4.1.1.88.11
162 EnhancedSRStorage 1.2.840.10008.5.1.4.1.1.88.22
163 ComprehensiveSRStorage 1.2.840.10008.5.1.4.1.1.88.33
164 ProcedureLogStorage 1.2.840.10008.5.1.4.1.1.88.40
165 MammographyCADSRStorage 1.2.840.10008.5.1.4.1.1.88.50
166 KeyObjectSelectionDocumentStorage 1.2.840.10008.5.1.4.1.1.88.59
167 ChestCADSRStorage 1.2.840.10008.5.1.4.1.1.88.65
168 XRayRadiationDoseSRStorage 1.2.840.10008.5.1.4.1.1.88.67
169 ColonCADSRStorage 1.2.840.10008.5.1.4.1.1.88.69
170 ImplantationPlanSRDocumentStorage 1.2.840.10008.5.1.4.1.1.88.70
173 \section logging LOGGING
175 The level of logging output of the various command line tools and underlying
176 libraries can be specified by the user. By default, only errors and warnings
177 are written to the standard error stream. Using option \e --verbose also
178 informational messages like processing details are reported. Option
179 \e --debug can be used to get more details on the internal activity, e.g. for
180 debugging purposes. Other logging levels can be selected using option
181 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
182 very severe error events, the application will usually terminate. For more
183 details on the different logging levels, see documentation of module "oflog".
185 In case the logging output should be written to file (optionally with logfile
186 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
187 can be used. This configuration file also allows for directing only certain
188 messages to a particular output stream and for filtering certain messages
189 based on the module or application where they are generated. An example
190 configuration file is provided in <em><etcdir>/logger.cfg</em>).
192 \section command_line COMMAND LINE
194 All command line tools use the following notation for parameters: square
195 brackets enclose optional values (0-1), three trailing dots indicate that
196 multiple values are allowed (1-n), a combination of both means 0 to n values.
198 Command line options are distinguished from parameters by a leading '+' or '-'
199 sign, respectively. Usually, order and position of command line options are
200 arbitrary (i.e. they can appear anywhere). However, if options are mutually
201 exclusive the rightmost appearance is used. This behaviour conforms to the
202 standard evaluation rules of common Unix shells.
204 In addition, one or more command files can be specified using an '@' sign as a
205 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
206 is replaced by the content of the corresponding text file (multiple
207 whitespaces are treated as a single separator unless they appear between two
208 quotation marks) prior to any further evaluation. Please note that a command
209 file cannot contain another command file. This simple but effective approach
210 allows to summarize common combinations of options/parameters and avoids
211 longish and confusing command lines (an example is provided in file
212 <em><datadir>/dumppat.txt</em>).
214 \section environment ENVIRONMENT
216 The \b dsrdump utility will attempt to load DICOM data dictionaries specified
217 in the \e DCMDICTPATH environment variable. By default, i.e. if the
218 \e DCMDICTPATH environment variable is not set, the file
219 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
220 into the application (default for Windows).
222 The default behaviour should be preferred and the \e DCMDICTPATH environment
223 variable only used when alternative data dictionaries are required. The
224 \e DCMDICTPATH environment variable has the same format as the Unix shell
225 \e PATH variable in that a colon (":") separates entries. On Windows systems,
226 a semicolon (";") is used as a separator. The data dictionary code will
227 attempt to load each file specified in the \e DCMDICTPATH environment variable.
228 It is an error if no data dictionary can be loaded.
230 \section see_also SEE ALSO
234 \section copyright COPYRIGHT
236 Copyright (C) 2000-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.