OFFIS DCMTK  Version 3.6.0
dsrdump.man
1 /*!
2 
3 \if MANPAGES
4 \page dsrdump Dump DICOM SR file and data set
5 \else
6 \page dsrdump dsrdump: Dump DICOM SR file and data set
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dsrdump [options] dsrfile-in...
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
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).
21 
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.
29 
30 \section parameters PARAMETERS
31 
32 \verbatim
33 dsrfile-in DICOM SR input filename to be dumped
34 \endverbatim
35 
36 \section options OPTIONS
37 
38 \subsection general_options general options
39 \verbatim
40  -h --help
41  print this help text and exit
42 
43  --version
44  print version information and exit
45 
46  --arguments
47  print expanded command line arguments
48 
49  -q --quiet
50  quiet mode, print no warnings and errors
51 
52  -v --verbose
53  verbose mode, print processing details
54 
55  -d --debug
56  debug mode, print debug information
57 
58  -ll --log-level [l]evel: string constant
59  (fatal, error, warn, info, debug, trace)
60  use level l for the logger
61 
62  -lc --log-config [f]ilename: string
63  use config file f for the logger
64 \endverbatim
65 
66 \subsection input_options input options
67 \verbatim
68 input file format:
69 
70  +f --read-file
71  read file format or data set (default)
72 
73  +fo --read-file-only
74  read file format only
75 
76  -f --read-dataset
77  read data set without file meta information
78 
79 input transfer syntax:
80 
81  -t= --read-xfer-auto
82  use TS recognition (default)
83 
84  -td --read-xfer-detect
85  ignore TS specified in the file meta header
86 
87  -te --read-xfer-little
88  read with explicit VR little endian TS
89 
90  -tb --read-xfer-big
91  read with explicit VR big endian TS
92 
93  -ti --read-xfer-implicit
94  read with implicit VR little endian TS
95 \endverbatim
96 
97 \subsection parsing_options parsing options
98 \verbatim
99 additional information:
100 
101  -Ip --processing-details
102  show currently processed content item
103 
104 error handling:
105 
106  -Er --unknown-relationship
107  accept unknown/missing relationship type
108 
109  -Ec --ignore-constraints
110  ignore relationship content constraints
111 
112  -Ee --ignore-item-errors
113  do not abort on content item errors, just warn
114  (e.g. missing value type specific attributes)
115 
116  -Ei --skip-invalid-items
117  skip invalid content items (incl. sub-tree)
118 \endverbatim
119 
120 \subsection output_options output options
121 \verbatim
122 printing:
123 
124  +Pf --print-filename
125  print header with filename for each document
126 
127  -Ph --no-document-header
128  do not print general document information
129 
130  +Pn --number-nested-items
131  print position string in front of each line
132 
133  -Pn --indent-nested-items
134  indent nested items by spaces (default)
135 
136  +Pl --print-long-values
137  print long item values completely
138 
139  -Pl --shorten-long-values
140  print long item values shortened (default)
141 
142  +Pu --print-instance-uid
143  print SOP instance UID of referenced objects
144 
145  +Pc --print-all-codes
146  print all codes (incl. concept name codes)
147 
148  +Pt --print-template-id
149  print template identification information
150 \endverbatim
151 
152 \section notes NOTES
153 
154 \subsection dicom_conformance DICOM Conformance
155 
156 The \b dsrdump utility supports the following SOP Classes:
157 
158 \verbatim
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
171 \endverbatim
172 
173 \section logging LOGGING
174 
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".
184 
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>).
191 
192 \section command_line COMMAND LINE
193 
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.
197 
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.
203 
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>).
213 
214 \section environment ENVIRONMENT
215 
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).
221 
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.
229 
230 \section see_also SEE ALSO
231 
232 <b>dcmconv</b>(1)
233 
234 \section copyright COPYRIGHT
235 
236 Copyright (C) 2000-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
237 
238 */


Generated on Thu Aug 27 2015 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.9.1