Metadata-Version: 2.1
Name: scanimage-tiff-reader
Version: 1.4.1.3
Summary: A fast (big)tiff reader that provides access to ScanImage-specific metadata.
Author: Nathan Clack
Maintainer-email: Lawrence Niu <lawrence@mbfbioscience.com>, Nelson Downs <nelson@mbfbioscience.com>, MBF Support <support@mbfbioscience.com>
License: Copyright (C) 2023 MBF Bioscience
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
          http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Project-URL: repository, https://gitlab.com/vidriotech/scanimagetiffreader-python
Project-URL: documentation, https://vidriotech.gitlab.io/scanimagetiffreader-python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Topic :: Scientific/Engineering
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy

.. image:: https://gitlab.com/vidriotech/scanimagetiffreader-python/badges/master/pipeline.svg
   :target: https://gitlab.com/vidriotech/scanimagetiffreader-python/commits/master
   :alt: Pipeline status

.. image:: https://gitlab.com/vidriotech/scanimagetiffreader-python/badges/master/coverage.svg
   :target: https://gitlab.com/vidriotech/scanimagetiffreader-python/commits/master
   :alt: Coverage

About
=====

For more information see the documentation_.

The ScanImageTiffReader reads data from Tiff_ and BigTiff_ files recorded 
using ScanImage_.  It was written with performance in mind and provides access 
to ScanImage-specific metadata. It is also available for Matlab_, Julia_ and C_.
There's also a `command line interface`_. This library should actually work with 
most tiff files, but as of now we don't support compressed or tiled data.

The library is pip-installable for 64-bit Windows, OS X, or Linux.  We test 
against python 3.6 and python 2.7.14.

Both ScanImage_ and this reader are products of `Vidrio Technologies`_.  If you
have questions or need support feel free to `submit an issue`_ or `contact us`_.

.. _documentation: https://vidriotech.gitlab.io/scanimagetiffreader-python/
.. _Tiff: https://en.wikipedia.org/wiki/Tagged_Image_File_Format
.. _BigTiff: http://bigtiff.org/
.. _ScanImage: http://scanimage.org
.. _scanimage.org: http://scanimage.org
.. _Matlab: https://vidriotech.gitlab.io/scanimagetiffreader-matlab
.. _Julia: https://vidriotech.gitlab.io/scanimagetiffreader-julia
.. _`Vidrio Technologies`: http://vidriotechnologies.com/
.. _`contact us`: https://vidriotechnologies.com/contact-support/
.. _`submit an issue`: https://gitlab.com/vidriotech/scanimagetiffreader-python/issues
.. _C: https://vidriotech.gitlab.io/scanimage-tiff-reader
.. _`command line interface`: https://vidriotech.gitlab.io/scanimage-tiff-reader

Examples
========

Python
``````

.. code-block:: python

    from ScanImageTiffReader import ScanImageTiffReader
    vol=ScanImageTiffReader("my.tif").data();
