spine.ana.factories

Construct an analysis script module class from its name.

Functions

ana_script_factory(name, cfg[, overwrite, ...])

Instantiates an analyzer module from a configuration dictionary.
spine.ana.factories.ana_script_factory(name, cfg, overwrite=None, log_dir=None, prefix=None, buffer_size=1)[source]

Instantiates an analyzer module from a configuration dictionary.

Parameters:

  • name (str) – Name of the analyzer module

  • cfg (dict) – Analysis script module configuration

  • parent_path (str) – Path to the parent directory of the main analysis configuration. This allows for the use of relative paths in the analyzers.

  • overwrite (bool, optional) – If True, overwrite the CSV logs if they already exist

  • log_dir (str, optional) – Output CSV file directory (shared with driver log)

  • prefix (str, optional) – Input file prefix. If requested, it will be used to prefix all the output CSV files.

  • buffer_size (int, default 1) – CSV file buffer size for analysis outputs

Returns:

Initialized analyzer object

Return type:

object