Metadata-Version: 2.1
Name: explore_lif
Version: 0.1.0
Summary: A Python module for loading lif file as numpy array
Home-page: https://github.com/yangyushi/explore_lif
Author: Yushi Yang
Author-email: yangyushi1992@icloud.com
License: UNKNOWN
Description: # explore_lif
        
        Load 3D confocal images from `lif` files as `numpy` arrays.
        
        ## Install
        
        - The most convenient way would be: `pip install -e .` from the directory where you have cloned or downloaded the code.
        - You can also Include the file `explore_lif` in your project directory
        
        ## How to Use It
        
        ```python
        from explore_lif import Reader
        
        reader = Reader('lif_file.lif')
        series = reader.getSeries()
        chosen = series[0]  # choose first image in the lif file
        # get a numpy array corresponding to the 1st time point & 1st channel
        # the shape is (z, y, x)
        image = chosen.getFrame(T=0, channel=0)
        ```
        
        ## Version Issue
        
        The current code (version >= 3.1) returns the data in the order of `Z-Y-X`. ([ce240f6](https://github.com/MathieuLeocmach/read_lif/commit/ce240f66fc5c9f42b25cdfec0ea7bd62506b8628))
        
        This is DIFFERENT from previous version, where the data is returned as `X-Y-Z`
        
Platform: UNKNOWN
Requires-Python: >=2.5
Description-Content-Type: text/markdown
