Skip to content
Snippets Groups Projects
README.md 1.69 KiB
Newer Older
  • Learn to ignore specific revisions
  • # QIM3D (Quantitative Imaging in 3D)
    
    fima's avatar
    fima committed
    
    
    `qim3D` is a Python library for quantitative imaging analysis in 3D. It provides functionality for handling data, as well as tools for visualization and analysis.
    
    This library contains the tools and functionalities of the QIM platform, accessible at https://qim.dk/platform
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ## Installation
    
    fima's avatar
    fima committed
    
    
    Install the latest stable version by using pip:
    
    fima's avatar
    fima committed
    
    
    ```bash
    
    pip install qim3d
    
    fima's avatar
    fima committed
    ```
    
    
    Or clone this repository for the most recent version.
    
    
    
    # Usage
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    Some basic funtionalites are descibred here. The full documentation is still under development.
    
    fima's avatar
    fima committed
    
    
    ## Loading Data
    To load image data from a file, use `qim.io.load()`
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ```python
    
    import qim3d
    
    fima's avatar
    fima committed
    
    
    # Load a file
    
    vol = qim3d.io.load("path/to/file.tif")
    
    fima's avatar
    fima committed
    
    
    # Load a file as a virtual stack
    
    vol = qim3d.io.load("path/to/file.tif", virtual_stack=True)
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ```
    
    fima's avatar
    fima committed
    
    
    ## Visualize data
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    You can easily check slices from your volume using `slice_viz`
    
    
    ```python
    import qim3d
    
    img = qim3d.examples.fly_150x256x256
    
    # By default shows the middle slice
    qim3d.viz.slice_viz(img)
    
    # Or we can specifly positions
    qim3d.viz.slice_viz(img, position=[0,32,128])
    
    # Parameters for size and colormap are also possible
    qim3d.viz.slice_viz(img, img_width=6, img_height=6, cmap="inferno")
    
    ```
    
    
    
    ## GUI Components
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    The library also provides GUI components for interactive data analysis and exploration. 
    
    The `qim3d.gui` module contains various classes for visualization and analysis:
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    ```python
    
    import qim3d
    
    fima's avatar
    fima committed
    
    
    app = qim3d.gui.iso3d.Interface()
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    app.launch()
    ```
    
    fima's avatar
    fima committed
    
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    # Contributing
    
    Felipe Delestro Matos's avatar
    Felipe Delestro Matos committed
    Contributions to `qim3d` 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.