Metadata-Version: 2.1
Name: aicsimageio
Version: 3.0.2
Summary: Python library for reading and writing image data with special handlers for bio-formats from Allen Institute for Cell Science.
Home-page: https://github.com/AllenCellModeling/aicsimageio
Author: Allen Institute for Cell Science
Author-email: jacksonb@alleninstitute.org, bowdenm@spu.edu
License: BSD-3-Clause
Description: # AICSImageIO
        
        [![Build Status](https://github.com/AllenCellModeling/aicsimageio/workflows/Build%20Master/badge.svg)](https://github.com/AllenCellModeling/aicsimageio/actions)
        [![Code Coverage](https://codecov.io/gh/AllenCellModeling/aicsimageio/branch/master/graph/badge.svg)](https://codecov.io/gh/AllenCellModeling/aicsimageio)
        
        A Python library for reading and writing image data with specific support for handling bio-formats.
        
        ---
        
        ## Features
        * Supports reading metadata and imaging data from file path or buffered bytes for:
            * `CZI`
            * `OME-TIFF`
            * `TIFF`
            * Any additional format supported by `imageio`
        * Supports writing metadata and imaging data for:
            * `OME-TIFF`
            * `TIFF`
            * Any additional format supported by `imageio`
        
        ### Disclaimer:
        This package is under heavy revision in preparation for version 3.0.0 release. The quick start below is representative
        of how to interact with the package under 3.0.0 and not under the current stable release.
        
        ## Quick Start
        ```python
        from aicsimageio import AICSImage, imread
        
        # For numpy array of image data
        im = imread("/path/to/your/file_or_buffer.ome.tiff")
        
        # For AICSImage object that
        im = AICSImage("/path/to/your/file_or_buffer.ome.tiff")
        
        # To specify a known dimension order
        im = AICSImage("/path/to/your/file_or_buffer.ome.tiff", known_dims="SYX")
        
        # Image data is stored in `data` attribute
        im.data  # returns the image data numpy array
        
        # Image metadata is stored in `metadata` attribute
        im.metadata  # returns whichever metadata parser best suites the file format
        ```
        
        ## Notes
        * Image data numpy arrays are always returned as six dimensional in dimension order `STCZYX`
        or `Scene`, `Time`, `Channel`, `Z`, `Y`, and `X`.
        * Each file format may use a different metadata parser it is dependent on the reader's implementation.
        
        ## Installation
        **Stable Release:** `pip install aicsimageio`<br>
        **Development Head:** `pip install git+https://github.com/AllenCellModeling/aicsimageio.git`
        
        ## Development
        See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.
        
        ***Free software: BSD-3-Clause***
        
Keywords: aicsimageio,allen cell,imaging,computational biology
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: setup
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: all
Provides-Extra: interactive
