Code Monkey home page Code Monkey logo

slicercoloc-z-stats's Introduction

SlicerColoc-Z (ver. 1.0): A Z-Stack signal colocalization extension tool for 3D Slicer

Overview

SlicerColoc-Z-Stats is a 3D Slicer extension for computing 3D proteins' colocalization (spatial overlap between different channels) of Z-stack images.

Users can set the volume rendering of the Z-stack input image via customizable thresholds within 3D viewports, select the region of interest (ROI) by the bounding box and generate a Venn diagram that displays colocalization metrics.

The license for this extension is [MIT] (https://github.com/benoukraflab/SlicerColoc-Z-Stats/blob/main/LICENSE)

Installation

  • The 3D Slicer stable version 5.0.2 is needed to use this module: version Version 5.0.2. Or it can be downloaded from this link
  • This is a Python scripted module. Download the source code from here.
  • Extract downloaded package (for example, to C:\Users\Public).
  • Run 3D Slicer, search for the 'Extension Wizard' extension in the 'Modules' search box at the top and open it. Then click the 'Select Extension' button located under the 'Extension Tools' collapsible button.
  • Select the path of this module to import it to Slicer(for example, C:\Users\Public\SlicerColoc-Z-Stats-main).

Brief Tutorial

  • Start 3D Slicer
  • Switch the scene view to '3D only'
  • Load a TIFF image: Click the 'Data' button or the 'Add Data' button under the 'File' tab, and click the 'Choose File(s) to Add' button to load the image.
  • Switch to "ColocZStats" module. The TIFF file will appear as grayscale image until it is selected as 'Volume' in the ColozZstats module.
  • Click on the eye icon in front of 'Display ROI' to show the ROI bounding box of the current image in the 3D View.
  • Adjust the ROI bounding box to any position.
  • Click the 'Re-center ROI' button to reposition the image region within the ROI bounding box to the scene's center.
  • Adjust the slider under each channel to any position. The threshold of each channel can be changed synchronously with the sliding of the slider, which can be observed in the 3D view.
  • Click the 'Compute Colocalization' button and wait about a minute to get a Venn diagram which displays the image's colocalization percentage within the current ROI. The Venn diagram will be saved under the installation folder of version 5.0.2.(for example, C:\Users\Public\AppData\Local\NA-MIC\Slicer 5.0.2).
  • Click the 'SAVE' button to save the scene and the information of the UI/Annotation to a 'mrml' file for reloading.
  • Download links to sample image

Panels and their use

  • Volume: Select the current volume to render and opreate.
  • Display ROI: Show/hide the ROI bounding box of the current volume.
  • Re-center ROI: Reposition the image region selected by the ROI bounding box to the center of the scene:

  • Rename Volume: Rename the current volume.

  • Delete Volume: Delete the current volume.

  • Channels: A list of sliders for adjusting the thresholds for all individual channels of the image.

  • Annotation: A text field for users to add annotations.

  • Compute Colocalization: Compute the image's colocalization percentage within the current ROI, and draw a Venn diagram to show the percentage.

Authors/Contributors:

Limitations

  • Currently, this module only supports Z-stack images in Tagged image file format (.tif, .tiff).
  • A maximum of 3 channels can be selected simultaneously for the computation of the colocalization percentage.

slicercoloc-z-stats's People

Contributors

chenxiang96 avatar benoukraflab avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.