使用PyTorch和TIAToolbox进行全视野图像分类¶
创建日期: 2023年12月19日 | 最后更新日期: 2024年8月27日 | 最后验证日期: 2024年11月5日
提示
要充分利用本教程，我们建议使用此 Colab版本。这将允许您在此下方呈现的信息上进行实验。
介绍¶
在这个教程中，我们将展示如何使用PyTorch深度学习模型，并借助TIAToolbox对全切片图像（WSI）进行分类。全切片图像是一种通过手术或活检获取的人体组织样本，并使用专用扫描仪扫描而成的图像。病理学家和计算病理学研究人员利用这些图像在显微镜水平上研究疾病，例如癌症，以了解肿瘤生长并帮助改进患者的治疗方案。
处理WSI（全切片图像）具有挑战性是因为它们的尺寸非常庞大。例如，一张典型的切片图像大约有 100,000x100,000 像素，其中每个像素在切片上对应约 0.25x0.25 微米。这给加载和处理这些图像带来了挑战，更不用说在一项研究中可能涉及数百甚至数千张 WSI（更大的研究通常能产生更好的结果！）。
传统的图像处理管道不适合WSI处理，所以我们需要更好的工具。这就是 TIAToolbox 可以发挥作用的地方，因为它提供了一套快速且计算效率高的工具来导入和处理组织切片。通常，WSIs 以金字塔结构保存，包含多个不同放大级别的相同图像副本，优化用于可视化。金字塔的第0级（或底部级别）包含最高放大倍数或缩放级别的图像，而金字塔中的较高级别则包含基图像的较低分辨率副本。金字塔结构如下所示。
WSI金字塔堆栈
(源)
TIAToolbox 允许我们自动化常见的下游分析任务，例如
组织分类。在这个教程中，我们将展示如何：1. 使用
TIAToolbox 加载 WSI 图像；以及 2. 使用不同的 PyTorch 模型在补丁级别对切片进行分类。在这个教程中，我们将提供一个使用 TorchVision ResNet18 模型和自定义
HistoEncoder <https://github.com/jopo666/HistoEncoder>`__ 模型的例子。
让我们开始吧！
设置环境¶
要运行本教程中提供的示例，需要以下包作为先决条件。
OpenJpeg
OpenSlide
pixman
TIAToolbox
HistoEncoder（自定义模型示例）
请在终端中运行以下命令来安装这些包：
apt-get -y -qq install libopenjp2-7-dev libopenjp2-tools openslide-tools libpixman-1-dev pip install -q ‘tiatoolbox<1.5’ histoencoder && echo “Installation is done.”
或者，您可以在 MacOS 上运行 brew install openjpeg openslide 来安装所需的包，而不是运行 apt-get。
有关安装的更多信息可以 在此找到。
运行前清理¶
为了确保适当的清理（例如在异常终止时），此运行中下载或创建的所有文件都保存在一个单一目录中
global_save_dir，我们将该目录设置为“./tmp/”。为了简化维护，目录名称仅出现在一个地方，因此如果需要的话可以很容易地进行更改。
warnings.filterwarnings("ignore")
global_save_dir = Path("./tmp/")
def rmdir(dir_path: str | Path) -> None:
"""Helper function to delete directory."""
if Path(dir_path).is_dir():
shutil.rmtree(dir_path)
logger.info("Removing directory %s", dir_path)
rmdir(global_save_dir) # remove directory if it exists from previous runs
global_save_dir.mkdir()
logger.info("Creating new directory %s", global_save_dir)
下载数据¶
对于我们的示例数据，我们将使用一张完整的幻灯片图像，并从 Kather 100k 数据集的验证子集提取补丁。
wsi_path = global_save_dir / "sample_wsi.svs"
patches_path = global_save_dir / "kather100k-validation-sample.zip"
weights_path = global_save_dir / "resnet18-kather100k.pth"
logger.info("Download has started. Please wait...")
# Downloading and unzip a sample whole-slide image
download_data(
"https://tiatoolbox.dcs.warwick.ac.uk/sample_wsis/TCGA-3L-AA1B-01Z-00-DX1.8923A151-A690-40B7-9E5A-FCBEDFC2394F.svs",
wsi_path,
)
# Download and unzip a sample of the validation set used to train the Kather 100K dataset
download_data(
"https://tiatoolbox.dcs.warwick.ac.uk/datasets/kather100k-validation-sample.zip",
patches_path,
)
with ZipFile(patches_path, "r") as zipfile:
zipfile.extractall(path=global_save_dir)
# Download pretrained model weights for WSI classification using ResNet18 architecture
download_data(
"https://tiatoolbox.dcs.warwick.ac.uk/models/pc/resnet18-kather100k.pth",
weights_path,
)
logger.info("Download is complete.")
读取数据¶
我们创建一个补丁列表和一个相应的标签列表。例如，label_list 中的第一个标签将指示 patch_list 中第一个图像补丁的类别。
# Read the patch data and create a list of patches and a list of corresponding labels
dataset_path = global_save_dir / "kather100k-validation-sample"
# Set the path to the dataset
image_ext = ".tif" # file extension of each image
# Obtain the mapping between the label ID and the class name
label_dict = {
"BACK": 0, # Background (empty glass region)
"NORM": 1, # Normal colon mucosa
"DEB": 2, # Debris
"TUM": 3, # Colorectal adenocarcinoma epithelium
"ADI": 4, # Adipose
"MUC": 5, # Mucus
"MUS": 6, # Smooth muscle
"STR": 7, # Cancer-associated stroma
"LYM": 8, # Lymphocytes
}
class_names = list(label_dict.keys())
class_labels = list(label_dict.values())
# Generate a list of patches and generate the label from the filename
patch_list = []
label_list = []
for class_name, label in label_dict.items():
dataset_class_path = dataset_path / class_name
patch_list_single_class = grab_files_from_dir(
dataset_class_path,
file_types="*" + image_ext,
)
patch_list.extend(patch_list_single_class)
label_list.extend([label] * len(patch_list_single_class))
# Show some dataset statistics
plt.bar(class_names, [label_list.count(label) for label in class_labels])
plt.xlabel("Patch types")
plt.ylabel("Number of patches")
# Count the number of examples per class
for class_name, label in label_dict.items():
logger.info(
"Class ID: %d -- Class Name: %s -- Number of images: %d",
label,
class_name,
label_list.count(label),
)
# Overall dataset statistics
logger.info("Total number of patches: %d", (len(patch_list)))
|2023-11-14|13:15:59.299| [INFO] Class ID: 0 -- Class Name: BACK -- Number of images: 211
|2023-11-14|13:15:59.299| [INFO] Class ID: 1 -- Class Name: NORM -- Number of images: 176
|2023-11-14|13:15:59.299| [INFO] Class ID: 2 -- Class Name: DEB -- Number of images: 230
|2023-11-14|13:15:59.299| [INFO] Class ID: 3 -- Class Name: TUM -- Number of images: 286
|2023-11-14|13:15:59.299| [INFO] Class ID: 4 -- Class Name: ADI -- Number of images: 208
|2023-11-14|13:15:59.299| [INFO] Class ID: 5 -- Class Name: MUC -- Number of images: 178
|2023-11-14|13:15:59.299| [INFO] Class ID: 6 -- Class Name: MUS -- Number of images: 270
|2023-11-14|13:15:59.299| [INFO] Class ID: 7 -- Class Name: STR -- Number of images: 209
|2023-11-14|13:15:59.299| [INFO] Class ID: 8 -- Class Name: LYM -- Number of images: 232
|2023-11-14|13:15:59.299| [INFO] Total number of patches: 2000
如您所见，对于这个补丁数据集，我们有9个类别/标签，它们的ID分别为0-8，并且每个类别都有相应的类别名称，这些名称描述了补丁中的主要组织类型：
背景 (空白玻璃区域) ⟶ Background (空玻璃区域)
LYM ⟶ 淋巴细胞
正常结肠黏膜 ⟶ Normal colon mucosa
DEB ⟶ 垃圾
MUS ⟶ 平滑肌
STR ⟶ 恶性肿瘤相关间质
ADI ⟶ 脂肪组织
MUC ⟶ 粘液
TUM ⟶ 结肠腺癌上皮组织
分类图像片段¶
我们首先使用patch模式获取数字切片中每个斑块的预测，然后使用wsi模式获取大切片的预测。
定义 PatchPredictor 模型¶
PatchPredictor 类使用 PyTorch 编写的 CNN 基础分类器运行。
model可以是任何已训练的 PyTorch 模型，只要它遵循tiatoolbox.models.abc.ModelABC(docs) https://tia-toolbox.readthedocs.io/en/latest/_autosummary/tiatoolbox.models.models_abc.ModelABC.html 类结构。有关此方面的更多信息，请参阅 我们的高级模型技术示例笔记本。 为了加载自定义模型，您需要编写一个小的预处理函数，如preproc_func(img)，确保输入张量符合加载网络所需的格式。或者，您可以将
pretrained_model作为字符串参数传递。 这指定了执行预测的CNN模型， 并且它必须是列出在 这里 的模型之一。 命令将如下所示：predictor = PatchPredictor(pretrained_model='resnet18-kather100k', pretrained_weights=weights_path, batch_size=32)。pretrained_weights: 当使用一个pretrained_model时，默认情况下会同时下载相应的预训练权重。 您可以使用pretrained_weight参数来覆盖默认设置，提供您自己的权重集。batch_size: 每次输入模型的图像数量。此参数的较高值需要更大的（GPU）内存容量。
# Importing a pretrained PyTorch model from TIAToolbox
predictor = PatchPredictor(pretrained_model='resnet18-kather100k', batch_size=32)
# Users can load any PyTorch model architecture instead using the following script
model = vanilla.CNNModel(backbone="resnet18", num_classes=9) # Importing model from torchvision.models.resnet18
model.load_state_dict(torch.load(weights_path, map_location="cpu", weights_only=True), strict=True)
def preproc_func(img):
img = PIL.Image.fromarray(img)
img = transforms.ToTensor()(img)
return img.permute(1, 2, 0)
model.preproc_func = preproc_func
predictor = PatchPredictor(model=model, batch_size=32)
预测补丁标签¶
我们创建一个预测对象，然后使用predict模式调用patch方法。接着计算分类准确率和混淆矩阵。
with suppress_console_output():
output = predictor.predict(imgs=patch_list, mode="patch", on_gpu=ON_GPU)
acc = accuracy_score(label_list, output["predictions"])
logger.info("Classification accuracy: %f", acc)
# Creating and visualizing the confusion matrix for patch classification results
conf = confusion_matrix(label_list, output["predictions"], normalize="true")
df_cm = pd.DataFrame(conf, index=class_names, columns=class_names)
df_cm
|2023-11-14|13:16:03.215| [INFO] Classification accuracy: 0.993000
预测整个玻片的斑块标签¶
我们现在介绍IOPatchPredictorConfig，这是一个指定模型预测引擎进行图像读取和预测写入配置的类。这用于告知分类器应该读取WSI金字塔中的哪一层，并处理数据生成输出。
IOPatchPredictorConfig的参数定义为：
input_resolutions: 一个列表，以字典的形式指定每个输入的分辨率， 列表元素必须与目标model.forward()中的顺序相同。如果你的模型 只接受一个输入，你只需要放置一个指定'units'和'resolution'的字典。 请注意，TIAToolbox 支持具有多个输入的模型。有关单位和分辨率的更多信息，请参阅 TIAToolbox 文档。patch_input_shape: 最大输入的形状为 (高度, 宽度)。stride_shape: 每两个连续补丁之间的步长大小，用于补丁提取过程。如果用户将stride_shape设置为patch_input_shape，补丁将无重叠地提取和处理。
wsi_ioconfig = IOPatchPredictorConfig(
input_resolutions=[{"units": "mpp", "resolution": 0.5}],
patch_input_shape=[224, 224],
stride_shape=[224, 224],
)
The predict方法在输入片段上应用CNN并获取结果。以下是参数及其描述:
mode: 需要处理的输入类型。根据您的应用选择patch，tile或wsi。imgs: 输入列表，应该是一个包含输入瓷砖或WSI路径的列表。return_probabilities: 设置为 True 以获取每个类别的概率以及输入补丁的预测标签。如果你想合并预测以生成tile或wsi模式的预测图，你可以设置return_probabilities=True。ioconfig: 使用IOPatchPredictorConfig类设置IO配置信息。resolution和unit（未显示在下方）：这些参数指定了我们计划从中提取补丁的WSI级别或每像素微米分辨率，可以代替ioconfig。这里我们将WSI级别指定为'baseline'，这等同于级别 0。一般来说，这是分辨率最高的级别。在这个特定情况下，图像只有一个级别。更多信息可以在 文档 中找到。masks: 与imgs列表中的WSI的掩码相对应的路径列表。这些掩码指定了我们希望从中提取补丁的原始WSI中的区域。如果某个特定WSI的掩码被指定为None，那么该WSI的所有补丁（甚至是背景区域）的标签都将被预测。这可能会导致不必要的计算。merge_predictions: 如果需要生成一个补丁分类结果的2D图，可以将此参数设置为True。 然而，对于大型WSI（全切片图像），这将需要大量的可用内存。另一种（默认）解决方案是设置merge_predictions=False, 然后使用merge_predictions函数生成2D预测图，稍后会看到这一点。
由于我们使用的是大型WSI，因此补丁提取和预测过程可能需要一些时间（如果有访问支持Cuda的GPU以及PyTorch+Cuda，请确保将ON_GPU=True设置为启用）。
with suppress_console_output():
wsi_output = predictor.predict(
imgs=[wsi_path],
masks=None,
mode="wsi",
merge_predictions=False,
ioconfig=wsi_ioconfig,
return_probabilities=True,
save_dir=global_save_dir / "wsi_predictions",
on_gpu=ON_GPU,
)
我们通过可视化wsi_output来观察预测模型如何在我们的全切片图像上工作。我们首先需要合并补丁预测输出，然后将它们作为叠加层显示在原始图像上。像之前一样，使用merge_predictions方法来合并补丁预测。这里我们将参数resolution=1.25, units='power'设置为生成1.25倍放大率的预测图。如果你希望获得更高/更低分辨率（更大/更小）的预测图，则需要相应地调整这些参数。当预测合并完成后，使用overlay_patch_prediction函数将预测图叠加到WSI缩略图上，该缩略图应以用于预测合并的分辨率提取。
overview_resolution = (
4 # the resolution in which we desire to merge and visualize the patch predictions
)
# the unit of the `resolution` parameter. Can be "power", "level", "mpp", or "baseline"
overview_unit = "mpp"
wsi = WSIReader.open(wsi_path)
wsi_overview = wsi.slide_thumbnail(resolution=overview_resolution, units=overview_unit)
plt.figure(), plt.imshow(wsi_overview)
plt.axis("off")
将预测图叠加在此图像上，如下所示：
# Visualization of whole-slide image patch-level prediction
# first set up a label to color mapping
label_color_dict = {}
label_color_dict[0] = ("empty", (0, 0, 0))
colors = cm.get_cmap("Set1").colors
for class_name, label in label_dict.items():
label_color_dict[label + 1] = (class_name, 255 * np.array(colors[label]))
pred_map = predictor.merge_predictions(
wsi_path,
wsi_output[0],
resolution=overview_resolution,
units=overview_unit,
)
overlay = overlay_prediction_mask(
wsi_overview,
pred_map,
alpha=0.5,
label_info=label_color_dict,
return_ax=True,
)
plt.show()
使用特定于病理学的模型进行特征提取¶
在本节中，我们将展示如何从存在于 TIAToolbox 之外的预训练 PyTorch 模型中提取特征，使用 TIAToolbox 提供的 WSI 推理引擎。为了说明这一点，我们将使用 HistoEncoder，这是一个专门用于计算病理学的模型，通过自监督方式训练以从组织学图像中提取特征。该模型已在此处提供：
‘HistoEncoder：用于数字病理学的基础模型’ (https://github.com/jopo666/HistoEncoder) 由赫尔辛基大学的 Pohjonen, Joona 及其团队开发。
我们将绘制一个特征图的UMAP降维到3D（RGB）的图，以可视化特征如何捕捉上述一些组织类型之间的差异。
# Import some extra modules
import histoencoder.functional as F
import torch.nn as nn
from tiatoolbox.models.engine.semantic_segmentor import DeepFeatureExtractor, IOSegmentorConfig
from tiatoolbox.models.models_abc import ModelABC
import umap
TIAToolbox 定义了一个 ModelABC，它是继承自 PyTorch 的类 nn.Module 并指定了模型在 TIAToolbox 推理引擎中使用时应遵循的结构。histoencoder 模型不遵循此结构，因此我们需要将其包装在一个类中，该类的输出和方法是 TIAToolbox 引擎所期望的。
class HistoEncWrapper(ModelABC):
"""Wrapper for HistoEnc model that conforms to tiatoolbox ModelABC interface."""
def __init__(self: HistoEncWrapper, encoder) -> None:
super().__init__()
self.feat_extract = encoder
def forward(self: HistoEncWrapper, imgs: torch.Tensor) -> torch.Tensor:
"""Pass input data through the model.
Args:
imgs (torch.Tensor):
Model input.
"""
out = F.extract_features(self.feat_extract, imgs, num_blocks=2, avg_pool=True)
return out
@staticmethod
def infer_batch(
model: nn.Module,
batch_data: torch.Tensor,
*,
on_gpu: bool,
) -> list[np.ndarray]:
"""Run inference on an input batch.
Contains logic for forward operation as well as i/o aggregation.
Args:
model (nn.Module):
PyTorch defined model.
batch_data (torch.Tensor):
A batch of data generated by
`torch.utils.data.DataLoader`.
on_gpu (bool):
Whether to run inference on a GPU.
"""
img_patches_device = batch_data.to('cuda') if on_gpu else batch_data
model.eval()
# Do not compute the gradient (not training)
with torch.inference_mode():
output = model(img_patches_device)
return [output.cpu().numpy()]
现在我们有了包装器，我们将创建特征提取模型并实例化一个 DeepFeatureExtractor 以便我们能够使用该模型处理WSI。我们将使用与上面相同的WSI，但这次我们将使用HistoEncoder模型从WSI的补丁中提取特征，而不是预测每个补丁的某些标签。
# create the model
encoder = F.create_encoder("prostate_medium")
model = HistoEncWrapper(encoder)
# set the pre-processing function
norm=transforms.Normalize(mean=[0.662, 0.446, 0.605],std=[0.169, 0.190, 0.155])
trans = [
transforms.ToTensor(),
norm,
]
model.preproc_func = transforms.Compose(trans)
wsi_ioconfig = IOSegmentorConfig(
input_resolutions=[{"units": "mpp", "resolution": 0.5}],
patch_input_shape=[224, 224],
output_resolutions=[{"units": "mpp", "resolution": 0.5}],
patch_output_shape=[224, 224],
stride_shape=[224, 224],
)
当我们创建DeepFeatureExtractor时，我们将传递
auto_generate_mask=True参数。这将使用Otsu阈值自动创建一个组织区域的掩码，以便提取器仅处理包含组织的那些补丁。
# create the feature extractor and run it on the WSI
extractor = DeepFeatureExtractor(model=model, auto_generate_mask=True, batch_size=32, num_loader_workers=4, num_postproc_workers=4)
with suppress_console_output():
out = extractor.predict(imgs=[wsi_path], mode="wsi", ioconfig=wsi_ioconfig, save_dir=global_save_dir / "wsi_features",)
这些特征可以用于训练下游模型，但在这里，为了直观了解这些特征所代表的意义，我们将使用UMAP降维方法在RGB空间中可视化这些特征。用相似颜色标记的点应该具有相似的特征，因此我们可以通过将UMAP降维结果叠加到WSI缩略图上来检查这些特征是否自然地分离成不同的组织区域。我们将在接下来的单元格中将其与上面的patch级别的预测图一起绘制出来，以比较特征与patch级别的预测之间的关系。
# First we define a function to calculate the umap reduction
def umap_reducer(x, dims=3, nns=10):
"""UMAP reduction of the input data."""
reducer = umap.UMAP(n_neighbors=nns, n_components=dims, metric="manhattan", spread=0.5, random_state=2)
reduced = reducer.fit_transform(x)
reduced -= reduced.min(axis=0)
reduced /= reduced.max(axis=0)
return reduced
# load the features output by our feature extractor
pos = np.load(global_save_dir / "wsi_features" / "0.position.npy")
feats = np.load(global_save_dir / "wsi_features" / "0.features.0.npy")
pos = pos / 8 # as we extracted at 0.5mpp, and we are overlaying on a thumbnail at 4mpp
# reduce the features into 3 dimensional (rgb) space
reduced = umap_reducer(feats)
# plot the prediction map the classifier again
overlay = overlay_prediction_mask(
wsi_overview,
pred_map,
alpha=0.5,
label_info=label_color_dict,
return_ax=True,
)
# plot the feature map reduction
plt.figure()
plt.imshow(wsi_overview)
plt.scatter(pos[:,0], pos[:,1], c=reduced, s=1, alpha=0.5)
plt.axis("off")
plt.title("UMAP reduction of HistoEnc features")
plt.show()
我们看到，我们的局部预测器生成的预测图和我们的自监督特征编码器生成的特征图都捕捉到了关于WSI中组织类型的相似信息。这是一个很好的验证，表明我们的模型按预期工作。这也表明，HistoEncoder模型提取的特征捕捉到了不同组织类型之间的差异，因此它们编码了与组织学相关的信息。
从这里去哪里¶
在本笔记本中，我们展示了如何使用PatchPredictor和
DeepFeatureExtractor类及其predict方法来预测
大图块和WSI的补丁的标签或提取特征。我们介绍了merge_predictions和overlay_prediction_mask辅助
函数，这些函数合并了补丁预测输出，并将生成的预测图可视化为输入图像/WSI上的叠加。
所有过程都在TIAToolbox中进行，我们可以轻松地按照示例代码将各个部分组合起来。请确保正确设置输入和选项。我们鼓励您进一步研究更改predict函数参数对预测输出的影响。我们已经演示了如何在TIAToolbox框架中使用您自己的预训练模型或由研究社区提供的特定任务模型来对大型WSI进行推理，即使模型结构未在TIAToolbox模型类中定义。
您可以通过以下资源了解更多：