Skip to main content

CORE - A Cell-Level Coarse-to-Fine Image Registration Engine for Multi-stain Image Alignment

PyPI version arXiv Greetings License pages-build-deployment Status Last Commit Python Conda PyTorch CUDA Florence-SAM Build

Note: This package was originally developed by eshasadia/CORE. This PyPI distribution was extended and packaged by @Avishek8136.

News

📢 November 2025 — CORE Released as Open-Source The first public release of CORE, a unified coarse-to-fine multi-stain image registration engine, is now available. This release includes prompt-guided mask generation, accelerated features based coarse alignment, nuclei-level refinement, and real-time deformation visualization.

📝 November 2025 — Updated Preprint Available on arXiv. The team has released an updated version of the CORE preprint, expanding on the architecture, benchmarks, and qualitative results. Check out the newest version here: arXiv:2403.05780.

🎥 New TIAViz Integration Demo - Added a full registration workflow demo showing real-time deformation fields and alignment quality inside TIAViz, enabling seamless analysis for whole-slide images.

🧪 Sample Notebooks Added - End-to-end Jupyter notebooks for coarse and fine alignment have been added, making it easier for users to experiment with CORE immediately.

Introduction

CORE is a fast and accurate coarse-to-fine image registration engine designed for aligning multi-stain whole-slide images. It combines prompt-based tissue masking, rapid coarse alignment, and nuclei-level fine registration to deliver precise cell-level correspondence across stains. With real-time deformation visualization and easy integration, CORE enables reliable multi-stain analysis for digital pathology workflows.

Features

  • Prompt-based Tissue Mask Extraction.
  • Fast coarse level multi-stain image registration.
  • Fine-grained Nuclei-level precise alignment on re-stained sections and tissue alignment on consecutive sections.
  • Real time deformation estimation and Registration visualisation.

CORE Architecture

CORE VISUALIZATION

Registration Visualization on TIAViz

Installation

Option 1: Install via pip (Recommended)

pip install core-registration

Or install from source with all optional dependencies:

pip install core-registration[all]

Option 2: Install from source

  1. Clone the repo:

    git clone https://github.com/eshasadia/CORE.git
    cd CORE
    
  2. Create and activate conda environment:

    conda env create -f environment.yml
    conda activate core
    
  3. Install the package in development mode:

    pip install -e .
    

Option 3: Using pip requirements

pip install -r requirements.txt
pip install -e .

Set API Keys as Environment Variables

  1. For our prompt-based tissue mask generation. You must set the VisionAgent API key as environment variables. Each operating system offers different ways to do this. Here is the code for setting the variables:
export VISION_AGENT_API_KEY="your-api-key"
  1. For UNet based tissue mask extraction we have made the weights publicly available on hugging face. CORE

Configuration

Edit config.py to set your file paths and resolution parameters:

# Update these paths to match your data
SOURCE_WSI_PATH = "/path/to/your/source_wsi.tiff"
TARGET_WSI_PATH = "/path/to/your/target_wsi.tiff"

Usage

Example of both coarse and fine registration have been placed under the notebooks folder.

How to Cite

@misc{nasir2025corecelllevelcoarsetofine,
      title={CORE - A Cell-Level Coarse-to-Fine Image Registration Engine for Multi-stain Image Alignment}, 
      author={Esha Sadia Nasir and Behnaz Elhaminia and Mark Eastwood and Catherine King and Owen Cain and Lorraine Harper and Paul Moss and Dimitrios Chanouzas and David Snead and Nasir Rajpoot and Adam Shephard and Shan E Ahmed Raza},
      year={2025},
      eprint={2511.03826},
      archivePrefix={arXiv},
      primaryClass={q-bio.QM},
      url={https://arxiv.org/abs/2511.03826}, 
}

CORE Registration DEMO

Metadata

Release files for core-registration 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for core-registration 1.0.1
File Size Uploaded
core_registration-1.0.1.tar.gz 15.9 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for core-registration 1.0.1
File Interpreter ABI Platform
core_registration-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 31.7 MB

Release files / core_registration-1.0.1.tar.gz

Download URL core_registration-1.0.1.tar.gz
Size 15.9 MB
Tags Source
SHA-256 checksum
How to use checksums
e1eb07f42930814ef9f4339fbb3eb3388bee874e5ef8e90c90b492107baf7086
BLAKE2b-256 checksum
How to use checksums
cfda9cd84a60688f809080cd069e2374f2057539a96c1787d3e94ceb091dafe0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release files / core_registration-1.0.1-py3-none-any.whl

Download URL core_registration-1.0.1-py3-none-any.whl
Size 15.9 MB
Tags Python 3
SHA-256 checksum
How to use checksums
9566e150b5d73ede8d4cced2ba74046be312435fdacb31f6b26cb8b4d098418e
BLAKE2b-256 checksum
How to use checksums
ef3db88a1bc930c253cffad905e94190683d5ee55ce8e2f7582bb4e394942cb7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page