Script Definition

The script definition can be based on the RunPmod script located in the Pmod3.9/Start folder from the installation directory. Create a copy of the RunPmod script, name it RunExamplePipeline and edit it as follows:

1. Make sure to add the switch PIPELINE or PIPELINE_NOGUI after the pmod.jar .

   When PIPELINE switch is used the script starts the Pipeline Processing with full interface and the PMOD is visible.

   With the PIPELINE_NOGUI switch the script starts the Pipeline Processing with output to console and the PMOD interface is NOT visible.

2. Provide the full path and name of the Pipeline imediately after the switch. Please note that the pipe processing definition files, *.procPipe , need to be located in the def folder.

   Make sure to use the slash / as a folder separator (NOT Windows backslash "\") for all systems.

The RunExamplePipeline script file may look like illustrated below:

D:

cd "D:\Pmod3.9"

rem external preprocessing: include input files in example.procPipe

.\java\jre\bin\java -Xmx8G -jar pmod.jar PIPELINE D:/Pmod3.9/data/pipe/def/example.procPipe

rem external cleanup: remove input files

The external preprocessing is referring to the external routine created by the user that populates input file entries in the Pipeline definition (.procPipe file)

The external cleanup is referring to the external routine defined by the user that removes processed input files from the in folder.

The following tags have to be updated in the Pipeline definition:

1. PIPE_FILE_NAME_<num> - Such entry defines one input image. The slash / has to be used as a folder separator.
2. NUMBER_OF_PIPE_FILES – It defines the number of entries for the pipe process. It typically coincides with the number of entries to be process: the highest value of <num>

An example is illustrated below:

PIPE_FILE_NAME_1=D\:/Pmod3.9/data/pipe/06371770//\:0

PIPE_FILE_NAME_2=D\:/Pmod3.9/data/pipe/41891912//\:0

PIPE_FILE_NAME_3=D\:/Pmod3.9/data/pipe/41884445//\:0

NUMBER_OF_PIPE_FILES=3

Note: A Pipeline template (example.procPipeTemplate) can be created from a Pipeline definition. This can be easily achieved by manually removing the PIPE_FILENAME_<num> and the NUMBER_OF_PIPE_FILES tags. Subsequently, an external routine can replace the Pipeline definition (example.procPipe) using the template content and appending the missing tags.

Execution Return Codes

There are a few return codes which can be defined to diagnose the execution:

1. EX_OK = 0 // Indicates successful termination of the processing.
2. EX_UNAVAILABLE = 69 // Indicates the service is unavailable: no license is available for the processing. Two situation can occur, depending on the defined switch: with the PIPELINE switch the standard license dialogs are available and PMOD is waiting the user action; with the PIPELINE_NOGUI switch the dialogs are missing and Pmod exits returning the code 69.
3. EX_CONFIG = 78 // Indicates a configuration error: the memory allocated to run Pmod is too low.