OFFIS DCMTK  Version 3.6.0
dcmdspfn.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmdspfn Export standard display curves to a text file
5 \else
6 \page dcmdspfn dcmdspfn: Export standard display curves to a text file
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmdspfn [options]
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 Command line program converts a DCMTK monitor / camera / printer / scanner
18 characteristics file to tabbed text file describing the characteristic curve
19 (CC), the display function and the post-standardized curve (PSC) for an 8 bit
20 display. The 256 values of each curve can be visualized by a common spread
21 sheet program. Above that the display curve (without CC and PSC) can also be
22 computed for a specified luminance/OD range (min/max) and a certain number of
23 Device Driving Levels (DDL).
24 
25 \section parameters PARAMETERS
26 
27 \verbatim
28 dcmfile-in DICOM input filename to be dumped
29 \endverbatim
30 
31 \section options OPTIONS
32 
33 \subsection general_options general options
34 \verbatim
35  -h --help
36  print this help text and exit
37 
38  --version
39  print version information and exit
40 
41  --arguments
42  print expanded command line arguments
43 
44  -q --quiet
45  quiet mode, print no warnings and errors
46 
47  -v --verbose
48  verbose mode, print processing details
49 
50  -d --debug
51  debug mode, print debug information
52 
53  -ll --log-level [l]evel: string constant
54  (fatal, error, warn, info, debug, trace)
55  use level l for the logger
56 
57  -lc --log-config [f]ilename: string
58  use config file f for the logger
59 \endverbatim
60 
61 \subsection input_options input options (mutually exclusive)
62 \verbatim
63  +Im --monitor-file [f]ilename: string
64  text file describing the monitor characteristics
65 
66  +Ic --camera-file [f]ilename: string
67  text file describing the camera characteristics
68 
69  +Ip --printer-file [f]ilename: string
70  text file describing the printer characteristics
71 
72  +Is --scanner-file [f]ilename: string
73  text file describing the scanner characteristics
74 
75  +Il --lum-range [m]in max: float
76  minimum and maximum luminance (cd/m^2)
77 
78  +Io --od-range [m]in max: float
79  minimum and maximum optical density (OD),
80  automatically converted to luminance
81 \endverbatim
82 
83 \subsection creation_options creation options
84 \verbatim
85  +Ca --ambient-light [a]mbient light: float
86  ambient light value (cd/m^2, default: file f)
87 
88  +Ci --illumination [i]llumination: float
89  illumination value (cd/m^2, default: file f)
90 
91  +Dn --min-density [m]inimum optical density: float
92  Dmin value (default: off, only with +Ip and +Io)
93 
94  +Dx --max-density [m]aximum optical density: float
95  Dmax value (default: off, only with +Ip and +Io)
96 
97  +Cd --ddl-count [n]umber of DDLs: integer
98  number of Device Driving Levels
99  (default: 256, only with --lum/od-range)
100 
101  +Cf --curve-fitting [n]umber: integer
102  use polynomial curve fitting algorithm with order n
103  (0..99, default: file setting or cubic spline)
104 \endverbatim
105 
106 \subsection output_options output options
107 \verbatim
108  +Og --gsdf [f]ilename: string
109  write GSDF curve data to file f
110 
111  +Oc --cielab [f]ilename: string
112  write CIELAB curve data to file f
113 \endverbatim
114 
115 \section notes NOTES
116 
117 The output file describing the CC, GSDF or CIELAB and PSC for an 8 bit display
118 system (monitor, camera, printer or scanner) is a simple text file. Lines
119 starting with a '#' are treated as comments and, therefore, skipped as well as
120 blank lines. An input file can for instance be created by the command line
121 tool \b dconvlum.
122 
123 The ambient light value possibly defined in the characteristics file is also
124 used for the calculation. In this case the value is part of the file comment
125 header as well as the number of DDL (device driving level) values, the
126 absolute luminance range (measured in candela per square meter) and the range
127 of the JND index (just noticable difference) in case of GSDF. Alternatively,
128 the ambient light value can be specified as a command line option. When
129 setting the two luminance values instead of reading a monitor characteristic
130 file as input the luminance range is linearly divided by the number of DDLs.
131 
132 For printers and scanners the illumination can be specified in addition to the
133 reflected ambient light (both in the characteristics file and on the command
134 line). The header of the output file includes the minimum and maximum Optical
135 Density (OD) instead of the luminance range. Please note that the OD values
136 in the input file have to be ordered in descending order (in contrast to the
137 luminance values used for monitors and cameras). The DDL value 0 always means
138 black (darkest value) and the maximum DDL value means white (brightest value,
139 clear film).
140 
141 The \e data folder contains sample characteristics file for monitors,
142 cameras, printers and scanners. See DICOM standard part 14 for more details
143 on display calibration and Barten's model (including GSDF).
144 
145 \section logging LOGGING
146 
147 The level of logging output of the various command line tools and underlying
148 libraries can be specified by the user. By default, only errors and warnings
149 are written to the standard error stream. Using option \e --verbose also
150 informational messages like processing details are reported. Option
151 \e --debug can be used to get more details on the internal activity, e.g. for
152 debugging purposes. Other logging levels can be selected using option
153 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
154 very severe error events, the application will usually terminate. For more
155 details on the different logging levels, see documentation of module "oflog".
156 
157 In case the logging output should be written to file (optionally with logfile
158 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
159 can be used. This configuration file also allows for directing only certain
160 messages to a particular output stream and for filtering certain messages
161 based on the module or application where they are generated. An example
162 configuration file is provided in <em><etcdir>/logger.cfg</em>).
163 
164 \section command_line COMMAND LINE
165 
166 All command line tools use the following notation for parameters: square
167 brackets enclose optional values (0-1), three trailing dots indicate that
168 multiple values are allowed (1-n), a combination of both means 0 to n values.
169 
170 Command line options are distinguished from parameters by a leading '+' or '-'
171 sign, respectively. Usually, order and position of command line options are
172 arbitrary (i.e. they can appear anywhere). However, if options are mutually
173 exclusive the rightmost appearance is used. This behaviour conforms to the
174 standard evaluation rules of common Unix shells.
175 
176 In addition, one or more command files can be specified using an '@' sign as a
177 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
178 is replaced by the content of the corresponding text file (multiple
179 whitespaces are treated as a single separator unless they appear between two
180 quotation marks) prior to any further evaluation. Please note that a command
181 file cannot contain another command file. This simple but effective approach
182 allows to summarize common combinations of options/parameters and avoids
183 longish and confusing command lines (an example is provided in file
184 <em><datadir>/dumppat.txt</em>).
185 
186 \section files FILES
187 
188 <em><datadir>/camera.lut</em> - sample characteristics file of a camera
189 \n<em><datadir>/monitor.lut</em> - sample characteristics file of a monitor
190 \n<em><datadir>/printer.lut</em> - sample characteristics file of a printer
191 \n<em><datadir>/scanner.lut</em> - sample characteristics file of a scanner
192 
193 \section see_also SEE ALSO
194 
195 <b>dconvlum</b>(1), <b>dcod2lum</b>(1)
196 
197 \section copyright COPYRIGHT
198 
199 Copyright (C) 1999-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
200 
201 */


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