nav.navigate_image_files

navigate_image_files(obs_class: type[ObsSnapshotInst], image_files: ImageFiles, nav_results_root: FCPath, *, nav_models: list[str] | None = None, nav_techniques: list[str] | None = None, write_output_files: bool = True, log_arguments: Namespace | None = None) → tuple[bool, dict[str, Any]]

Navigate a set of image files.

Parameters:

• obs_class – The observation snapshot class.

• image_files – The image files to navigate.

• nav_results_root – The directory to write the navigation results to; may be a FileCache URL.

• nav_models – The models to use for navigation; or None if all models are to be used.

• nav_techniques – The techniques to use for navigation; or None if all techniques are to be used.

• write_output_files – Whether to write output files. False performs the navigation as a dry run but doesn’t write any results.

• log_arguments – Parsed CLI arguments used to resolve the image log file level. If None, the config default (INFO) is used.

Returns:

A tuple containing a boolean indicating success or failure and a dictionary containing the public metadata for the navigation.