 | Attention! On macOS, command line parameters are not supported. |
| | Attention! On macOS, command line parameters are not supported. |
If the DICOM Viewer has already been launched on the computer, the command line parameters will be sent to the program that has been launched. The program will not be launched again (see Launch multiple instances of the program).
Launching the program from the command line allows you to set specific parameters for the current session of the program, change the settings and get help information about the command line options. To launch the DICOM Viewer use the following syntax on the command line:
[<path_to_the_program>]< executable_program> [ --help] | [--study-folder <path> [--open-series-images | --open-series-mpr | --open-series-volume | --open-series-endoscopy [--series-uid <uid> | --series-index <index>]]] | [--pacs-aetitle <aetitle> [--patient-id <patientID>] [--study-uid <studyUID>] [--series-index <seriesIndex> | --series-uid <seriesUID>] [--open-series-images] ] | [--aet <aet>] | [--import-settings <path> [--use-imported-listener-aetitle | --aet <aet>] [--update-scu-aetitle]] | [--export-settings <path>]
--help: display the help information about the command line options, exit the program.
--study-folder <path>: display the study (studies) contained in the specified folder. The following startup parameters apply:
--patient-id <patientID>: show the study with the specified patientID. Parameter has higher priority than --study-uid
--open-series-images: display the first series in the flat image view window
--open-series-mpr: display the first series in the multiplanar reconstruction window
--open-series-volume: display the first series in the volume reconstruction window
--open-series-endoscopy(PRO): display the first series in the virtual endoscopy window
Any of these parameters can be used with the following parameters:
--study-uid "<studyUID 1> \…\<studyUID N>": open the first series from each of the selected studies on the list with the respective studyUID
--series-uid "<seriesUID 1> \…\<seriesUID N>": open series from the list with the respective seriesUID
--series-index "<seriesIndex 1> \…\<seriesIndex N>": open series from the list with the respective seriesIndex. The seriesIndex parameter numeration starts with zero and depends on the current type of sorting series in the study
--pacs-aetitle <aetitle>: attempt to open study list from PACSServer which AE Title matches the specified AE Title. For connection, the parameters provided in the connection settings for the particular server are used (see Section 13.2). The following options can be used with this option in different combinations:
--patient-id <patientID>: show the study with the specified patientID. Parameter has higher priority than --study-uid
--study-uid "<studyUID 1> \…\<studyUID N>": on the list of studies, search for the studies with the respective studyUID
--series-uid "<seriesUID 1> \…\<seriesUID N>": for the selected studies, choose the series with the respective seriesUID
--series-index "<seriesIndex 1> \…\<seriesIndex N>": for the selected studies, choose the series with the respective seriesIndex. The seriesIndex parameter numeration starts with zero and depends on the current type of sorting series in the study
--open-series-images: display the selected series in the flat image view window. If a series is not selected, the first one of the first study is used
The list of parameters’ values is provided in one line with "\" separator. The list of study-uid and series-uid parameters is composed as follows: the first parameter value from the study-uid list is matched by the first parameter value from the series-uid list, the second parameter value from the study-uid list is matched by the second parameter value from the series-uid list, etc. If one of the lists contains fewer values than the other one, empty values are added. Empty values can only be provided in the beginning and in the middle of the list.
| | Attention! The list of parameter values must not be ended with the "\" separator. |
The same correlation exists between study-uid and series-index parameters. The values from the series-uid list have a higher priority than the values from the series-index list. If the value of the series-uid parameter is not empty, the respective value of the series-index parameter is ignored. Below, you can see an example of transmission of study-uid, series-uid and series-index parameters’ lists to a console command:
C:\Users\user\DICOMViewerPro2.16.0\viewer.exe --study-folder D:\dicom_data --study-uid "\<studyUID 2> \<studyUID 3> \<studyUID 4>"--series-uid "<seriesUID 1> \\<seriesUID 3>"--series-index "<seriesIndex 1> \<seriesIndex 2>"
| | On Linux, you must use "\\" instead of "\". |
In this case, the above example will have the form of:
C:\Users\user\DICOMViewerPro2.16.0\viewer.exe --study-folder D:\dicom_data --study-uid
"\\<studyUID 2>\\<studyUID 3>\\<studyUID 4>"--series-uid "<seriesUID 1>\\\\<seriesUID
3>"--series-index "<seriesIndex 1>\\<seriesIndex 2>"
In this example, four pairs of series-uid and/or series-index parameters’ values identifying series are transmitted. They are matched by study-uid parameters’ values. Let’s consider each pair of values from the example.
study_uid = "", series_uid = <seriesUID 1>
study_uid = <studyUID 2>, series_index = <seriesIndex 2>
study_uid = <studyUID 3>, series_uid = <seriesUID 3>
study_uid = <studyUID 4>, series_index = 0
If the series-uid and/or series-index index parameter value is empty (the fourth pair of values in the example), the first study series is chosen (series_index = 0). ). If a series from the study is selected by the value of the series-index parameter, the current type of sorting series in the study is taken into account.
If an empty study-uid value is transmitted, then:
with commands for opening series from the catalogue:
the value is ignored if the respective series-uid value is not empty. Search for studies on the list is performed by the series-uid;
if the respective study-uid is not provided, the series-uid for the first study found on the list is used;
with commands for opening series from the PACS server:
the study-uid for the first study found on the list is always used.
| | Attention! If some AE Titles of several PACSServers match, then data will be searched on the first PACSServer on the list. PACSServers are sorted by the "Server nickname" field. |
For details on how to set up connection to PACSServer, see Section 13.2.
The length of AE Title value shall not exceed 16 characters. Cyrillic letters and "\" symbols in AE titles are not allowed.
The following options are used to change the settings. After executing any of these commands, the program exits. In case of a successful execution, the word Done appears on the command line.
--aet <aetitle>: parameter AE Title for DICOM Listener is set to <aetitle>
--import-settings <file>: imports settings from <file>
--use-imported-listener-aetitle: parameter AE Title for DICOM Listener is set to value from <file>
if the option --aet <aetitle> is used at the same time then AE Title for DICOM Listener is set to <aetitle>
--update-scu-aetitle: Client name (SCU) for PACS Servers of the DICOM Listener will remain the current
if the option --aet <aetitle> is used at the same time then Client name (SCU) for PACS Servers is set to <aetitle>
--export-settings <file>: exports settings to <file>.