diplomat.core_ops.track_with

diplomat.core_ops.track_with(config: List[PathLike | str] | PathLike | str, videos: List[PathLike | str] | PathLike | str | None = None, frame_stores: List[PathLike | str] | PathLike | str | None = None, num_outputs: int | None = None, predictor: str | None = None, predictor_settings: Dict[str, Any] | None = None, help_extra: bool = False, **extra_args) → None[source]

Run DIPLOMAT tracking on videos and/or frame stores. Automatically select a frontend based on the passed arguments. Allows for selecting a specific tracker, or predictor.

Parameters:

  • config – The path to the configuration file for the project. The format of this argument will depend on the frontend.

  • videos – A single path or list of paths to video files to run analysis on.

  • frame_stores – A single path or list of paths to frame store files to run analysis on.

  • num_outputs – An integer, the number of bodies to track in the video. Defaults to 1.

  • predictor – An optional string, specifying the predictor plugin to make predictions with. You can get a list of all available predictors and descriptions using the “diplomat predictors list” command or “diplomat.list_predictor_plugins” function.

  • predictor_settings – An optional dictionary, listing the settings to use for the specified predictor plugin instead of the defaults. If not specified, the frontend will determine the settings in a frontend specific manner. To see the settings a predictor plugin supports, use the “diplomat predictors list_settings” command or “diplomat.get_predictor_settings” function. To get more information about how a frontend gets settings if not passed, set the help_extra parameter to True to print additional settings for the selected frontend instead of running tracking.

  • help_extra – Boolean, if set to true print extra settings for the automatically selected frontend instead of running tracking.

  • extra_args – Any additional arguments (if the CLI, flags starting with ‘–’) are passed to the automatically selected frontend. To see valid values, run track with extra_help flag set to true.