Skip to content

christianGRogers/SlicerWorkflowExt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

198 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DAI Workflow Extension for 3D Slicer

DAI Workflow Logo

Documentation

Complete User Manual - Step-by-step instructions for all workflow features
Technical Documentation - Complete feature reference and developer guide

Overview

DAI Workflow is a comprehensive 3D Slicer extension designed for automated vessel processing and centerline extraction. Developed at the Lawson Research Institute and Western University (So Lab), this extension provides a guided workflow for medical image analysis, specifically targeting vessel segmentation, centerline extraction, and Curved Planar Reconstruction (CPR) visualization.

The workflow allows medical professionals to create high-resolution artery view segmentation in a fast-paced hospital environment with minimal training. It uses advanced radius maximizing algorithms to find artery centerlines and create linear reformats for precise medical analysis.

Workflow Demonstration

Phase 1: Volume Cropping

Crop View CT Chest with contrast

Crop View CT Chest with contrast - Interactive ROI-based volume cropping with automatic three-up view for optimal visualization.

Phase 2: Vessel Segmentation

Segmentation View

Segmentation View - Automated vessel segmentation with programmatic Segment Editor integration and manual refinement capabilities.

Phase 3: Centerline Analysis

Straightened View

Straightened View - Advanced CPR (Curved Planar Reconstruction) visualization with centerline extraction and lesion point analysis.

Key Features

πŸ”§ Automated Workflow Processing

  • Guided vessel processing pipeline with step-by-step automation
  • DICOM auto-loading via source file method (source_slicer.txt)
  • Intelligent UI customization that hides unnecessary interface elements
  • Programmatic Segment Editor integration without GUI overhead

πŸ–₯️ Enhanced User Interface

  • Automatic UI cleanup: Hides data probe, status bar, Slicer logo, and help sections
  • Dark 3D background for better visualization
  • Smart view management:
    • Three-up view (Red, Green, Yellow) for volume cropping
    • 3D-only view for post-processing analysis
  • Floating UI elements for scissors control and workflow continuation

πŸ“Š Advanced Medical Visualization

  • Centerline extraction with monitoring and completion dialogs
  • CPR (Curved Planar Reconstruction) for vessel straightening
  • Multiple centerline workflow support for complex vessel networks
  • Lesion point extraction with radius measurements
  • Linear reformat generation for detailed analysis

πŸ› οΈ Comprehensive Testing Suite

  • 100+ test functions for workflow validation
  • Debug utilities for troubleshooting
  • UI modification testing
  • Centerline monitoring verification

Installation

Prerequisites

  • 3D Slicer 5.8.1 or later
  • Windows OS (tested on Windows 10/11)
  • CMake 3.16.3 or later for building

Installation Steps

  1. Clone the repository:

    git clone https://github.com/christianGRogers/SlicerWorkflowExt.git
    cd SlicerWorkflowExt
  2. Build the extension:

    mkdir build
    cd build
    cmake -DCMAKE_BUILD_TYPE=Release ../DAI_Workflow
    make
  3. Install in Slicer:

    • Open 3D Slicer
    • Go to Edit β†’ Application Settings β†’ Modules
    • Add the path to your built extension
    • Restart Slicer

Quick Start

Method 1: Source File Auto-Loading (Recommended)

  1. Create source file: Create source_slicer.txt in your user directory:

    C:\Users\[username]\source_slicer.txt
    
  2. Add DICOM path: Edit the file to contain your DICOM folder path:

    G:\My Drive\Data\DICOM\Patient_Study
    
  3. Start Slicer: Launch Slicer normally - DICOM data will auto-load when accessing the workflow module.

Method 2: Manual Loading

  1. Open Slicer
  2. Navigate to Modules β†’ Scripted Modules β†’ Workflow
  3. Click "Start Workflow"
  4. Load your DICOM data manually

Medical Workflow Process

The DAI Workflow provides a complete 4-phase pipeline for vessel analysis:

  1. Volume Preparation - DICOM loading and ROI-based cropping
  2. Vessel Segmentation - Automated thresholding with manual refinement
  3. Centerline Processing - Advanced extraction algorithms with progress monitoring
  4. Analysis & Visualization - CPR generation, measurements, and linear reformats

For detailed step-by-step instructions, see the User Manual.

Project Structure

SlicerWorkflowExt/
β”œβ”€β”€ DAI_Workflow/                   # Main extension directory
β”‚   β”œβ”€β”€ CMakeLists.txt             # Extension build configuration
β”‚   β”œβ”€β”€ DAI_Workflow.png           # Extension icon
β”‚   β”œβ”€β”€ SourceFileMethod.md        # Auto-loading documentation
β”‚   β”œβ”€β”€ ViewConfigurationChanges.md # View management details
β”‚   └── workflow/                   # Main module directory
β”‚       β”œβ”€β”€ CMakeLists.txt         # Module build configuration
β”‚       β”œβ”€β”€ workflow.py            # Main module implementation
β”‚       β”œβ”€β”€ Moduals/               # Module components
β”‚       β”‚   β”œβ”€β”€ workflow_moduals.py     # Core workflow functions (10,993 lines)
β”‚       β”‚   └── workflow_test_functions.py # Testing utilities
β”‚       β”œβ”€β”€ Resources/             # UI and icons
β”‚       β”‚   β”œβ”€β”€ Icons/
β”‚       β”‚   β”‚   └── workflow.png   # Module icon
β”‚       β”‚   └── UI/
β”‚       β”‚       └── workflow.ui    # User interface layout
β”‚       └── Testing/               # Test framework
β”œβ”€β”€ start.ps1                     # PowerShell launcher script
└── README.md                     # This documentation

Advanced Features

  • Automated UI Customization - Interface optimization for medical workflows
  • Smart View Management - Context-aware layout switching (three-up, 3D-only)
  • Medical Image Processing - Advanced vessel analysis algorithms
  • Comprehensive Testing - 100+ validation functions for clinical accuracy

For complete feature documentation, see the Technical Documentation.

Testing Framework

Comprehensive validation suite with 100+ test functions covering:

  • Centerline Workflow Tests - Extraction validation and monitoring
  • Medical UI Tests - Interface component verification
  • Debug & Verification - Algorithm accuracy and performance testing

For detailed testing procedures, see the Technical Documentation.

Configuration for Medical Environments

Hospital Deployment - Source File Method

Streamlined DICOM loading for clinical environments:

# File: C:\Users\[radiologist]\source_slicer.txt
\\hospital\dicom\PatientID_12345\CT_CORONARY_ARTERIES

PowerShell Integration for Clinical Workflows

# Direct Slicer execution for emergency analysis
.\start.ps1 -RunSlicer

# Monitor for PACS integration triggers
.\start.ps1 -MonitorLocks

Troubleshooting

Common issues and solutions for clinical workflows are covered in detail in the User Manual, including:

  • DICOM loading and contrast detection
  • Centerline extraction for complex vessels
  • CPR visualization optimization
  • Performance tuning for large datasets

Clinical Applications & System Requirements

Supported Procedures: Coronary, peripheral, carotid, and renal artery analysis
Image Compatibility: CT/MR angiography, multi-vendor DICOM support
System Requirements: Windows 10+, 16GB+ RAM, SSD storage recommended

Complete specifications available in the User Manual.

Medical Compliance & Quality Assurance

Validation Standards

  • DICOM Compliance: Full DICOM 3.0 support
  • Medical Accuracy: Sub-millimeter precision for measurements
  • Reproducibility: Consistent results across imaging protocols
  • Performance: Real-time processing for clinical workflows

Quality Control

  • Comprehensive test suite with medical validation
  • Automated accuracy verification
  • Clinical workflow optimization
  • Performance benchmarking for medical environments

License & Medical Disclaimer

This software is developed for research purposes at the Lawson Research Institute and Western University (So Lab).

IMPORTANT MEDICAL DISCLAIMER: This software is intended for research and educational purposes only. It has not been cleared or approved by the FDA or other regulatory agencies for clinical diagnostic use. Healthcare professionals should not rely solely on this software for patient diagnosis or treatment decisions.

Acknowledgments

  • Developer: Christian Rogers
  • Institution: Lawson Research Institute and Western University (So Lab)
  • Year: 2025
  • Medical Advisors: So Lab Medical Team
  • Special Thanks: 3D Slicer medical imaging community

Support & Documentation

  • User Manual - Complete workflow instructions and troubleshooting
  • Technical Documentation - Developer reference and feature catalog
  • Clinical Support - Contact development team for medical workflow questions
  • Training Materials - Available for medical professionals and institutions

Last Updated: September 2025
Version: 1.0.0
Clinical Compatibility: 3D Slicer 5.6.1 - 5.8.1+

For technical documentation, visit the 3D Slicer Extensions Documentation

About

Workflow for DAI which is used to extract lesion points and radius via a guided segmentation process.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors