from_bioimg

bioimg.wrappers.from_bioimg(src, dest, converter=Converters.OMETIFF, *, verbose=False, exclude_metadata=None, tile_scale=1, **kwargs)

This function is a wrapper and serves as an all-inclusive API for encapsulating the ingestion of different file formats

Parameters

Name	Type	Description	Default
src	str	The source path for the file to be ingested .tiff, .zarr, *.svs etc..	required
dest	str	The destination path where the TileDB image will be stored	required
converter	Converters	The converter type to be used (tentative) soon automatically detected	Converters.OMETIFF
verbose	bool	verbose logging, defaults to False	False
exclude_metadata	Union[bool, Callable[[str], str], None]	An optional argument that specifies how to transform the original metadata. It can be one of the following: * A callable (function, method, etc.) that takes an OME-XML string and returns it as a string, while removing some of the original metadata and excluding them from being ingested. * A boolean value: * True: Indicates a specific built-in transformation should be applied. see: remove_ome_image_metadata * False: Indicates no transformation should be applied. * None: Indicates no transformation should be applied (same as False).	None
kwargs	Any	keyword arguments for custom ingestion behaviour	{}

Returns

Type	Description
Any	The converter class that was used for the ingestion