Skip to main content

MRI Brain Tumor Diagnosis and Grad-CAM Visualization

Project description

Neuroflux

Neuroflux is a Python package that analyzes MRI scans of brains and highlights regions of tumor damage on a heat map.

Installation

To install neuroflux, you can use pip:

pip install neuroflux

The recommended importation is:

from neuroflux import (
    prepare_model,
    display_slice,
    display_grid,
)

Setup

To begin, declare the following variables:

  • case_folder: The folder where the input MRI scans are located (set it to "" if the input files are in the same folder as the program)
  • input_flair: The file name of the input FLAIR
  • input_t1ce: The file name of the input T1ce
  • model_weights: The file name of the predefined model weights

Example setup:

case_folder = "BraTS20"
input_flair = "01_flair.nii"
input_t1ce = "01_t1ce.nii"
model_weights = "model_.weights.h5"

Usage

Neuroflux has three main functions:

  • prepare_model(model_weights, img_size=128)
    • Creates the U-Net (first step)
  • display_slice(folder, input_flair, input_t1ce, slice_num, model, target_layer_name="conv2d_1", img_size=128)
    • Displays the Grad-CAM heat map at a given slice number
  • display_grid(folder, input_flair, input_t1ce, model, num_slices=84, rows=7, cols=12, start_slice=20, target_layer_name="conv2d_1")
    • Displays a grid containing a given number of slices beginning at a given slice number

Example usage:

model = prepare_model(model_weights=model_weights, img_size=img_size)
display_slice(folder=case_folder, input_flair=input_flair, input_t1ce=input_t1ce, slice_num=77, model=model)
display_grid(folder=case_folder,input_flair=input_flair, input_t1ce=input_t1ce, model=model)

Notes

  • The model weights are not built into this package. Our GitHub contains two options to attain model weights: Use our pre-trained weights (recommend) or run the Google Colab notebook to create your own unique weights
  • To get more involved, see our website, read our research paper, or contact us at neurofluxai@gmail.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neuroflux-2.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neuroflux-2.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file neuroflux-2.0.tar.gz.

File metadata

  • Download URL: neuroflux-2.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for neuroflux-2.0.tar.gz
Algorithm Hash digest
SHA256 06465d52b7561b9d7766ab70603a109c3e747dda9cac3f3312f986425a6837d3
MD5 d7cfe0971c4adf7add6e316d9116d3e8
BLAKE2b-256 29cb2a747fecdeab7dedeb983251bf7b4992b32232165c96cfc436015ef45f7a

See more details on using hashes here.

File details

Details for the file neuroflux-2.0-py3-none-any.whl.

File metadata

  • Download URL: neuroflux-2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for neuroflux-2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39ccb183ba8e60c81ca74f908d6f970316acb8cdf52d6e9f286986a3038d114d
MD5 6f56d6937253e88f2cd174180e5eaa68
BLAKE2b-256 f5c968df5f48e468ff3cd866ec865806d13ff47eb48b572cfec098dd5871f75d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page