StainTools 开源项目使用教程

StainTools 开源项目使用教程

StainTools Tools for tissue image stain normalisation and augmentation in Python 3 项目地址: https://gitcode.com/gh_mirrors/st/StainTools

1. 项目目录结构及介绍

StainTools 是一个用于组织图像染料标准化和增强的 Python 库。以下是项目的目录结构及其介绍：

StainTools/
├── examples/                # 示例文件夹，包含使用 StainTools 的示例代码和图像
├── images/                  # 图像文件夹，存储处理前后的图像
├── staintools/              # 核心代码文件夹，包含库的主要功能和模块
│   ├── __init__.py          # 初始化文件，用于导入模块
│   ├── LuminosityStandardizer.py  # 亮度标准化器类
│   ├── StainAugmentor.py    # 染料增强器类
│   └── StainNormalizer.py   # 染料标准化器类
├── tests/                   # 测试文件夹，包含对代码的单元测试
├── .gitignore               # git 忽略文件列表
├── LICENSE.txt              # 开源许可证文件
├── README.md                # 项目说明文件
└── setup.py                 # 设置文件，用于安装 Python 包

2. 项目的启动文件介绍

在 StainTools 项目中，并没有一个特定的“启动文件”。用户通常通过在命令行中运行 pip install staintools 来安装库，然后在 Python 脚本中导入并使用库的功能。

以下是使用 StainTools 的一个简单示例：

from staintools import StainNormalizer

# 读取目标图像和要转换的图像
target = StainNormalizer.read_image("./data/my_target_image.png")
to_transform = StainNormalizer.read_image("./data/my_image_to_transform.png")

# 创建染料标准化器实例
normalizer = StainNormalizer(method='vahadane')

# 拟合目标图像
normalizer.fit(target)

# 转换图像
transformed = normalizer.transform(to_transform)

3. 项目的配置文件介绍

StainTools 项目中并没有专门的配置文件。库的使用和配置主要通过在代码中直接设置参数来实现。例如，在使用 StainNormalizer 和 StainAugmentor 类时，可以通过传递不同的参数来调整它们的行为。

以下是一个配置 StainAugmentor 类的示例：

from staintools import StainAugmentor

# 读取要增强的图像
to_augment = StainAugmentor.read_image("./data/my_image_to_augment.png")

# 创建染料增强器实例
augmentor = StainAugmentor(method='vahadane', sigma1=0.2, sigma2=0.2)

# 拟合图像
augmentor.fit(to_augment)

# 生成增强图像
for _ in range(100):
    augmented_image = augmentor.pop()
    # 处理增强图像...

在上面的示例中，sigma1 和 sigma2 是用于控制增强过程的标准差参数。用户可以根据自己的需求调整这些参数。

StainTools Tools for tissue image stain normalisation and augmentation in Python 3 项目地址: https://gitcode.com/gh_mirrors/st/StainTools