Bedforms-ATM：自然床形态分析工具包，多尺度建模，动力学特征，开源软件

SoftwareX 7（2018）184原始软件出版物Bedforms-ATM，一个开源软件，用于分析自然床形态罗纳德河，澳-地Gutierreza，b，*，Jose A. Mallmaa，Francisco Núñez-Gonzálezc，Oscar Linkd，Jorge D.阿巴德河a秘鲁利马秘鲁天主教大学b哥伦比亚巴兰基亚北方大学c德国布伦瑞克工业大学d智利康塞普西翁，康塞普西翁大学eUniversidad de Ingeniería y Tecnología，Lima，Peruar t i cl e i nf o文章历史记录：2018年4月1日收到2018年6月7日收到修订版，2018年保留字：床层形态层次结构a b st ra ctBedforms-ATM（Bed forms analysis toolkit for multiscale modeling）是一个用于分层和量化自然床型场的软件它包括四个模块化应用，即：（1）小波分析，（2）Hovmöller分析，（3）多尺度判别，（4）三维分析。Bedforms-ATM还提供了关于床型系统动力学及其与周围流体动力学特征相互关系的见解软件结构通过用户社区的协作鼓励其可扩展性河流和合成床形数据都伴随着Bedforms-ATM。版权所有©2018作者.由爱思唯尔公司出版这是CC BY许可下的开放获取文章（http://creativecommons.org/licenses/by/4.0/）中找到。代码元数据当前代码版本v1.1此代码版本使用的代码/存储库的永久链接https://sourceforge.net/projects/bedforms-atm/，https://github.com/ElsevierSoftwareX/SOFTX_2018_28GNU GPL v3或更高版本使用git的代码版本控制系统使用MATLAB的软件代码语言、工具和服务编译要求、操作环境依赖性Microsoft Windows、Unix如果可用，链接到开发人员文档/手册https://sourceforge.net/projects/bedforms-atm/，https://github.com/rgutierrezl/BedformsATM问题支持电子邮件rgutierrezl@pucp.pe，rgutierrezll@uninorte.edu.co1. 介绍虽然需要区分床层形式尺度（例如，许多研究人员[例如1因此，涟漪和沙丘之间的区别被认为是明显的，许多作者提供了通讯作者：哥伦比亚巴兰基亚北方大学电子邮件地址：rgutierrezll@uninorte.edu.co（R.R. Gutierrez）。https://doi.org/10.1016/j.softx.2018.06.001对他们在实地和实验室研究中所遵循的歧视标准的解释有限或没有解释[1]。参考文献[3]介绍了一种然而，它不能区分二维（2D）和三维（3D）床形特征。[3]提出的技术的结构组成部分服从[4]提出的基于尺度的分类方案。它将波纹定义为波长小于0.6米的特征;沙丘定义为波长阈值为5米、10米和100米的特征，确定了小型、中型和大型沙丘;沙洲定义为波长大于100米的特征的光谱分量2352-7110/©2018作者。由爱思唯尔公司出版这是CC BY许可下的开放获取文章（http://creativecommons.org/licenses/by/4.0/）。可在ScienceDirect上获得目录列表SoftwareX期刊主页：www.elsevier.com/locate/softx*R.R. Gutierrez等人/SoftwareX 7（2018）184185¯¯¯==∈≈∑η（x，y）ij==I=（2）由[5]开发的ysis包ηy， J（xi）的连续小波变换在数学上定义为它与R=nm×ni=1j= 1σx（yi）σxy[3]提出的方法是基于鲁棒样条滤波器和[5]提出的一维连续沉积环境中的床形主要是平面形状上的3D [3]。这一特性导致了局部湍流、阻力系数和沉积物扩散模式的显著差异[6因此，完整的床层形式描述需要区分2D和3D床层形式。为此，[9]提出了一种定量连续度量，称为3维指数（3DI），它在0（严格2D）和1（严格3D）之间变化。3DI（cf. 图1）量化了床形场η（xi，yi）相对于局部横截面平均值ηx（yi）的波动与局部流向平均值ηy（xi）相对于床形场平均值ηxy的波动之间的归一化自相关（等式2）。（1）因此，严格的2D床形具有与流动相对应的平坦波峰，并且横截面轮廓越不规则，3DI的值越大。大多数设计用于分析床型场的计算机程序（例如，[2]）的床型跟踪工具目前尚未公开或已停止使用。在这里，我们提出了Bedforms-ATM（床形式分析工具包多尺度建模），MATLAB开源软件，通过定量描述其层次结构和维度进行床形式字段的变异性分析。本文介绍了Bedforms-ATM的开发和功能的技术方面，并组织如下：第2节描述了本研究中使用的数据处理方法，第3节提供了Bedforms-ATM的功能描述，第4节重点介绍了它的实现，第5节介绍了它在床形和合成床上的应用案例[3]。例如，如果层次1对应于波纹，则θ1， 3 0 的情况。6m，如果等级1对应于小沙丘，θ1， 3五米。最大尺度包括在层级3中，并且根据阈值θ3，3从小波频谱中检索，通常设置为>100m。通过从ηy， J（xi）中减去层级1和层级3一个给定的情况可能会出现三个以上的感兴趣的尺度，即涟漪，小沙丘，中间沙丘，大沙丘，和酒吧。在这种情况下，所描述的程序将首先分别将波纹、沙丘和沙洲区分为等级1、2和3此外，可以在层次2中的中间尺度上再次应用辨别过程，区分小沙丘、中间沙丘和大沙丘。重要的是要注意，应用3所使用的方法是[3]在以下方面提出的方法的优化版本：使用学习曲线以允许在每个层次处进行有效同样，当床形数据被提供为水深场（例如， h（x i，y j）在Fig.1），该应用验证了h1，3（xi，yi）之间的预期弱相关性，即层次1字段，以及平均水深（例如，h<$ x（yJ）图 1）通过使用由[ 3 ]提出的代表层次1和层次2的标准偏差之间的比率的代理参数标度方差比（SVR 1，2）。关于应用1、2和3的方法的详细信息，请读者参考[3]和Bedforms-ATM用户手册中的流程图三维分析（应用4）通过使用由[9]提出的3DI定义来执行（等式4）。（1）∑nη（x i，y j）第6节讨论了它的潜在影响。最后，第7节概述了本研究的主要结论2. 背景η<$ y（xi）=j=1∑m1η（xi，yj）（一个）图1示出了近似等间隔的（即，（x恒定）高程床型剖面η（xi，y，J）η（xi，y，j），在本文中也由矢量ηy， J（xi）表示。该软件执行每个床形剖面的小波分析（应用1），η<$ xy=ni=1mj=1m× n（三）η（x， y）的一维连续小波分析我J1 ∑∑[（η（xi，yi）−η<$ x（yi））（η<$ y（xi）−η<$ xy）]连续小波函数在蒙特卡洛表演肛交-ysis，[5]估计的经验因子允许确定局部小波功率谱（即，小波变换的模）及其影响锥（即，区分可靠和虚假局部功率谱结果的除法器）。这是连续小波函数，如Morlet，Paul，Marr和高斯的导数，在给定的置信水平。因此，获得了沿ηy， J（xi随后，小波谱提供了关于ηy， J（xi）的主成分波长的信息。有关小波变换在床形变化分析中应用的技术细节，请读者参考[5]和[3应用2（幂Hovmöller分析）是应用1的扩展 [5]。基本上，PowerHovmöller分析允许通过使用基于连续小波的高通滤波器和低通滤波器传递床形轮廓来定位ηy， J（xi）中位于特定波长间隔中的床形特征，所述高通滤波器和低通滤波器由该间隔定义。因此，通过将该过程应用于η（xi，yi）中的每个床形剖面，映射这些特征的位置在床形场域上[3]。应用3（基于尺度的辨别）允许通过设置两个波长阈值θ1， 3和θ3， 3从ηy， J（xi）获得三个层次。最小的尺度包含在层次1中，它是根据所提出的结构标准确定的其中，σx（yi）和σxy是局部流向标准差以及对于i 1，2，. . . ，m和j1，2，. . . ，n. 因此，3DI（Tb）由等式2定义（五）、Tb=1−R2（5）随后，由节点η（xi，y j）和η（xi+1，y j+1）限制的分辨率单元的平均3DI（图1A和1B）被计算。1-a和1-b），通过在任意固定长度Lx的空间窗口上估计Tb，其中Ly以这样的分辨率单元为中心来最后得到了整个床面形状场的Tb等值线重要的是要注意，上述过程排除了床形场外围的分辨率单元;尽管该算法使此类单元的数量最小化。3. 软件框架3.1. 软件构架Bedforms-ATM应用程序被构建为以连续序列运行。这是因为应用程序2的一些输入数据是应用程序1∑η<$ x（yi）=（四186R.R. Gutierrez等人/SoftwareX 7（2018）184=−图1.一、 底形场离散化示意图。（a）由具有近似恒定分辨率单元尺寸的结构化网格表示的矩形场η（xi，yj），对于（i;j）=（1，. . .，m; 1，. . .，n），其中，nx不一定等于ny。(b)文[3]提出的三层底形判别方案（当j=J时，本文也用矢量ηy， J（xi）表示底形剖面η（xi，yJ）∈η（xi，yj）根据命名法由[3]提出的，来自这样的床形轮廓的矢量式层次1、2和3分别是ηy， J（xi），ηy， J（xi），ηy， J（xi这种表示法也适用于床型第1、 3条二、三三，三由水深测量值定义的场h（x i，y j）。（c）弯曲的床形场，通过将直角坐标转换为流向s和法向n局部坐标进行分析因此，分辨率单元是梯形的，其中s j+1>s j，并且n=n i，j+1−n i，j是常数，前提是sjs i，j s i+1，j，因此，所有床形剖面具有相同的样本量m。矩形和弯曲场的合成床形数据作为本文的随附信息提供（参见附录A，补充文件1，第2节）。数据来自申请1和3（参见附录A，补充文件1，第1节）。然而，所有这些应用程序都在一个MATLAB平台上提供。输入数据从应用程序1的界面收集如果不满足这些条件，程序将被阻止运行。）这些矢量可以用相对的（即，局部流向坐标和海拔或水深）或绝对坐标（即，东距、北距和高程或水深）保存在TXT或MAT文件扩展名中。另外，输入数据可以作为单元阵列MAT文件提供，该单元阵列MAT文件包含每个单元中的3.2. 软件功能应用程序1输入数据，执行运行时测试（对于大数据），然后运行应用程序。它还强调了已成功完成的步骤我们预见到，Bedforms-ATM的许多潜在用户可能不熟悉小波分析的理论背景;因此，应用程序1因此，它指导用户适当选择小波分析的显著性水平和频率增量;同样，它允许使用两组小波函数，即：（1）高斯的导数，其中二阶导数，即Ricker小波函数或所谓的墨西哥帽小波函数，已被广泛用于地球物理信号的分析[3];和（2）Morlet函数，其最适合于分析床形变化[3]。如果选择后一小波函数，则界面引导用户正确选择Morlet此外，它允许用户设置输出设置（例如，图标题、信号名称、信号单位、样品名称和样品单位）。最后，用户可以选择文件格式（例如，MATLAB fig、jpg、tiff或PDF），应用程序的输出将保存在其中。当运行时间R.R. Gutierrez等人/SoftwareX 7（2018）184187测试表明这将需要很长一段时间，应用程序建议用户将输出打印到MAT文件，并提供了一个功能，稍后打印，这将导致减少计算时间。应用程序2在多个位置执行小波功率谱的尺度平均（图1）。附录A，补充文件1中的5），因此，可以评估床形断面的场的空间变异性该应用程序估计适当的波长间隔以执行功率Hovmöller分析，该分析在其界面中呈现，从而避免分析低密度尺度种群或不存在的尺度。最后，应用程序2以jpg、tiff或PDF格式将输出打印到文件由于代码是开放的，高级用户可以修改它，以包括其他格式，如eps格式。应用3呈现了由[4]建议的结构分类方案的图，并且一旦选择了输入文件（即，应用程序1此外，当在水深场上执行整个分析时，该应用程序允许用户选择SVR1，2和SVR2，3之间的互相关分析，以及每个床形剖面处的平均水深，如图2所示。该操作表示对识别输出的基于物理的评估最后，应用程序将输出打印到扩展名为PDF和MAT的文件中此外，它还可以导出为TecplotR输入格式文件。应用程序4允许用户选择：（1）分析字段，即：床型字段n（xi，yj），或从应用程序3获得的层次之一;以及（2）将执行分析的子域。应用程序建议窗口大小，在该窗口大小上，针对用户选择的层次结构以及床形式字段对Tb进行积分此外，用户可以选择以PDF、MAT或TecplotWAR文件格式打印输出。4. 执行该程序以及相应的用户手册和来自巴拉那河的测试数据（150个河床形态剖面）可在https://sourceforge.net/projects/bedforms-atm/上免费获得，并可轻松下载和安装。此外，可以从https://github.com/rgutierrezl/BedformsATM获得相同的信息。[10]提供了用于测试程序的曲线图和矩形图的合成数据有关上述数据的技术详细信息，请参见附录A，补充文件1，第2解释性视频可在www.pucp.edu.pe/tnbVV8上获得，也可在附录A，补充文件2中找到Bedforms-ATM分为四个界面。要调用它们，用户应该从MATLAB控制台执行以下脚本：• BedformsATM_App1_WaveletAnalysis.m• BedformsATM_App2_HovmollerAnalysis.m• BedformsATM_App3_ScaleBasedDiscrimination.m• BedformsATM_App4_3DAnalysis.m5. 说明性实例使 用 [11] 中 巴 拉 那 河 的 现 场 数 据 和 [10] 中 的 合 成 数 据 对Bedforms-ATM进行了测试如附录A，补充文件1，第3节所示，软件在前一数据上的应用有效地提供了河床形态波长光谱的空间分布信息（应用1和应用2）图 2显示了应用程序3针对巴拉那河的输出。图2-a示出了居中的第一层级（即，小沙丘，h1，3），和图。 2-b表示居中的第二层次（即，中型和大型沙丘，h2，3），当与[3]给出的输出相比时，其显示出较少的噪声，因为该算法分布了该方法的所得偏差方差误差。类似地，图2-c示出了第三层次（即，条，h3，3）表现出明显比[3]所呈现的噪声更小的输出。第一和第二层次之间的尺度方差比（SVR1，2，图2-d）证实了预期的与水深的弱相关性，这可以通过h1，3主要由局部湍流引起的事实来解释。相反，SVR2，3（图2-d）显示与水深有很强的相关性，因为较大的床形尺度受河流环境中水力条件的控制[3]。图 3-a显示了在h（x i，y j）上执行分析时巴拉那河的应用程序4输出，其中输出的有效面积小于h（x i，y j）的有效面积。在分析中使用不同的积分窗口大小，从而获得不同程度的平滑输出。这源于这样一个事实，即类似于Parzen窗口的应用，窗口越大，输出越平滑因此，没有一个单一的窗口宽度是理想的整体，因为一些大小允许在某些区域获得信息，而在其他区域丢失[12]。用户可以根据他/她的兴趣直观地选择他/她认为最好的输出，如图所示。 3-b，因此可以进行局部分析（图2）。 3-c）。巴拉那河河床形态的三维分析表明，高Tb值（即明显的三维河床形态）主要集中在较深区域，这可能是因为三维河床形态在一定程度上控制了雷诺应力、阻力系数和沉积物扩散模式[7]。6. 影响尽管气象模型通常是用客观的科学严谨的方法进行观测测试的，但许多形态模型是通过建模者的主观判断或均方得分（即平均值）进行评估的。Brier技能评分），其中选择初始床作为参考[13，14]。在这篇文章中，应用程序3的效率进行了分析，并提出了客观的统计，通常用于评估气象模型的基础上它成功地应用于合成和河流床形态，[15]报告了Bedforms-ATM区分丹麦Grådyb潮汐通道入口海底形态特征的有效性，这是以前研究的[16]。因此，根据结果（见附录A，补充文件1，第4节），通过耦合小波和Hovmöller分析和3DI的能力，Bedforms-ATM提供了一个有效的框架来分析不同沉积环境的床形特征的变化它是按照面向对象和用户友好软件的最佳实践进行编码的，这允许在单个平台中分析床形数据集，而在用户不熟悉小波分析的情况下，所有的应用程序都指导他们选择合适的参数，以提供合理的结果。同样，软件的图形输出可以导出为出版质量分辨率的矢量图形。我们将Bedforms-ATM设计为模块化和简单的从而允许软件的可扩展性我们期待并鼓励用户社区开发新的应用程序在这种情况下，任何反馈（例如，bug报告、进一步开发的建议、贡献的代码片段甚至是现成的插件）都有益于用户社区[17]。软件的可用性通过发布测试版进行了测试。pMATLAB文件，这不像。m格式文件，不能188R.R. Gutierrez等人/SoftwareX 7（2018）184图二、阿 根 廷 巴 拉 那 河 的 河床（从左到右流动）。（a）层次1：中心小沙丘（h1，3），（b）层次2：中心中型和大型沙丘（h2，3），（c）层次3：酒吧（h3，3），（d）SVR1，2，（e）SVR2，3。在所有情况下，坐标都以米为单位。图三. Bedforms-ATM应用程序4在整个域中从巴拉那河输出（a）h（xi，yj），以及在（b）中选择的子域及其相应的输出（c）。在所有情况下，轮廓表示3DI，Tb，使得Tb的值越高，三维度越高。编辑。还提供了错误报告表收到的报告很少，目前的版本纠正了所报告的错误。最后，本文给出的结果提供了有价值的信息，为科学和实际应用。对于前一个应用，例如，当耦合到河流形态动力学模型时，它可以增强我们对本文所区分的三个层次之间的相互关系的理解。对于后一种应用，它可能被用来估计每个层次的输入在全球粗糙度的河段或执行水深减少洪水和通航建模相关7. 结论大多数旨在分析河流和海洋环境中的床形的计算机程序不是公开可用的，就是已经停止使用。床型分析多维建模工具包（Bedforms-ATM）可能填补了这一空白，并且，根据我们在河流和合成床型领域应用软件的结果，我们相信它有可能用作床型维度分析和基于尺度的判别的初始标准框架，并为床型系统动力学的理解提供有价值的见解，R.R. Gutierrez等人/SoftwareX 7（2018）184189它们与周围流体动力学特性的相互关系Bedforms-ATM在这里作为一个开放源代码软件，其结构被设计为通过用户社区的协作来鼓励其可扩展性该软件将大大受益于未来的MATLAB代码的并行计算和GPU，不幸的是，没有提供在这个版本。致谢我们非常感谢秘鲁天主教大学土木工程学院允许启动这项研究。我们感谢 Katholischer Akademischer Ausländer-Dienst（ KAAD-PUCP 2015-II）资助Gutierrez博士在布伦瑞克技术大学（德国）短暂我们非常感谢来自以下方面的请求：（1）Gilbert Compo博士和Christopher Torrence博士使用他们开发的小波编码，以及（2）Daniel Parsons博士和Jim Best博士将巴拉那河的床形数据作为Bedforms-ATM的附带信息。Bedforms-ATM是作为GERDIS-PUCP研究线4的一部分开发的附录A. 补充数据与本文相关的补充材料可以在https://doi.org/10.1016/j.softx.2018.06.001上找到。引用[1] 放大图片Jerolmack D，Mohrig D.河床形态之间的相互作用：地形、湍流和输运。地球物理研究杂志2005;110：1http://dx.doi.org/10.1029/2004JF000126.[2] van der Mark CF，Blom A，Hulscher JSM.底形几何变化的量化。地球物理研究杂志2008;113：1http://dx.doi.org/10.1029/2007JF000940。[3] 古铁雷斯RR，阿巴德JD，帕森斯DR，最好的JL。使用鲁棒样条滤波器和小波变换识别河床形态尺度：阿根廷巴拉那河合成信号和河床形态的方法和JGeophys Res 2013;118 （ 3 ） ： 1400http://dx.doi.org/10.1002/jgrf.20102 网站。[4] 阿什利通用。大尺度水下底形分类：一个老问题的新认识。沉积物石油杂志，1990;60（1）：160-72。[5] TorrenceC，Compo GP。小波分析实用指南 BullAm MeteorolSoc1998;79：61-78.[6] Maddux TB，Nelson JM，McLean SR.三维沙丘湍流自由表面和流动响应。地球物理研究杂志2003;108（F1）：1http://dx.doi.org/10.1029/2003JF0网站。[7] 河 流 沙 丘 的 流 体 动 力 学 ： 回 顾 和 未 来 的 研 究 方 向 .地 球 物 理 研 究 杂 志2005;110：1-21. http://dx.doi.org/10.1029/2004JF000218.[8] 文 迪 蒂 固 定 二 维 和 三 维 沙 丘 上 的 紊 流 和 阻 力 J Geophys Res 2007;112（F4）：1-21，f04008.http://dx.doi.org/10www.example.com.1029/2006JF000650。[9] Núñez-González F，Hesse D，Ettmer B，Kume E，Link O.床型三维指数客观排序法。2014年：《河流》。2014.p. 1059-65[10] 古铁雷斯用于多尺度建模的底形分析工具包（Bedforms-ATM）的合成数据;2017年。http://dx.doi.org/10.1594/PANGAEA的网站。873304[11] 帕森斯博士，最佳JL，奥菲奥O，哈代RJ，科斯塔丘克R，巷SN。阿根廷巴拉那河三维沙丘的形态学和流场：来自同步多波束回声探测和声学多普勒海流剖面的结果地球物理研究杂志2005;110：1-9.http://dx.doi.org/10.1029/2004JF000231网站。[12] 放大图片作者：Richard D.模式分类。第2版Wiley;2001.[13] Bosboom J，Reniers A，Luijendijk A.论形态动力学模型技巧的感知。CoastEng2014;94：112-25.[14] Sutherland J，Peet A，Soulsby R.评估形态学模型的性能。Coast Eng2004;51（8）：917-39.[15] Gutierrez RR，Abad JD，Mallma JA.一种改进的基于小波的床形尺度判别工具在：第九届研讨会的河流，沿海和河口形态动力学的会议记录; 2015年。p. 1比3。[16] ErnstsenVB ， Noormets R ， Winter C ， Hebbeln D ， Bartholomä A ，Flemming BW ， et al. Development of subaqueous barchanoid-shapeddunes due to lateral grain size variability in a tidal inlet channel of thedanishwaddensea.JGeophysRes2005;110 （ F4 ） ： 1-13.http://dx.doi.org/10.1029/2004JF000180网站。[17] Janoušek V，Farrow CM，Erban V.火成岩地球化学中全岩地球化学数据的解释：介绍地球化学数据工具包（GCDkit）。岩石学杂志2006;47（6）：1255-9.