Skip to content

Commit

Permalink
Update plugins doc page
Browse files Browse the repository at this point in the history
  • Loading branch information
OrkoHunter committed Jan 20, 2016
1 parent 9050a52 commit 116b737
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions doc/source/user_guide/plugins.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,25 @@ Any plugin in the ``_plugins`` directory is automatically examined by
system::

>>> import skimage.io as io
>>> io.plugins()
{'gtk': ['imshow'],
'matplotlib': ['imshow', 'imsave'],
'pil': ['imread'],
'qt': ['imshow'],
'test': ['imsave', 'imshow', 'imread']}
>>> io.find_available_plugins()
{'fits': ['imread', 'imread_collection'],
'freeimage': ['imread', 'imsave', 'imread_collection'],
'gdal': ['imread', 'imread_collection'],
'gtk': ['imshow'],
'imageio': ['imread', 'imsave', 'imread_collection'],
'imread': ['imread', 'imsave', 'imread_collection'],
'matplotlib': ['imshow', 'imread', 'imread_collection'],
'pil': ['imread', 'imsave', 'imread_collection'],
'qt': ['imshow', 'imsave', 'imread', 'imread_collection'],
'simpleitk': ['imread', 'imsave', 'imread_collection'],
'test': ['imsave', 'imshow', 'imread', 'imread_collection'],
'tifffile': ['imread', 'imsave', 'imread_collection']}

or only those already loaded::

>>> io.plugins(loaded=True)
{'pil': ['imread']}
>>> io.find_available_plugins(loaded=True)
{'matplotlib': ['imshow', 'imread', 'imread_collection'],
'pil': ['imread', 'imsave', 'imread_collection']}

A plugin is loaded using the ``use_plugin`` command::

Expand All @@ -78,7 +86,7 @@ last plugin loaded is used.
To query a plugin's capabilities, use ``plugin_info``::

>>> io.plugin_info('pil')
>>>
>>>
{'description': 'Image reading via the Python Imaging Library',
'provides': 'imread'}
'provides': 'imread, imsave'}

0 comments on commit 116b737

Please sign in to comment.