src.main.main_config

Functions

main_config_init([rootdir])

Initialize the main config (global variable VL3DCFG).

main_config_subdict_init(dirpath, subpath, ...)

Assist the main_config.main_config_init() method to load each subdictionary.

src.main.main_config.main_config_init(rootdir='')

Initialize the main config (global variable VL3DCFG). The main config defines the default values for many components in the framework. Some values are just defaults that can be overridden by JSON specifications (e.g., pipelines). Other values define the internal mechanics of the framework (e.g., what ratio of system memory must be occupied for the automatic mem-to-file proxy to be triggered).

Parameters:

rootdir (str) – Path to the directory where the vl3d.py script is located.

Returns:

Nothing.

src.main.main_config.main_config_subdict_init(dirpath, subpath, subkey)

Assist the main_config.main_config_init() method to load each subdictionary.

Parameters:
  • dirpath (str) – The path where the vl3d.py script is located.

  • subpath (str) – The path, relative to the vl3d.py script path, where the YAML config file is located.

  • subkey (str) – The key of the dictionary inside the main VL3DCFG dictionary.

Returns:

Nothing, but the VL3DCFG global dictionary is updated.