1dcmp2pgm(1)                       OFFIS DCMTK                      dcmp2pgm(1)
2
3
4

NAME

6       dcmp2pgm - Read DICOM image and presentation state and render bitmap
7

SYNOPSIS

9       dcmp2pgm [options] dcmimage-in [bitmap-out]
10

DESCRIPTION

12       The dcmp2pgm utility renders a monochrome DICOM image under the control
13       of a grayscale softcopy presentation state  object  into  a  monochrome
14       bitmap with 8 bits/pixel. The bitmap is stored either as 'Portable Gray
15       Map' (PGM) or  as  a  DICOM  secondary  capture  image  object.  If  no
16       presentation  state  is read from file, a default presentation state is
17       created. The utility  allows  to  read  a  configuration  file  of  the
18       Softcopy  Presentation  State  Viewer  upon  startup. In this case, the
19       settings from the configuration file affecting  the  rendering  of  the
20       presentation  state are used, e.g. a correction of the gray scale range
21       according to Barten's model (DICOM part 14) can  be  performed  if  the
22       characteristic  curve of the display system is available and defined in
23       the configuration file.
24

PARAMETERS

26       dcmimage-in  input DICOM image
27
28       bitmap-out   output DICOM image or PGM bitmap
29

OPTIONS

31   general options
32         -h   --help
33                print this help text and exit
34
35              --version
36                print version information and exit
37
38              --arguments
39                print expanded command line arguments
40
41         -q   --quiet
42                quiet mode, print no warnings and errors
43
44         -v   --verbose
45                verbose mode, print processing details
46
47         -d   --debug
48                debug mode, print debug information
49
50         -ll  --log-level  [l]evel: string constant
51                (fatal, error, warn, info, debug, trace)
52                use level l for the logger
53
54         -lc  --log-config  [f]ilename: string
55                use config file f for the logger
56
57   processing options
58         -p   --pstate  [f]ilename: string
59                process using presentation state file
60
61         -c   --config  [f]ilename: string
62                process using settings from configuration file
63
64         -f   --frame  [f]rame: integer
65                process using image frame f (default: 1)
66
67   output format
68         -D   --pgm
69                save image as PGM (default)
70
71         +D   --dicom
72                save image as DICOM secondary capture
73
74   output options
75         +S   --save-pstate  [f]ilename: string
76                save presentation state to file
77

LOGGING

79       The level of logging output of  the  various  command  line  tools  and
80       underlying  libraries  can  be  specified by the user. By default, only
81       errors and warnings are written to the  standard  error  stream.  Using
82       option  --verbose  also  informational messages like processing details
83       are reported. Option --debug can be used to get  more  details  on  the
84       internal  activity,  e.g.  for debugging purposes. Other logging levels
85       can be selected using option --log-level. In --quiet  mode  only  fatal
86       errors  are reported. In such very severe error events, the application
87       will usually terminate. For  more  details  on  the  different  logging
88       levels, see documentation of module 'oflog'.
89
90       In  case  the logging output should be written to file (optionally with
91       logfile rotation), to syslog (Unix) or the event log  (Windows)  option
92       --log-config  can  be  used.  This  configuration  file also allows for
93       directing only certain messages to a particular output stream  and  for
94       filtering  certain  messages  based  on the module or application where
95       they are generated.  An  example  configuration  file  is  provided  in
96       <etcdir>/logger.cfg).
97

COMMAND LINE

99       All  command  line  tools  use  the  following notation for parameters:
100       square brackets enclose optional  values  (0-1),  three  trailing  dots
101       indicate  that multiple values are allowed (1-n), a combination of both
102       means 0 to n values.
103
104       Command line options are distinguished from parameters by a leading '+'
105       or  '-' sign, respectively. Usually, order and position of command line
106       options are arbitrary (i.e. they  can  appear  anywhere).  However,  if
107       options  are  mutually exclusive the rightmost appearance is used. This
108       behaviour conforms to the standard  evaluation  rules  of  common  Unix
109       shells.
110
111       In  addition,  one  or more command files can be specified using an '@'
112       sign as a prefix to the filename (e.g. @command.txt).  Such  a  command
113       argument  is  replaced  by  the  content of the corresponding text file
114       (multiple whitespaces are treated as a  single  separator  unless  they
115       appear  between  two  quotation marks) prior to any further evaluation.
116       Please note that a command file cannot contain  another  command  file.
117       This   simple   but  effective  approach  allows  to  summarize  common
118       combinations of options/parameters and  avoids  longish  and  confusing
119       command lines (an example is provided in file <datadir>/dumppat.txt).
120

ENVIRONMENT

122       The  dcmp2pgm  utility  will  attempt  to  load DICOM data dictionaries
123       specified in the DCMDICTPATH environment variable. By default, i.e.  if
124       the   DCMDICTPATH   environment   variable   is   not   set,  the  file
125       <datadir>/dicom.dic will be loaded unless the dictionary is built  into
126       the application (default for Windows).
127
128       The   default   behaviour  should  be  preferred  and  the  DCMDICTPATH
129       environment variable only used when alternative data  dictionaries  are
130       required.  The  DCMDICTPATH environment variable has the same format as
131       the Unix shell PATH variable in that a colon (':')  separates  entries.
132       On  Windows systems, a semicolon (';') is used as a separator. The data
133       dictionary code will  attempt  to  load  each  file  specified  in  the
134       DCMDICTPATH  environment variable. It is an error if no data dictionary
135       can be loaded.
136

FILES

138       <etcdir>/dcmpstat.cfg - sample configuration file
139
141       Copyright (C) 1998-2010 by OFFIS e.V., Escherweg  2,  26121  Oldenburg,
142       Germany.
143
144
145
146Version 3.6.0                     6 Jan 2011                       dcmp2pgm(1)
Impressum