病理WSI配准库valis教程

项目地址

https://github.com/MathOnco/valis

环境配置（linux）

（1）JDK配置

下载https://download.oracle.com/java/21/latest/jdk-21_linux-x64_bin.tar.gz
放到linux系统某一目录下后/home/xxx/jdk-21_linux-x64_bin.tar.gz
进入目录cd /home/xxx
解压tar zxvf jdk-8u181-linux-x64.tar.gz
解压后出现/home/xxx/jdk-21.0.2
配置环境变量vim ~/.bashrc
插入

export JAVA_HOME=/home/xxx/jdk-21.0.2
export PATH=$JAVA_HOME/bin:$PATH
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar

更新source ~/.bashrc
检查java version
输出

java version "21.0.2" 2024-01-16 LTS
Java(TM) SE Runtime Environment (build 21.0.2+13-LTS-58)
Java HotSpot(TM) 64-Bit Server VM (build 21.0.2+13-LTS-58, mixed mode, sharing)

配置完成

（2）Maven配置

下载https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.tar.gz
放到放到linux系统某一目录下后/home/xxx/apache-maven-3.9.6-bin.tar.gz
进入目录cd /home/xxx
解压tar zxvf apache-maven-3.9.6-bin.tar.gz
解压后出现/home/xxx/apache-maven-3.9.6
配置环境变量vim ~/.bashrc
插入

export MAVEN_HOME=/home/xxx/apache-maven-3.9.6
export PATH=${MAVEN_HOME}/bin:${PATH}

更新source ~/.bashrc
检查mvn -v
输出

Maven home: /data_sda/lxt/JDK/apache-maven-3.9.6
Java version: 21.0.2, vendor: Oracle Corporation, runtime: /data_sda/lxt/JDK/jdk-21.0.2
Default locale: zh_CN, platform encoding: UTF-8
OS name: "linux", version: "6.2.0-37-generic", arch: "amd64", family: "unix"

配置完成

（3）Openslide配置

sudo apt-get install openslide-tools
sudo apt-get install python-openslide

检查python-openslide是否安装成功

pip show openslide-python

检查openslide-tools是否安装成功

dpkg -l | grep openslide-tools

检查pixman版本（目前必须为0.40.0）

dpkg -l | grep libpixman

（4）libvips配置

项目需要使用python库pyvips，而pyvips依赖于系统库libvips，项目需要libvips版本>= 8.11

sudo apt install libvips42

检查版本

dpkg -l | grep libvips

输出

ii  libvips42:amd64                            8.12.1-1build1 

（5）conda虚拟环境配置

新建虚拟环境（python3.9/3.10）

conda create -n valis python=3.10

激活环境

conda activate valis

配置valis包

pip install valis-wsi

使用案例

新建一个python脚本valis_example.py
导入必要包

from valis import registration

在/home/xxx/project下创建如下3个目录
其中slide_src_dir目录下放置一组需要配准的WSI（比如HE,CD-31,D2-40）

slide_src_dir = "/home/xxx/project/slide_src_dir"
results_dst_dir = "/home/xxx/project/slide_registration_example"
registered_slide_dst_dir = "/home/xxx/project/slide_registration_example/registered_slides"

设置参考WSI，就是之前放置一组WSI目录下的某一张WSI，（我这里的原始WSI是svs，也可以是其他openslide支持的格式）

reference_slide = "xxxx.svs"

进行配准
max_non_rigid_registration_dim_px可调（800-2000）可以不断调整观察效果

registrar = registration.Valis(slide_src_dir, results_dst_dir,reference_img_f=reference_slide)
rigid_registrar, non_rigid_registrar, error_df = registrar.register()
registrar.register_micro(max_non_rigid_registration_dim_px=2000, align_to_reference=True)
# registrar.warp_and_save_slides(registered_slide_dst_dir, crop="overlap",compression='jpeg',Q=20)
registration.kill_jvm()

保存配准后WSI
其实就上一个代码段的注释部分：在效果调整合适后再取消注释，重新运行，因为直接保存耗费时间
Q值（0-100）越小，压缩越大，输出的tiff文件越小，这个自己衡量即可

registrar.warp_and_save_slides(registered_slide_dst_dir, crop="overlap",compression='jpeg',Q=20)

最终结果
registered_slide_dst_dir下保存了配准后的WSI文件，格式为tiff
在registered_slide_dst_dir同级会生成另一个目录slide_src_dir该目录保存了配置的信息后可视化结果

官方文档

具体信息可以精读valis文档，不再赘述

https://valis.readthedocs.io/en/latest/examples.html