flame.io.flame_paths_from_ids

flame.io.flame_paths_from_ids(root_dir: str, index_path: str, id_list: List[int], pd_sep: str = ',', id_col: str = 'id', path_col: str = 'image', tile_data_ext: str = 'tileData.txt', accept_missing: bool = False) → List[str][source]

Description: Will look for flame images based on their unique IDs given a root directory and a table matching IDs to filepaths.

Args:

  • root_dir (str): a path to the root directory when all images will be searched for

  • index_path (str): a path to the table (DataFrame-like) matching unique image ids to relative image paths

  • id_list (list[int]): single image id or list of image ids

  • pd_sep (str): the separation character that Pandas should use to parse ‘index_path’ into a DataFrame. DEFAULT=’,’

  • id_col (str): the name of the column storing image ids. DEFAULT=’id’

  • path_col (str): the name of the column storing relative image paths. DEFAULT=’image’

  • tile_data_ext (str): the extension used to search for every image’s associated tileData JSON. DEFAULT=’tileData.txt’

  • accept_missing (bool): whether to skip missing ids or raise an error when they are encountered. DEFAULT=False