QuantImPy 2021：Minkowski泛函和函数Python软件包简介

软件X 16（2021）100823原始软件出版物QuantImPy：Minkowski泛函和Python函数Arnout M.P.哈姆迪·博埃伦斯切列皮河斯坦福大学能源资源工程系，斯坦福，CA，94305，美国ar t i cl e i nf o文章历史记录：接收19可以2021收到修订版2021年9月10日接受2021年保留字：Minkowski泛函Minkowski函数形态运算Pythona b st ra ctMinkowski泛函和函数是一族形态测度，可以用于描述系统的形态（形状）和拓扑（连通性）。本文介绍了QuantImPy Python包，它可以计算Minkowski泛函和函数。此外，该软件包可以有效地执行基本的形态学操作，并计算它们的距离图。QuantImPy易于安装，文档齐全，与现有的Python包集成，并且是开源的。版权所有©2021作者。由爱思唯尔公司出版这是CC BY-NC-ND下的开放获取文章许可证（http://creativecommons.org/licenses/by-nc-nd/4.0/）。代码元数据当前代码版本0.2.1用于此代码版本的代码/存储库的永久链接https://github.com/ElsevierSoftwareX/SOFTX-D-21-00096代码海洋计算胶囊法律代码许可证GPL v3+使用git的代码版本控制系统使用C、Cython、Python的软件代码语言、工具和服务编译要求，操作环境依赖性Linux，MacOS，Windows，Python（v3 xx），edt，numpy如果可用开发人员文档/手册链接https://boeleman.github.io/quantimpy/问题支持电子邮件boelens@stanford.edu1. 动机和意义在自然界中，可以找到许多例子，其中系统的几何形状和热力学之间存在相互作用，或者材料的结构影响其性能[1研究这类问题的一种方法是使用Minkowski泛函[5]。这些泛函是一类形态测度，可以用来描述系统的形态（形状）和拓扑（连通性）。它们既可以直接应用于几何体，也可以作为选择阈值的函数，在这种情况下，它们被称为Minkowski函数或测度。阈值的示例包括距界面的距离或密度[1]。Minkowski泛函和函数的许多应用包括医学成像[6]，天文学[7然而，尽管有这么多的应用，*通讯作者。电子邮件地址：boelens@stanford.edu（Arnout M.P. Boelens），tchelepi@stanford.edu（Hamdi A.Tchelepi）。https://doi.org/10.1016/j.softx.2021.100823缺乏良好记录和易于安装的库来计算2D和3D中的Minkowski泛函和函数。本文介绍了QuantImPy Python包。 该软件包的灵感来自并部分基于用于科学图像处理的QuantIm C/C++库[10]。QuantImPy软件包可以计算2D和3D图像的Minkowski泛函和函数[11，12]。此外，它可以基于欧几里德距离变换执行许多快速形态学操作[13，14]。通过发布这个包，作者的目标是提供一个Python包，它（i）易于安装，（ii）有良好的文档记录，（iii）与现有的Python包集成，并且(iv)开源.这将允许任何人轻松计算Minkowski泛函和函数。2. 软件描述2.1. 设计选择在QuantImPy的开发过程中做出了以下设计选择2352-7110/©2021作者。由爱思唯尔公司出版。这是一篇开放获取的文章，使用CC BY-NC-ND许可证（http://creativecommons.org/licenses/by-nc-nd/4.0/）。可在ScienceDirect上获得目录列表SoftwareX期刊主页：www.elsevier.com/locate/softxArnout M.P.Boelens和Hamdi A.切莱皮软件X 16（2021）1008232Fig. 1. M i n k o w s k i 泛函的绝对相对误差δM，作为域的最大尺寸L的函数，以2D（a）和3D（b）中的像素为单位。M2（2D）和M3（3D）的绝对相对误差为所用几何形状的机器精度或零，因此在此图中省略QuantImPy包已在Python包索引（PyPI）存储库（https：//pypi.org/project/quantimpy/）上提供。因此，它可以很容易地安装在各种操作系统上。高 质 量 的 文 档 大 量 的文 档 ， 包 括 各种 示 例 ， 可在 Github.io（boeleman.github.io/quantimpy/）上获得。这应该允许任何人快速启动并运行代码。为 了 避 免 重 复 功 能 ， QuantImPy 专 注 于 快 速 形 态 运 算 和Minkowski泛函和函数的计算因为它在2D和3D Numpy数组上运行[15]，所以与许多现有的Python包进行无缝集成 ， 包 括 Scikit-image [16] ， Pillow [17] 和 Matplotlib[18]。开源源代码在Github（https://github.com/boeleman/quantimpy）上的GNU通用公共许可证v3.0下发布。这允许任何人下载、查看和修改源代码。2.2. 模块QuantImPy python 包 由 两 个 模 块 组 成 ： morphology 和minkowski。本节解释其功能。2.2.1. 形态形态学模块执行基本的形态学操作，并以各向同性或各向异性分辨率计算2D和3D图像上的各种距离图。出于计算性能的原因，形态学操作和距离图都是使用欧几里德距离变换计算的[13]。对于欧几里得距离变换的计算，使用多标记各向异性3D欧几里得距离变换（MLAEDT-3D）库[14]，其基于参考文献中的工作。[19，20]和[21]。这个库计算精确的欧几里得距离映射。该模块目前仅接受二进制图像，并支持以下基本形态学操作：• 侵蚀（A和B）• 扩张（A→B）• 开度（A<$B=（A<$B）<$B）• 闭合（A·B=（A<$B）<$B）其中B是盘形或球形结构元素，A是对其执行形态学操作的集合（阶段1）。B对A的扩张定义为使得B击中A的所有点的集合。B对A的侵蚀定义为 所有点的集合，使得B包含在A中[22]。此外，相同的形态学操作也可用作距离图。腐蚀和膨胀图分别是从界面到相位1和相位0的距离图。开和闭映射分别给出了局部适合相位1或相位0的最大圆盘或球体的大小。形态学模块包含以下功能：erode （image ，dist ，res=None ）此 函 数对 二 进 制Numpy数组图像执行形态侵蚀。支持2D和3D阵列dist是距阵列被扩张到的界面的距离可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与图像数组具有相同的维度dilate（image，dist，res=None）此函数对二进制Numpy数组图像执行形态膨胀操作。支持2D和3D阵列。dist是距阵列被扩张到的界面的距离可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与图像数组具有相同的维度。open （ erosion ， dist ， res=None ） 此 函 数 是 函 数dilate（）的别名。与erode（）函数一起，该函数对二进制Numpy数组腐蚀执行形态学开放操作。支持2D和3D阵列。dist是距离数组打开的接口可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与膨胀数组具有相同的维度。close （dilation ， dist ， res=None ） 此 函 数 是 函 数erode（）的别名。该函数与dilate（）函数一起执行形态学闭合Arnout M.P.Boelens和Hamdi A.切莱皮软件X 16（2021）1008233∫222πR=-=82M（X）=[[客户端]==[+]V，图二. Bentheimer砂岩样品的横截面（a）和两个不同的距离图，侵蚀距离图（b）和开口距离图（c）。的大小该样本是1024 × 3像素，并且均匀分辨率是1。每像素53µ m二进制Numpy数组膨胀的操作。支持2D和3D阵列dist是距离X，具有光滑边界，δX，计算以下泛函：从数组所关闭的接口。可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与M0（X）=XM1（X）=1ds，∫（一个）DC，以及（2）伸缩数组erode_map（image，res=None）该函数计算二进制Numpy数组的形态侵蚀图，2πM（X）=1δX1DC，（3）δX年龄支持2D和3D阵列。可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与图像数组具有相同的维度dilate_map（image，res=None）这个功能来计算其中ds是表面元素，dc是圆周元素。R是局部曲率的半径。结果如下-表面积S的定义M0（X），周长，C2πM1（X）和二维欧拉特征线χ（X）πM2（X）。考虑具有光滑边界表面δX的3D物体X，计算以下泛函：二进制Numpy阵列图像的形态膨胀图。支持2D和3D阵列。可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与膨胀数组具有相同的维度。open_map（erosion_map，res=None）与M0（X）=V=Xd（4）M1（X）1ds，（5）δX1 1 1 1M（X）ds，和（6）2π2δX2R1R2erode_map（）函数这个函数计算Numpy数组erosion_map的形态学开放映射。33（4π）21R1R2]ds，（7）支持2D和3D阵列。可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与膨胀数组具有相同的维度。close_map （dilation_map ，res=None ）与dilate_map（）函数一起，该函数计算Numpy数组dilation_map的形态 闭 合 映 射 。 支 持 2D 和 3D 阵 列 。 可 选 地 ， 可 以使 用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与膨胀数组具有相同的维度。2.2.2. MinkowskiMinkowski模块从二进制图像计算Minkowski泛函，并从距离图或其他灰度图像计算Minkowski函数。这些图像可以是2D或3D，并且支持各向同性和各向异性分辨率。Minkowski泛函的定义遵循物理学文献中的惯例[1]。考虑到2D身体，δXArnout M.P.Boelens和Hamdi A.切莱皮软件X 16（2021）1008234==-=其中dv是体积元素，ds是表面元素。R1和R2是曲面元ds的主曲率半径。这导致了体积V M0（X）、表面积S8M1（X）、积分平均曲率H2π2M2（X）和三维欧拉特征线χ（X）4π/ 3M3（X）的以下定义。除了泛函之外，该模块还可以计算Minkowski函数。在这种情况下，输入图像的灰度值被用作阈值。当使用侵蚀或膨胀距离图时，这导致计算平行表面的Minkowski函数[1]。用于计算Minkowski泛函的代码基于参考文献中的工作。[10，12]和[11]。为了计算性能，代码是用C编写的，并由Cython包装[23]用于原生Python接口。minkowski模块包含以下函数：functionals（image，res）这个函数计算Numpy数组图像的Minkowski泛函。支持2D和3D阵列可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率数组时，它需要与图像数组具有相同的维度Arnout M.P.Boelens和Hamdi A.切莱皮软件X 16（2021）1008235×××→functions_close （ closing ， res ） 此 函 数 计 算Minkowski泛函作为Numpy数组关闭时的灰度值的函数。支持2D和3D阵列。可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供了一个解析数组时，它需要与结束数组具有该算法从最大值（白色）开始迭代数组中存在的所有灰度值。 对于每个灰度值，阵列被转换为二进制图像，其中大于灰度值的值变为1（白色），所有其他值变为0（黑色）。 对于这些二进制图像中的每一个，根据函数functional（）计算minkowski泛函。该函数可与morphology（）模块结合使用，以计算不同形态距离图的Minkowski函数。functions_open（opening，res）此函数计算Minkowski泛函作为Numpy数组开口中灰度值的函数。支持2D和3D阵列。可选地，可以使用Numpy阵列分辨率来提供阵列的（各向异性）分辨率。当提供分辨率阵列，其需要具有与开口阵列相同的尺寸。该算法从最小值（黑色）开始迭代数组中存在的所有灰度值对于每个灰度值，阵列被转换为二进制图像，其中大于灰度值的值变为1（白色），所有其他值变为0（黑色）。 对于这些二进制图像中的每一个，根据 函数functional（）计算minkowski泛函。该函数可与morphology（）模块结合使用，以计算不同形态距离图的Minkowski函数。为了检查计算Minkowski泛函的算法的收敛性，使用了两种不同的几何形状512µ m的正方形512µ m，其中放置一个磁盘，2DMinkowski泛函的半径为192µm， 尺寸为512µ m的盒子 512微米512μ m，其中对于3D Minkowski泛函，放置半径为192µm的球体。图1显示了相对误差的收敛性，Minkowski泛函δM是域的最大像素尺寸L的函数。以µm为单位的域尺寸是恒定的，这意味着分辨率随着以像素为单位的域尺寸的变化而变化。计算两者的绝对相对误差 各向同性分辨率和各向异性分辨率，其中x方向上的分辨率是其它方向上的分辨率的两倍M2（2D）和M3（3D）的相对误差为所用几何形状的机器精度或零，因此已从图中省略。在图 1（a）和图。1（b）表明，当分辨率是各向异性而不是各向同性时，绝对相对误差通常稍大然而，对于所有的闵可夫斯基泛函的绝对相对误差减小的域大小的像素增加。虽然已知M1作为分辨率是有偏差的∆0 [11]，这个Minkowski泛函也显示了收敛性。对于闵可夫斯基函数的计算，使用泛函，因此它们表现出相同的收敛行为。2.3. 说明性实例本节将介绍一些示例来说明如何使用QuantImPy包。首先，提出了可以在所有线性数据库中找到的许多示例中的一小部分。最后一个示例是计算砂岩样本的Minkowski函数的用例。第一个示例演示如何使用dilate和close在立方体的3D图像上运行在一台速度较慢的笔记本电脑上，放大和关闭功能都需要大约0.1秒。下一个例子展示了如何计算具有各向同性和各向异性分辨率的球的图像的Minkowski泛函。functional函数需要大约0.02秒来执行。在线文档中的最后一个例子展示了如何计算球的Minkowski函数。Arnout M.P.Boelens和Hamdi A.切莱皮软件X 16（2021）1008236图三. Bentheimer砂岩样品的Minkowski函数如图所示。2（a）.这些功能是基于侵蚀图和开放图显示在图2（b）和2（c）。erode_map函数大约需要0.1秒才能完成，functions_open函数需要大约2秒来计算。最后一个示例显示了计算Ben- theimer砂岩样本的两个不同距离图的Minkowski函数该样本的大小为1024 3像素，均匀分辨率为1。每像素53µ m下面的代码片段显示了如何加载数据文件bentheimer. tif ，计算侵蚀和开口距离图，以及确定Minkowski函数。这个例子花了几个小时来计算。 图 2显示了原始样品的横截面、侵蚀距离图和开口距离图。图中的侵蚀距离图。图2（b）中的灰度值与欧几里德距离变换相同，并且较浅的灰度值指示距界面的较大距离。在图中的开口距离图中。如图2（c）所示，灰度值表示适合孔隙空间内部的最大球体的半径。图3不同的闵可夫斯基函数显示的侵蚀和开放的地图。M0至M3的定义如方程所示（4）至（7）。这两条曲线显示了同时逐渐侵蚀所有孔隙（侵蚀图）与从最小孔隙开始逐个孔隙侵蚀孔隙空间（开口图）之间的3. 影响QuantImPy软件包的主要影响是降低了在科学研究中使用Minkowski泛函和函数的障碍。该软件与任何研究问题都相关Arnout M.P.Boelens和Hamdi A.切莱皮软件X 16（2021）1008237其中人们必须关注空间模式以便理解系统的物理特性。可能的应用实例包括但不限于多孔介质中的传输特性[2]、微乳液和胶体悬浮液、流体动力学中的耗散结构、液体晶体的中间相、化学反应中出现的图灵模式[1]、相行为（例如，旋节分解[24]和毛细管冷凝[25]）、纳米涂层[26]、聚合物膜和嵌段共聚物相[27]。此外，该软件包可用于图像分析应用程序，可能与现有的机器学习库结合使用。总的来说，QuantImPy在许多不同的科学和工程领域有非常广泛的应用。4. 结论总 而 言 之 ， QuantImPy 包 的 目 的 是 提 供 一 个 可 以 计 算Minkowski泛函和函数的Python包，该包（i）易于安装，（ii）文档齐全，(iii) 与标准Python库集成，以及（iv）开源。 安装说明可在www.example.com上PyPi.org：https：pypi.org/project/quantimpy/ ， 文 档 可 在 www.example.com 上github.io：https：//boeleman.github.io/quantimpy/的源代码：https：//github.com/boeleman/quantimpy网站。竞合利益作者声明，他们没有已知的竞争性财务利益或个人关系，可能会影响本文报告的工作致谢这项工作得到了非常规和致密油层中水-烃-岩石相互作用机械控制中心（CMC-UF）的支持，该中心是由美国能源部科学办公室根据DOE（BES）奖DE-SC 0019165资助的能源前沿研究中心。此外，作者感谢斯坦福大学Kovscek研究小组的Kelly Guan提供了示例中显示的引用[1] 梅克湾可加性、凸性及其他：闵可夫斯基泛函在统计物理中的应用。在：统 计 物 理 学 和 空 间 统 计 。 Springer;2000 ， p.111-84.http://dx.doi.org/10.1007/3-540-45043-2_6网站。[2] Armstrong RT，McClure JE，Robins V，Liu Z，Arns CH，Schlüter S，等.用闵可夫斯基泛函表征多孔介质：理论、应用和未来方向。Transp多孔介质2018;1-31。http://dx.doi.org/10.1007/s11242-018-1201-4.[3] Noshay A，McGrath JE.嵌段共聚物：综述与评论。Elsevier;2013.[4] Weiner S，Wagner HD.材料骨：结构-力学功能关系。Annu Rev MaterSci 1998;28：271-98. http://dx.doi.org/10.1146/annurev.matsci.28.1.271.[5] 哈 德 维 格 Vorlesungenüber inhalt ， oberfläche und isoperimetrie ， vol. 93.Springer-Verlag; 1957，http://dx.doi.org/10.1007/978-3-642-94702-5。[6] Yamagishi K ， Naruto N ， Mizukami T ， Saito J ， 等 .基 于 gabor 滤 波minkowski泛函和邻域成分分析的ct图像非小细胞肺癌组织学研究广场2021.http://dx.doi.org/10.21203/rs.3.rs-400123/v1网站。[7]Schmalzing J，Górski KM.用于宇宙微波背景各向异性图形态分析的闵可夫斯基泛函。MonNotRAstronSoc1998;297：355-65.http://dx.doi.org/10.1046/j.1365-8711.1998的网站。01467.x。[8]Kerscher M，Schmalzing J，Retzlaff J，Borgani S，Buchert T，GottlöberS，et al. Minkowski functionals of abell/aco clusters. Mon Not R Astron Soc1997;284：73-84. http://dx.doi.org/10.1093/mnras/284.1.73网站。[9]Parroni C，Cardone VF，Maoli R，Scaramella R.深入研究收敛映射的AstronAstrophys 2020;633：A71.网址：//dx.doi.org/10.1051/0004-6361/201935988网站。[10]Vogel H-J，Weller U，Schlüter S.基于闵可夫斯基函数的土壤结构量化。ComputGeosci2010;36：1236-45.http://dx.doi.org/10.1016/j.cageo.2010.03.007。[11]Ohser J，Mücklich F.材料科学中微观结构的统计分析。Wiley and Sons;2000.[12]Mantz H，Jacobs K，Mecke K. 利用闵可夫斯基泛函进行图像分析：一种移动 平 方 算 法 。 JStatMechTheoryExp2008;2008 ： P12015.http://dx.doi.org/10.1088/1742-5468/2008/12/P12015网站。[13]拉格内马尔姆岛通过轮廓处理和距离图的阈值化实现快速腐蚀和膨胀. PatternRecognit Lett 1992;13：161-6. 得双曲正切值. doi.org/10.1016/0167-8655（92）90055-5.[14]Seung Lab. 多 标 记 各 向 异 性 三 维 欧 氏 距 离 变 换 。 2021 年 ，URLhttps://github.com/seung-lab/euclidean-distance-transform-3d。[15]Harris CR ， Millman KJ ， van der Walt SJ ， Gommers R ， Virtanen P ，Courna-peau D，et al. Array programming with numpy. Nature 2020;585：357-62. http://dx.doi.org/10.1038/s41586-020-2649-2网站。[16]van der Walt S，Schönberger JL，Nunez-Iglesias J，Boulogne F，WarnerJD ， Yager N ， et al. Scikit-image ： image processing in Python.PeerJ2014;2：e453. http://dx.doi.org/10.7717/peerj.453网站。[17]Clark A ， et al. Pillow （ pillow fork ） documentation. 2021 ， URLhttps ：pillow.org。[18]亨 特 JD 。 Matplotlib ： 2D 图 形 环 境 。 IEEE Ann Hist Comput 2007;9 ： 90-5.http://dx.doi.org/10.1109/MCSE.2007.55网站。[19]Rosenfeld A，Pfaltz JL.数字图像处理中的顺序操作。J ACM 1966;13：471-94. http://dx.doi.org/10.1145/321356.321357网站。[20]Meijster A，Roerdink JB，Hesselink WH.在线性时间内计算距离变换的一般算法。数学形态学及其在图像和信号处理中的应用。Springer; 2002，p. 331-40. http://dx.doi.org/10.1007/0-306-47025-X_36网站。[21] Felzenszwalb PF ， Huttenlocher DP. 采 样 函 数 的 距 离 变 换 。 理 论 计 算2012;8：415-28。http://dx.doi.org/10.4086/toc.2012的网站。v008a019。[22]数学形态学导论（Introduction to Mathematical Morphology）计算机可视化图形图像处理1986;35：283-305.[23][10]张文辉，张文辉. Cython：两个世界中最好的。计算机科学与工程2010;13：31-9. http://dx.doi.org/10.1109/MCSE.2010.118网站。[24]放大图片Sofonea V，Mecke K.失稳分解动力学的形态学表征。欧洲物理学杂志1999;8：99-112. http://dx.doi.org/10.1007/s100510050672.[25] Boelens AM，Tchelepi HA.拓扑结构对约束条件下相行为的影响过程2021;9：1220。http://dx.doi.org/10.3390/pr9071220网站。[26]张文，等.分形理论与曲面的分形分析.中国科学院学报，2001，14（1）：133 -134氮化钛薄膜。Mater Res Express 2019;6：086463. http://dx.doi的网站。org/10.1088/2053-1591/ab26be。[27]杨伟，王伟，王伟. 剪切和电场作用下嵌段共聚物立方相的细胞动力学模拟。I.球 形 相 JChemPhys2006;125 ： 154905.得 双 曲 正 切 值 .doi.org/10.1063/1.2356468网站。