Metadata-Version: 2.1
Name: dcimg
Version: 0.6.0.post1
Summary: Python module to read Hamamatsu DCIMG files
Home-page: https://github.com/lens-biophotonics/dcimg
Author: Giacomo Mazzamuto
Author-email: mazzamuto@lens.unifi.it
License: MIT
Description: # dcimg
        
        This module provides the `DCIMGFile` class for accessing Hamamatsu DCIMG
        files.
        
        ## Installation
        ```bash
        pip install dcimg
        ```
        
        ## Documentation
        The `DCIMGFile` class provides an interface for reading 3D Hamamatsu DCIMG
        files.
        
        Usage is pretty straightforward. First of all, create a `DCIMGFile` object:
        
        ```python
        >>> my_file = DCIMGFile('input_file.dcimg')
        >>> my_file
            <DCIMGFile shape=2450x2048x2048 dtype=<class 'numpy.uint16'> file_name=input_file.dcimg>
        ```
        Image data can then be accessed using NumPy's basic indexing:
        
        ```python
        >>> my_file[-10, :5, :5]
        array([[101, 104, 100,  99,  89],
               [103, 102, 103,  99, 102],
               [101, 104,  99, 108,  98],
               [102, 111,  99, 111,  95],
               [103,  98,  99, 104, 106]], dtype=uint16)
        ```
        
        Other convenience methods for accessing image data are: `zslice`, `zslice_idx`,
        `frame` and `whole`.
        
        `DCIMGFile` supports context managers:
        ```python
        with DCIMGFile('input_file.dcimg') as f:
             a = f[800, ...]
        ```
        
        For further details refer to:
        https://lens-biophotonics.github.io/dcimg/
        
Keywords: dcimg image files hamamatsu
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: doc
