usage

Usage documentation

NOTE: To run the application without any problems it is necessary to run it always with admin rights sudo.

Execution Modes

The processing chain deliveres two different modes:

• Full
• Single
• Continous

Further more it is possible to run the application in a dry state.

Full Mode

The full mode will execute all steps until the step is reached which is given as calling argument. It can be called via the following syntax:

python [<CHAIN_PATH>]chain.py <STEP_IDENTIFICATION>

This command will then execute all steps which have to be executed before the step <STEP_IDENTIFICATION> and this step itself, according to the chain's step order.

Single Mode

The single mode will only execute the step given as the calling argument. It can be called via the following syntax:

python [<CHAIN_PATH>]chain.py <STEP_IDENTIFICATION> -s

or

python [<CHAIN_PATH>]chain.py <STEP_IDENTIFICATION> --single_run

This command will then execute only the step with the id <STEP_IDENTIFICATION>.

NOTE: In this case the user has to ensure by himself to execute this step with valid prepared data in the source folders for the appropriate steps.

Dry State

For debugging and similiar purposes it is possible to execute the chain in single and in full mode drily. For this purpose there has only a -d-flag to be added to the command's syntax:

python [<CHAIN_PATH>]chain.py <STEP_IDENTIFICATION> -d

or

python [<CHAIN_PATH>]chain.py <STEP_IDENTIFICATION> --dry_run

Continuous mode

The continuous mode can be used to set a fixed starting point in the chain and to run the residual chain from this point til the chain's end. This can be doen by the following syntax:

python [<CHAIN_PATH>]chain.py <STEP_IDENTIFICATION> -c

or

python [<CHAIN_PATH>]chain.py <STEP_IDENTIFICATION> --cont

Filters

The tool chain delivers the opportunity to apply filters in the process. Filters can be applied by the following options:

-f <FILTERS>

or

--filter <FILTERS>

The syntax for <FILTERS> is the following:

<FILTERS> := filter_key1=filter_value1 filter_key2=filter_value2 ... filter_keyN=filter_valueN

Logging

The tools started by the processing chain perform a lot of outputs. If you want to store them, you can use a special log option (-l). If this option is set, each executed tool in the chain is able to log the outputs of the externally used tools in separate folders, located in the current working directory (set with the -p option). Note that this option does not log the chain's own output. For this purpose you have to still use the common > method.

The option is applicated in the following way:

-l

or

--log

Path Settings

The tool is able to work on different results, therefore a nice feature has been integrated which makes it able to switch the path wherefrom the videos should be generated.

-p <PATH>

or

--path <PATH>

will set a path wherein the complete required folder structure has to be setup. In this <PATH>, when set up, the chain will operate then.