Providers

class pado.images.providers.ImageProviderStore(version=1, store_type=StoreType.IMAGE)[source]: stores the image provider in a single file with metadata

class pado.images.providers.BaseImageProvider(*args, **kwds)[source]: base class for image providers

class pado.images.providers.ImageProvider(provider=None, *, identifier=None)[source]

items()[source]

Return type:: PadoItemsView[ImageId, Image]

class pado.images.providers.GroupedImageProvider(*providers)[source]

items()[source]

Return type:: PadoItemsView[ImageId, Image]

class pado.images.providers.FilteredImageProvider(provider, *, valid_keys=None)[source]

items()[source]

Return type:: PadoItemsView[ImageId, Image]

class pado.images.providers.LocallyCachedImageProvider(provider=None, *, identifier=None, cache_cls=<class 'fsspec.implementations.cached.WholeFileCacheFileSystem'>, **cache_kwargs)[source]

image provider that prepends a fsspec CachingFileSystem

use to route a normal ImageProvider through a local cache

items()[source]

Return type:: PadoItemsView[ImageId, Image]

pado.images.providers.image_is_cached_or_local(image)[source]

check if an image can be accessed locally

Return type:: bool

pado.images.providers.image_cached_percentage(image)[source]

return how much of an image is currently cached

Return type:: float

pado.images.providers.update_image_provider_urlpaths(search_urlpath, search_glob, *, provider, inplace=False, ignore_ambiguous=False, progress=False, provider_cls=<class 'pado.images.providers.ImageProvider'>, storage_options=None)[source]

search a path and re-associate image urlpaths by filename

Return type:: ImageProvider

pado.images.providers.copy_image(provider, image_id, dest, *, update_provider=True, progress=False, chunk_size=1048576, **update_kwargs)[source]

copy image data to a new location

Return type:: None