OFFIS DCMTK  Version 3.6.0
dcmmkcrv.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmmkcrv Add 2D curve data to image
5 \else
6 \page dcmmkcrv dcmmkcrv: Add 2D curve data to image
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmmkcrv [options] dcmfile-in curvedata-in dcmfile-out
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b dcmmkcrv utility allows to create DICOM images containing curve data.
18 Since curve data is hardly used by vendors today, this is intended as a
19 means to test implementations that can read curve data. The utility reads an
20 existing DICOM image and a text file containing the curve data in textual
21 form. A DICOM curve data repeating group is created according to the
22 options specified on the command line, added to the existing image and
23 written back to file. The output file is encoded with the same transfer
24 syntax used for the input file. This utility only supports the creation of
25 two-dimensional curves.
26 
27 \section parameters PARAMETERS
28 
29 \verbatim
30 dcmfile-in DICOM input image file
31 
32 curvedata-in curve data input file (text)
33 
34 dcmfile-out DICOM output filename
35 \endverbatim
36 
37 \section options OPTIONS
38 
39 \subsection general_options general options
40 
41 \verbatim
42  -h --help
43  print this help text and exit
44 
45  --version
46  print version information and exit
47 
48  --arguments
49  print expanded command line arguments
50 
51  -q --quiet
52  quiet mode, print no warnings and errors
53 
54  -v --verbose
55  verbose mode, print processing details
56 
57  -d --debug
58  debug mode, print debug information
59 
60  -ll --log-level [l]evel: string constant
61  (fatal, error, warn, info, debug, trace)
62  use level l for the logger
63 
64  -lc --log-config [f]ilename: string
65  use config file f for the logger
66 \endverbatim
67 
68 \subsection curve_creation_options curve creation options
69 
70 \verbatim
71 curve type:
72 
73  -r --poly
74  create as POLY curve (default)
75 
76  +r --roi
77  create as ROI curve
78 
79 curve value representation:
80 
81  +v --data-vr [n]umber: integer 0..4 (default: 4)
82  select curve data VR: 0=US, 1=SS, 2=FL, 3=FD, 4=SL
83 
84  -c --curve-vr [n]umber: integer 0..2 (default: 0)
85  select VR with which the Curve Data element is written
86  0=VR according to --data-vr, 1=OB, 2=OW
87 
88 repeating group:
89 
90  -g --group [n]umber: integer 0..15 (default: 0)
91  select repeating group: 0=0x5000, 1=0x5002 etc.
92 
93 curve description:
94 
95  -l --label s: string
96  set Curve Label to s (default: absent)
97 
98  +d --description s: string
99  set Curve Description to s (default: absent)
100 
101  -a --axis x: string, y: string
102  set Axis Units to x\y (default: absent)
103 \endverbatim
104 
105 \section notes NOTES
106 
107 \subsection syntax_data_file Syntax of the Curve Data File
108 
109 The curve data file is expected to be a plain ASCII text file containing
110 numbers (integer or floating point) comprising the values of the point
111 coordinates. Numbers must be separated by whitespace. No checking of the
112 value range or value range conversion is performed. Example:
113 
114 \verbatim
115  256.451947 1.000000
116  477.689863 128.822080
117  128.822080 477.689863
118  35.310137 128.822080
119  256.451947 1.000000
120 \endverbatim
121 
122 \section logging LOGGING
123 
124 The level of logging output of the various command line tools and underlying
125 libraries can be specified by the user. By default, only errors and warnings
126 are written to the standard error stream. Using option \e --verbose also
127 informational messages like processing details are reported. Option
128 \e --debug can be used to get more details on the internal activity, e.g. for
129 debugging purposes. Other logging levels can be selected using option
130 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
131 very severe error events, the application will usually terminate. For more
132 details on the different logging levels, see documentation of module "oflog".
133 
134 In case the logging output should be written to file (optionally with logfile
135 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
136 can be used. This configuration file also allows for directing only certain
137 messages to a particular output stream and for filtering certain messages
138 based on the module or application where they are generated. An example
139 configuration file is provided in <em><etcdir>/logger.cfg</em>).
140 
141 \section command_line COMMAND LINE
142 
143 All command line tools use the following notation for parameters: square
144 brackets enclose optional values (0-1), three trailing dots indicate that
145 multiple values are allowed (1-n), a combination of both means 0 to n values.
146 
147 Command line options are distinguished from parameters by a leading '+' or '-'
148 sign, respectively. Usually, order and position of command line options are
149 arbitrary (i.e. they can appear anywhere). However, if options are mutually
150 exclusive the rightmost appearance is used. This behaviour conforms to the
151 standard evaluation rules of common Unix shells.
152 
153 In addition, one or more command files can be specified using an '@' sign as a
154 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
155 is replaced by the content of the corresponding text file (multiple
156 whitespaces are treated as a single separator unless they appear between two
157 quotation marks) prior to any further evaluation. Please note that a command
158 file cannot contain another command file. This simple but effective approach
159 allows to summarize common combinations of options/parameters and avoids
160 longish and confusing command lines (an example is provided in file
161 <em><datadir>/dumppat.txt</em>).
162 
163 \section environment ENVIRONMENT
164 
165 The \b dcmmkcrv utility will attempt to load DICOM data dictionaries specified
166 in the \e DCMDICTPATH environment variable. By default, i.e. if the
167 \e DCMDICTPATH environment variable is not set, the file
168 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
169 into the application (default for Windows).
170 
171 The default behaviour should be preferred and the \e DCMDICTPATH environment
172 variable only used when alternative data dictionaries are required. The
173 \e DCMDICTPATH environment variable has the same format as the Unix shell
174 \e PATH variable in that a colon (":") separates entries. On Windows systems,
175 a semicolon (";") is used as a separator. The data dictionary code will
176 attempt to load each file specified in the \e DCMDICTPATH environment variable.
177 It is an error if no data dictionary can be loaded.
178 
179 \section copyright COPYRIGHT
180 
181 Copyright (C) 1998-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
182 
183 */


Generated on Wed Dec 28 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.8