OFFIS DCMTK  Version 3.6.0
dcmpschk.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmpschk Checking tool for presentation states
5 \else
6 \page dcmpschk dcmpschk: Checking tool for presentation states
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmpschk [options] [dcmfile-in...]
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b dcmpschk utility checks DICOM Grayscale Softcopy Presentation State
18 objects for conformance with the standard. The test is performed in three
19 phases:
20 
21 \li Phase 1 checks the Meta-header of the DICOM file. It is tested whether
22  all required attributes are present, whether the SOP class and instance
23  UIDs match the UIDs in the main object and whether the group length
24  attribute contains a correct value. The Transfer Syntax of the Meta
25  header is also checked.
26 
27 \li Phase 2 performs a syntactic check of the values, value representations
28  and value multiplicities for each attribute in the object. The values
29  present in the object under test are compared with the definitions of the
30  DICOM data dictionary.
31 
32 \li Phase 3 performs a semantic check of the integrity of the Presentation
33  State. This phase is omitted when objects of other SOP Classes are
34  encountered. Phase 1 and 2 can also be applied to other DICOM objects of
35  arbitrary SOP class.
36  It should be noted that \b dcmpschk does not support Presentation States
37  which contain the Mask Module. These will be rejected with a message
38  that the Mask Module is not supported.
39 
40 \section parameters PARAMETERS
41 
42 \verbatim
43 dcmfile-in presentation state file(s) to be checked
44 \endverbatim
45 
46 \section options OPTIONS
47 
48 \subsection general_options general options
49 \verbatim
50  -h --help
51  print this help text and exit
52 
53  --version
54  print version information and exit
55 
56  --arguments
57  print expanded command line arguments
58 
59  -q --quiet
60  quiet mode, print no warnings and errors
61 
62  -v --verbose
63  verbose mode, print processing details
64 
65  -d --debug
66  debug mode, print debug information
67 
68  -ll --log-level [l]evel: string constant
69  (fatal, error, warn, info, debug, trace)
70  use level l for the logger
71 
72  -lc --log-config [f]ilename: string
73  use config file f for the logger
74 \endverbatim
75 
76 \section logging LOGGING
77 
78 The level of logging output of the various command line tools and underlying
79 libraries can be specified by the user. By default, only errors and warnings
80 are written to the standard error stream. Using option \e --verbose also
81 informational messages like processing details are reported. Option
82 \e --debug can be used to get more details on the internal activity, e.g. for
83 debugging purposes. Other logging levels can be selected using option
84 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
85 very severe error events, the application will usually terminate. For more
86 details on the different logging levels, see documentation of module "oflog".
87 
88 In case the logging output should be written to file (optionally with logfile
89 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
90 can be used. This configuration file also allows for directing only certain
91 messages to a particular output stream and for filtering certain messages
92 based on the module or application where they are generated. An example
93 configuration file is provided in <em><etcdir>/logger.cfg</em>).
94 
95 \section command_line COMMAND LINE
96 
97 All command line tools use the following notation for parameters: square
98 brackets enclose optional values (0-1), three trailing dots indicate that
99 multiple values are allowed (1-n), a combination of both means 0 to n values.
100 
101 Command line options are distinguished from parameters by a leading '+' or '-'
102 sign, respectively. Usually, order and position of command line options are
103 arbitrary (i.e. they can appear anywhere). However, if options are mutually
104 exclusive the rightmost appearance is used. This behaviour conforms to the
105 standard evaluation rules of common Unix shells.
106 
107 In addition, one or more command files can be specified using an '@' sign as a
108 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
109 is replaced by the content of the corresponding text file (multiple
110 whitespaces are treated as a single separator unless they appear between two
111 quotation marks) prior to any further evaluation. Please note that a command
112 file cannot contain another command file. This simple but effective approach
113 allows to summarize common combinations of options/parameters and avoids
114 longish and confusing command lines (an example is provided in file
115 <em><datadir>/dumppat.txt</em>).
116 
117 \section environment ENVIRONMENT
118 
119 The \b dcmpschk utility will attempt to load DICOM data dictionaries specified
120 in the \e DCMDICTPATH environment variable. By default, i.e. if the
121 \e DCMDICTPATH environment variable is not set, the file
122 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
123 into the application (default for Windows).
124 
125 The default behaviour should be preferred and the \e DCMDICTPATH environment
126 variable only used when alternative data dictionaries are required. The
127 \e DCMDICTPATH environment variable has the same format as the Unix shell
128 \e PATH variable in that a colon (":") separates entries. On Windows systems,
129 a semicolon (";") is used as a separator. The data dictionary code will
130 attempt to load each file specified in the \e DCMDICTPATH environment variable.
131 It is an error if no data dictionary can be loaded.
132 
133 \section copyright COPYRIGHT
134 
135 Copyright (C) 2000-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
136 
137 */


Generated on Sun Aug 23 2015 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.9.1