Metadata-Version: 2.1
Name: napari-mat-images
Version: 0.1.2
Summary: A plugin to load images stored in .mat files with napari
Home-page: https://github.com/hectormz/napari-mat-images
Author: Hector Munoz
Author-email: hectormz.git@gmail.com
Maintainer: Hector Munoz
Maintainer-email: hectormz.git@gmail.com
License: BSD-3
Description: =================
        napari-mat-images
        =================
        
        .. image:: https://img.shields.io/pypi/v/napari-mat-images.svg
            :target: https://pypi.org/project/napari-mat-images
            :alt: PyPI version
        
        .. image:: https://img.shields.io/pypi/pyversions/napari-mat-images.svg
            :target: https://pypi.org/project/napari-mat-images
            :alt: Python versions
        
        .. image:: https://dev.azure.com/hectormz-1/napari-mat-images/_apis/build/status/hectormz.napari-mat-images?branchName=master
            :target: https://dev.azure.com/hectormz-1/napari-mat-images/_build/latest?definitionId=1&branchName=master
            :alt: See Build Status on Azure Pipelines
        
        Features
        --------
        
        This plugin loads variables stored in ``MATLAB`` ``.mat`` files into `napari`_.
        
        It loads any variable that looks like an image.
        Presently, that includes any array with more than two dimensions with size greater than 20 pixels (determined by ``shape_is_image()``).
        
        If loading a variable with 3 or more dimensions, the plugin assumes that it is a stack of images, and the dimension with greatest size is the axis of the stack.
        
        
        Loading Large Files
        ===================
        
        If loading a large `.mat` file saved in ``HDF5``/``v7.3`` format, chunks of the images are loaded as needed, resulting in fast initial load, but potentially slower scrolling.
        
        Slices of the image stacks are randomly sampled to determine min/max contrast values.
        
        
        Requirements
        ------------
        
        This plugin relies on `scipy` to load small ``.mat`` files and ``h5py`` (with ``dask``) to load larger ``HDF5``/``v7.3`` ``.mat`` files.
        
        It implicitly requires ``napari`` for use.
        
        
        Installation
        ------------
        
        ``napari-mat-images`` requires `napari`_ to be installed, although it is not listed as a requirement for installation.
        This plugin relies on plugin functionality found in ``napari`` version > ``0.2.12``.
        This can be installed via `pip`_ from `PyPI`_::
        
            $ pip install napari>0.2.12
        
        You can install ``napari-mat-images`` via `pip`_ from `PyPI`_::
        
            $ pip install napari-mat-images
        
        
        Usage
        -----
        
        Once installed, the plugin will be used whenever trying to load a ``.mat`` file.
        This can be done from the ``napari`` GUI or commandline::
        
            $ napari my_file.mat
        
        Contributing
        ------------
        Contributions are very welcome. Tests can be run with `pytest`_, please ensure
        the coverage at least stays the same before you submit a pull request.
        
        License
        -------
        
        Distributed under the terms of the `BSD-3`_ license,
        ``napari-mat-images`` is free and open source software
        
        
        Issues
        ------
        
        If you encounter any problems, please `file an issue`_ along with a detailed description.
        
        ----
        
        This `napari`_ plugin was generated with `Cookiecutter`_ along with `napari`_'s `cookiecutter-napari-plugin`_ template.
        
        .. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
        .. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
        .. _`cookiecutter-napari-plugin`: https://github.com/napari/cookiecutter-napari-plugin
        .. _`file an issue`: https://github.com/hectormz/napari-mat-images/issues
        .. _`napari`: https://github.com/napari/napari
        .. _`pytest`: https://docs.pytest.org/en/latest/
        .. _`pip`: https://pypi.org/project/pip/
        .. _`PyPI`: https://pypi.org/project
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Framework :: napari
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
