dbregimg(1)

NAME

dbregimg - Register a DICOM image file in an image database index file

SYNOPSIS

dbregimg [options] index-out [dcmimg-in...]

DESCRIPTION

The dbregimg ulility registers DICOM image files in the database index file used by the imagectn and ti applications. No image files are copied. dbregimg can also list the contents of the database index file.

PARAMETERS

index-out  storage area for the index file (directory)
dcmimg-in  DICOM image file to be registered in the index file

OPTIONS

  -h  --help
        print this help text and exit
      --version
        print version information and exit
  -v  --verbose
        verbose mode, print processing details
  -d  --debug
        debug mode, print debug information
  -p  --print
        list contents of database index file
  -n  --not-new
        set instance reviewed status to 'not new'

NOTES

dbregimg attempts to add a reference to the database index file for each image-file provided on the command line.

dbregimg disables the database back-end quota system so that no image files will be deleted.

COMMAND LINE

All command line tools use the following notation for parameters: square brackets enclose optional values (0-1), three trailing dots indicate that multiple values are allowed (1-n), a combination of both means 0 to n values.

Command line options are distinguished from parameters by a leading '+' or '-' sign, respectively. Usually, order and position of command line options are arbitrary (i.e. they can appear anywhere). However, if options are mutually exclusive the rightmost appearance is used. This behaviour conforms to the standard evaluation rules of common Unix shells.

In addition, one or more command files can be specified using an '@' sign as a prefix to the filename (e.g. @command.txt). Such a command argument is replaced by the content of the corresponding text file (multiple whitespaces are treated as a single separator) prior to any further evaluation. Please note that a command file cannot contain another command file. This simple but effective approach allows to summarize common combinations of options/parameters and avoids longish and confusing command lines (an example is provided in file share/data/dumppat.txt).

ENVIRONMENT

The dbregimg utility will attempt to load DICOM data dictionaries specified in the DCMDICTPATH environment variable. By default, i.e. if the DCMDICTPATH environment variable is not set, the file <PREFIX>/lib/dicom.dic will be loaded unless the dictionary is built into the application (default for Windows).

The default behaviour should be preferred and the DCMDICTPATH environment variable only used when alternative data dictionaries are required. The DCMDICTPATH environment variable has the same format as the Unix shell PATH variable in that a colon (':') separates entries. The data dictionary code will attempt to load each file specified in the DCMDICTPATH environment variable. It is an error if no data dictionary can be loaded.