Skip to content

FUSION-Navigator visualization of spatially resolved molecular data in histology images.

License

Notifications You must be signed in to change notification settings

spborder/FUSION

Repository files navigation

LinkedIn


Logo Lab-Logo

FUSION (Functional Unit State Identification in WSIs)

AI-driven visualization and quantification of spatial OMICS

Table of Contents
  1. About The Project
  2. Contributing
  3. License
  4. Contact

About The Project


Screenshot

FUSION

FUSION is an interactive interface to view spatial transcriptomics data integrated with histopathology. This is driven by artificial intelligence (AI). AI segments Functional Tissue Units (FTU) and links these with gene expression data that informs on major and minor healthy and injured cell types directly mapped on histological features in the WSI.

(back to top)

Built With

In collaboration with:

(back to top)

Running from source:

Step 1: Digital Slide Archive (DSA)

FUSION is run in conjunction with a running instance of Digital Slide Archive (DSA). For more information on how to initialize DSA, see here.

Create a user "fusionguest" either through the UI tools or through the included WebAPI.

Step 2: FUSION Set Up

  • Start by cloning the Github repo:
$ gh repo clone spborder/FUSION 
  • Create a virtual environment and install packages in requirements.txt
$(venv_name) ~/ python -m pip install -r requirements.txt
  • Assign environment variables corresponding to the URL of your desired DSA instance and the username and password for your fusionguest account.

Windows

$(venv_name) ~/ $Env:DSA_USER="fusionguest"
$(venv_name) ~/ $Env:DSA_PWORD="guestpassword"
$(venv_name) ~/ $Env:DSA_URL="http://dsa_url:8080/api/v1" 

Linux

$(venv_name) ~/ export DSA_USER="fusionguest"
$(venv_name) ~/ export DSA_PWORD="guestpassword"
$(venv_name) ~/ export DSA_URL="http://dsa_url:8080/api/v1"
  • Add the recommended plugins to your DSA instance. Note: This must be done using login for an admin-privileged account.
$(venv_name) ~/ python install_plugins.py
  • Now you're good to go! Start up FUSION by running the main script:
$(venv_name) ~/ python FUSION_Main.py

Then open a browser to http://localhost:8000 to view the running instance.

Running from Docker:

See the included Dockerfile (Dockerfile.dockerfile) and modify as needed to point to your preferred instance of DSA.

Release History:

  • 05/02/2024:

    Major updates:

    • Progress bars (in a dcc.Modal component) indicating when annotations are currently being processed.

    • Annotations are cached locally for increased performance. Annotations which have a last-accessed date more than 1 day old are removed.

    • New threads are started for loading and scaling GeoJSON annotations.

    • Multiple filters can now be added for removing structures outside of specified ranges (e.g. Show structures with cell type 1 > 50% and cell type 2 < 10%)

    • Added Annotation Station tab for logged-in users.

      • Allows users who are signed in to make intra-structural annotations using plotly figure annotations. Annotation masks are saved in OME-TIFF format with one channel for each class. Text annotations are saved as metadata for images.
      • Users can create an annotation session and preset annotation classes (and colors), labels, and users (still need to update how annotation sessions are shared with other users).
      • Roadmap: add annotation helpers (Segment Anything Model, other annotation fillers), allow annotation session admins to train segmentation models, active-learning approaches, etc.
    • CODEX visualization enabled:

      • Overlay different channels with user-specified colors
      • Dynamically extract frame-level histograms, plotting frame-level mean values for annotated structures (DeepCell plugin used for nuclei segmentation and feature extraction), UMAP for multiple channels included
      • Roadmap: Run clustering algorithms on generated plots, applying labels to nuclei based on clustering and manual annotation of UMAP clusters, recording cell type labeling rationale for reproducibility

      Minor updates

    • Adding sub-navigation clickable components on the Welcome page documentation.

    • Changing login popover component so that it closes when anywhere else in the window is clicked.

    • Adding a dcc.Loading component on the Login and Create Account buttons indicating that login information is being communicated to the server.

License

Distributed under the MIT License. See LICENSE for more information.

“©Copyright 2023 University of Florida Research Foundation, Inc. All Rights Reserved.”

(back to top)

Contact

Sam Border - Samuel.Border@medicine.ufl.edu Pinaki Sarder (PI) - pinaki.sarder@ufl.edu

(back to top)

About

FUSION-Navigator visualization of spatially resolved molecular data in histology images.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published