SimBA CLI tools
- simba.utils.cli.cli_tools.blob_tracker(config_path)[source]
Method to access blob detection through CLI or notebook
Note
For an example blob detection config file, see https://github.com/sgoldenlab/simba/blob/master/misc/blob_definitions_ex.json.
- Parameters
config_path (Union[str, os.PathLike]) – Path to json file holding blob detection setting
- Returns
None. The blob detection data is saved at the location specified in the
config_path.- Return type
None
- Example
>>> blob_tracker('/Users/simon/Downloads/result_bg/blob_definitions.json')
- simba.utils.cli.cli_tools.feature_extraction_runner(config_path)[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, movement_criterion, location_criterion, aggregation, body_parts)[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, px_per_mm, fps, resolution)[source]
Helper to batch set the video_info.csv from CLI. Requires all videos to have the same pixels per millimeter, fps, and resolution.