bioio_conversion.converters.BatchConverter

class bioio_conversion.converters.BatchConverter(*, converter_key: str = 'ome-zarr', default_opts: Dict[str, Any] | None = None)[source]

BatchConverter orchestrates bulk conversions of image files using a specified converter backend.

Supports three input modes:
  • CSV-driven: each row defines a conversion job

  • Directory-driven: scan up to max_depth for matching files

  • List-driven: explicit list of file paths

Default parameters for all jobs may be provided via default_opts.

__init__(*, converter_key: str = 'ome-zarr', default_opts: Dict[str, Any] | None = None)[source]

Initialize the BatchConverter.

Parameters:
converter_keystr

Key to select the converter backend (must exist in _CONVERTERS).

default_optsdict, optional

Shared default options for each job (e.g. destination, tbatch, overwrite).

Methods

__init__(*[, converter_key, default_opts])

Initialize the BatchConverter.

from_csv(csv_path)

Parse a CSV file into a list of job option dicts.

from_directory(directory, *[, max_depth, ...])

Recursively find files matching pattern up to max_depth levels.

from_list(paths)

Build jobs from an explicit list of file paths.

run_jobs(jobs)

Execute each job: must include 'source'; merges defaults and job params.