simba.utils.cli package

SimBA CLI tools

simba.utils.cli.cli_tools.feature_extraction_runner(config_path: Union[str, PathLike]) → None[source]

Helper to run feature extraction from CLI.

Parameters

config_path – Path to SimBA project config file in ini format.

simba.utils.cli.cli_tools.set_outlier_correction_criteria_cli(config_path: Union[str, PathLike], movement_criterion: float, location_criterion: float, aggregation: typing_extensions.Literal['mean', 'median'], body_parts: dict)[source]

Helper to set outlier settings in a SimBA project_config.ini from command line

simba.utils.cli.cli_tools.set_video_parameters(config_path: Union[str, PathLike], px_per_mm: float, fps: float, resolution: Tuple[int, int]) → None[source]

Helper to batch set the video_info.csv from CLI. Requires all videos to have the same pixels per millimeter, fps, and resolution.

Parameters

  • config_path (str) – Path to SimBA project config file in ini format.

  • px_per_mm (float) – Pixels per millimeter in all the video files.

  • fps (int) – FPS of the video files.

  • resolution (tuple) – Resolution of the video files.