Module: io._plugins

skimage.io._plugins.available([loaded]) List available plugins.
skimage.io._plugins.call(kind, *args, **kwargs) Find the appropriate plugin of ‘kind’ and execute it.
skimage.io._plugins.configuration() Return the currently preferred plugin order.
skimage.io._plugins.info(plugin) Return plugin meta-data.
skimage.io._plugins.reset_plugins() Clear the plugin state to the default, i.e., where no plugins are loaded
skimage.io._plugins.use(name[, kind]) Set the default plugin for a specified operation.

available

skimage.io._plugins.available(loaded=False)

List available plugins.

Parameters:

loaded : bool

If True, show only those plugins currently loaded. By default, all plugins are shown.

Returns:

p : dict

Dictionary with plugin names as keys and exposed functions as values.

call

skimage.io._plugins.call(kind, *args, **kwargs)

Find the appropriate plugin of ‘kind’ and execute it.

Parameters:

kind : {‘imshow’, ‘imsave’, ‘imread’, ‘imread_collection’}

Function to look up.

plugin : str, optional

Plugin to load. Defaults to None, in which case the first matching plugin is used.

*args, **kwargs : arguments and keyword arguments

Passed to the plugin function.

configuration

skimage.io._plugins.configuration()

Return the currently preferred plugin order.

Returns:

p : dict

Dictionary of preferred plugin order, with function name as key and plugins (in order of preference) as value.

info

skimage.io._plugins.info(plugin)

Return plugin meta-data.

Parameters:

plugin : str

Name of plugin.

Returns:

m : dict

Meta data as specified in plugin .ini.

reset_plugins

skimage.io._plugins.reset_plugins()

Clear the plugin state to the default, i.e., where no plugins are loaded

use

skimage.io._plugins.use(name, kind=None)

Set the default plugin for a specified operation. The plugin will be loaded if it hasn’t been already.

Parameters:

name : str

Name of plugin.

kind : {‘imsave’, ‘imread’, ‘imshow’, ‘imread_collection’}, optional

Set the plugin for this function. By default, the plugin is set for all functions.

See also

plugins
List of available plugins

Examples

Use the Python Imaging Library to read images:

>>> from skimage.io import use_plugin
>>> use_plugin('pil', 'imread')