QuPath script

QuPath脚本是Groovy

QuPath脚本是基于Groovy创建的。选择Groovy是因为Groovy具有很多新特性，同时又与QuPath本身所使用的Java编程语言非常匹配。熟悉Java语言的程序员应该很快就可以轻松地学习Groovy。

除了Groovy之外，还可以编写其他脚本语言。要切换到Javascript，只需打开脚本编辑器，然后选择Language（语言）→ Javascript

另外，还可以使用python、matlab或ImageJ宏语言。

脚本编辑器示例

接下来介绍如何使用QuPath的脚本编辑器创建一些简单的脚本。

要进行后续操作，应该打开图像并创建几个标注，并对某些单元进行检测和分类。

统计对象

打开脚本编辑器(Automate → Show script editor)，输入以下代码，然后选择Run → Run。

n = nObjects()
print("I have " + n + " objects in total")

这里不过多解释Groovy语言的内容，如果想要了解可以自行google，我们将重点介绍QuPath中脚本的细节，nObjects() 函数是QuPath提供的内置函数，返回当前图像中对象的个数。另外，脚本编辑器具有自动完成的功能，通过ctrl+space快捷键即可调用（不过我的电脑上好像没有效果）。

统计不同类型的对象

以下代码可以分别计算检测对象和标注对象的数量：

detections = getDetectionObjects()
print("I have " + detections.size() + " detections")
annotations = getAnnotationObjects()
print("I have " + annotations.size() + " annotations")

循环

我们可以使用循环来遍历特定类型的对象，例如以下脚本遍历所有的标注对象并打印该对象。了解更多for循环的信息，可以查看Groovy的文档。

for (annotation in getAnnotationObjects()) {
    print(annotation)
}

或者，可以打印标注的某些特定属性。以下代码仅仅打印ROI，而不是对象本身：

for (annotation in getAnnotationObjects()) {
    roi = annotation.getROI()
    print(roi)
}

而以下代码可以打印标注的分类：

for (annotation in getAnnotationObjects()) {
    pathClass = annotation.getPathClass()
    print(pathClass)
}

类别计数

根据以上的代码，我们可以编写一段代码来实现特定分类的标注的数量统计，首先获取某一类型对象，然后遍历每一个标注对象，将标注对象的类型与特定分类类型进行对比，看代码：

tumorClass = getPathClass("Tumor")
nTumor = 0
for (detection in getDetectionObjects()) {
    pathClass = detection.getPathClass()
    if (pathClass == tumorClass)
      nTumor++
}
print("Number of tumor detections: " + nTumor)

不过在实际情况中，上面的代码可能存在一些问题。这是因为它仅会计数严格等于Tumor分类的细胞，而不会统计Tumor分类下子类别的对象。想要实现子类的计数，可以修改代码为：

tumorClass = getPathClass("Tumor")
nTumor = 0
for (detection in getDetectionObjects()) {
    pathClass = detection.getPathClass()
    if (tumorClass.isAncestorOf(pathClass))
      nTumor++
}
print("Number of tumor detections: " + nTumor)

通过使用每个分类中内置的isAncestorOf 方法，将执行检查以查看对象的分类是否等于或源自Tumor分类。

计算百分比

对上面代码稍作修改，我们就可以实现对非肿瘤区域计数并计算百分比，看代码：

tumorClass = getPathClass("Tumor")
nTumor = 0
nNonTumor = 0
for (detection in getDetectionObjects()) {
    pathClass = detection.getPathClass()
    if (tumorClass.isAncestorOf(pathClass))
      nTumor++
    else
      nNonTumor++
}
print("Number of tumor detections: " + nTumor)
print("Number of non-tumor detections: " + nNonTumor)

percentageTumor = nTumor / (nTumor + nNonTumor) * 100
print("Percentage of tumor detections: " + percentageTumor)

面积统计

在某些情况下，我们可能需要统计每个类别的所有区域的面积和，以下代码实现了肿瘤区域的面积统计：

tumorClass = getPathClass("Tumor")
nTumor = 0
nNonTumor = 0
areaTumor = 0
areaNonTumor = 0
for (detection in getDetectionObjects()) {
    roi = detection.getROI()
    pathClass = detection.getPathClass()
    if (tumorClass.isAncestorOf(pathClass)) {
      nTumor++
      areaTumor += roi.getArea()
    } else {
      nNonTumor++
      areaNonTumor += roi.getArea()
    }
}
print("Number of tumor detections: " + nTumor)
print("Number of non-tumor detections: " + nNonTumor)

percentageTumor = nTumor / (nTumor + nNonTumor) * 100
print("Percentage of tumor detections: " + percentageTumor)

percentageAreaTumor = areaTumor / (areaTumor + areaNonTumor) * 100
print("Percentage of tumor area: " + percentageAreaTumor)

注意，以上代码统计出来的面积是以像素为单位的，而不是实际的物理面积。

附加技术点

如果希望了解QuPath脚本的设计和工作原理可以继续阅读以下内容，相反，如果这是希望在QuPath中简单使用一下脚本，就可以不必向下阅读了。

默认方法和导入

以上内容中，使用了几种特定于QuPath的方法，这些方法在普通的Groovy代码中是不可用的，但是我们在使用的时候，并不需要在任何地方声明或导入它们。

这使得在QuPath中编写脚本有点像使用自定义的宏语言，而不是简单地使用Groovy。这样做的目的是试图帮助不熟悉脚本的用户以最小的学习成本来解决问题。

但是，这些默认方法从何而来，QuPath如何知道它们的存在？

QP和QPEx中的静态方法

这些方法是在以下这两个Java类中实现的：

• QP.java

• QPEx.java

可以阅读这两个代码文件，更进一步地了解这些方法。

QP.java 包含不依赖用户界面的方法，而QPEx.java 包含qp.java中的所有代码，还包含一些依赖界面的方法。在使用过程中可直接使用qpex.java中的方法。

导入静态方法

使用脚本编辑器运行脚本的时候，QuPath会自动导入qp和qpex中的方法。

但是，在发现默认的导入与编写脚本有某种冲突的时候，我们可以禁用自动导入的功能，在 Run → Include default bindings 设置，禁用后，我们需要手动导入QP或QPEx：

import qupath.lib.scripting.QP
import qupath.lib.scripting.QPEx

参考文档

https://github.com/qupath/qupath/wiki/Writing-custom-scripts