Skip to content
Snippets Groups Projects
README.md 1.16 KiB
Newer Older
  • Learn to ignore specific revisions
  • Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    # QIM (Quantitative Imaging Library)
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    QIM is a Python library for quantitative imaging analysis. It provides functionality for loading and saving image data, as well as tools for visualization and analysis.
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ## Features
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    - Load image data from TIFF and HDF5 files.
    - GUI components for interactive data exploration.
    - Tools for performing quantitative analysis on image data.
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ## Installation
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    QIM can be installed using pip:
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ```shell
    pip install qim
    
    fima's avatar
    fima committed
    ```
    
    ## Usage
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ### Loading Data
    To load image data from a file, use the qim.io.load() function:
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ```python
    import qim
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    # Load a TIFF file
    data = qim.io.load("path/to/file.tif")
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    # Load a TIFF file as a virtual stack
    data = qim.io.load("path/to/file.tif", virtual_stack=True)
    ```
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ### GUI Components
    QIM provides GUI components for interactive data exploration. The qim.gui module contains various classes for visualization and analysis:
    ```python
    import qim
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    app = qim.gui.iso3d.Interface()
    app.launch()
    ```
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    # Contributing
    Contributions to QIM are welcome! If you find a bug, have a feature request, or would like to contribute code, please open an issue or submit a pull request.
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    # License
    This project is licensed under the MIT License.