目录
项目概述
GIBBON(几何和基于图像的生物工程附加组件)是一个开源 MATLAB 工具箱,包含一系列图像和几何可视化及处理工具,并与免费开源软件如 TetGen(用于稳健的四面体网格划分)和 FEBio(用于有限元分析)相连接。这种组合提供了一个高度灵活的基于图像的建模环境,并支持高级反向有限元分析。
应用亮点
分割
GIBBON 提供图像滤波和平滑方法,并有用于 3D 图像分割的图形用户界面(HELP_imx.m
)。分割后的图像数据可以转换为 3D 表面模型(DEMO_imx_levelset_surface_compare
),然后可以进行网格划分用于有限元分析(HELP_runTetGen
)。
计算机辅助设计(CAD)工具
使用 GIBBON,可以从常见的基于网格的 CAD 文件(如 STL,HELP_import_STL
)导入几何。为了在 MATLAB® 内生成几何,GIBBON 还提供了几种 CAD 风格的命令,如多边形圆角(HELP_filletCurve
)、旋转(HELP_polyRevolve
)、拉伸(HELP_polyExtrude
)以及扫描和放样(HELP_polyLoftLinear
和 HELP_sweepLoft
)。简单的几何体,如球体(HELP_geoSphere
)、立方体(HELP_quadBox
)、柏拉图立体(HELP_platonic_solid
)和菱形十二面体(HELP_rhombicDodecahedron
)也可以直接使用 GIBBON 创建。
表面网格划分工具
2D 多区域三角形网格划分(如 HELP_regionTriMesh2D
和 HELP_multiRegionTriMeshUneven2D
),测地线重采样网格(DEMO_geodesic_remeshing
),平滑(DEMO_surface_smooth_methods
),和表面网格细化(如 HELP_subtri
、HELP_subTriDual
和 HELP_subQuad
),网格类型转换(如 HELP_tri2quad
、HELP_quad2tri
),以及网格对偶计算(HELP_patch_dual
)。几何体还可以导出为 STL 格式,用于计算机辅助制造和 3D 打印。
体积网格划分
多区域域的四面体网格划分(和约束Delaunay剖分)通过与TetGen包的接口实现(HELP_runTetGen
和HELP_constrainedDelaunayTetGen
)。某些几何类型的六面体网格可以直接编码(例如球体HELP_hexMeshSphere
、立方体HELP_hexMeshBox
和晶格HELP_element2HexLattice
)。对于一般输入表面,还可以使用多区域混合四面体-六面体网格划分(例如DEMO_MixedTetHexMeshing
)。
晶格结构
生成晶格表面几何的一种方法是使用三周期函数(HELP_triplyPeriodicMinimal
)。还实现了将元素描述(如四面体和六面体元素)转换为晶格结构的函数(HELP_element2lattice
和HELP_element2HexLattice
)。这些允许在任意输入几何上创建3D边界适应晶格结构。还支持导出六面体元素,允许对创建的晶格结构进行有限元分析(DEMO_febio_0026_hexlattice_compression
)。
有限元分析
对于有限元分析,GIBBON目前可以链接免费开源软件FEBio或Simulia ABAQUS。FEBio和ABAQUS接口都基于MATLAB®结构。下图显示了在MATLAB®结构中编码材料部分(上排)以及这些组件在FEBio或ABAQUS输入文件中的表示(下排)。通过这种结构到输入文件的转换过程,任何FEBio或ABAQUS功能都可以直接在MATLAB®中编码。
FEBio
GIBBON可以用作FEBio的预处理和后处理工具,因为它能够基于代码开发网格、边界条件和输入文件。可以直接基于专用MATLAB®结构导出FEBio文件(HELP_febioStruct2xml
)。此外,GIBBON可用于启动和控制FEBio模拟。因此,也可以进行迭代和反向有限元分析(例如基于MATLAB®优化例程)。所有DEMO_febio_...
文件都是FEBio演示,例如DEMO_febio_0001_cube_uniaxial
是一个简单的单轴加载示例,而DEMO_febio_0042_inverse_FEA_cube_uniaxial
是反向有限元分析的示例。
下图展示了扭转杆的大变形分析,源自演示DEMO_febio_0004_beam_twist
。其他演示涵盖了拉伸、压缩、剪切、施加力、施加压力、施加位移、弯曲、孔弹性、动态和粘弹性分析、接触和压痕问题、用于预加载分析的多代材料。
可视化
GIBBON扩展了MATLAB®的标准可视化功能,增加了3D图像和体素可视化(HELP_im2patch
和HELP_sliceViewer
)、网格几何体(HELP_gpatch
和HELP_meshView
)、有限元模型(HELP_element2patch
)以及带颜色映射的矢量数据(HELP_quiverVec
)。所有可视化方法都允许在每个图形或坐标轴窗口中使用多个颜色映射。此外,GIBBON提供了自定义图形窗口cFigure
,包含模仿CAD行为的3D旋转选项(HELP_vcw
)和高质量图形导出选项(HELP_efw
)。还通过基于图形窗口的GUI实现了高级图形动画创建和导出功能(HELP_anim8
)。
安装
概要
- 下载GIBBON
- 只需运行:
installGibbon.m
(位于GIBBON的主文件夹中),并在安装过程中提供FEBio安装位置的链接
详细安装说明
以下步骤将指导您使用installGibbon.m
函数进行简化的安装过程*。
*如果您更喜欢手动安装,请执行以下操作:1) 将GIBBON文件夹(包括子文件夹)添加到路径并保存路径定义,2) 运行createHelpDemoDocumentation.m
以集成帮助和文档,3) 对于第三方软件包:进入_../GIBBON/config_的config文件夹,编辑_FEBioPath.txt_文件,使其包含FEBio可执行文件的完整路径
1. 获取GIBBON副本
要使用GIBBON,您需要在本地目录中创建一个副本。您可以通过下载并解压最新的zip文件来获取副本,或者使用以下命令克隆GIBBON:git clone https://github.com/gibbonCode/GIBBON.git
。您可以将GIBBON文件夹放在计算机的任何位置,但是MATLAB(以及下面列出的第三方软件包)可能对某些位置有文件权限限制,您可能需要解决这些问题*。
* 例如,GIBBON的一些功能,如与TetGen和FEBio相关的功能,会定期创建和删除临时文件。因此,MATLAB(和第三方软件包)应对这些文件夹具有完全权限。首先,用户应确保MATLAB对整个GIBBON文件夹(及其子文件夹)具有完全(例如读/写/删除)权限。在某些平台上,第三方软件包可能需要特殊处理。例如,一些OSX用户发现有必要为tetGen或FEBio授予特定的文件权限。比如,对于TetGen相关功能,使用git update-index --chmod=+x path/to/tetgen
。
2. 设置第三方软件包
以下是完整功能所需的第三方软件包列表。除了FEBio之外,所有软件包都包含在GIBBON中,用户需要下载并安装FEBio。如果不需要有限元分析(使用FEBio),可以跳过FEBio的安装。
软件包 | 描述 | 是否包含? | 下载 |
---|---|---|---|
FEBio | FEBio是一个有限元求解器,在GIBBON中用于所有有限元分析。FEBio的使用在许多DEMO_FEBio... 文件中有所展示。推荐使用FEBio 2.5.0或更新版本。 | 否 | FEBio网站 |
export_fig | export_fig 有助于导出出版质量的图像(如.png、.jpg、.pdf、.eps),在GIBBON中,它被集成到导出图形小部件efw 中,可以直接从cFigure 窗口导出此类图像。export_fig 还用于导出图像以创建.gif动画,这可以通过GIBBON的anim8 函数实现。 | 是 | GitHub上的export_fig页面 |
TetGen | 用于四面体网格划分(可能还包括受约束的3D Delaunay剖分)。例如,请参见HELP_runTetGen.m 。 | 是 | 其他版本:TetGen网站 |
2. 安装GIBBON
通过运行installGibbon.m
,GIBBON、FEBio和export_fig的路径定义将被添加并保存到MATLAB中。帮助和文档也将被集成。完成后,系统会要求您重新启动MATLAB。installGibbon.m
可以在GIBBON的主文件夹中找到。
开始使用
访问集成帮助
- 要从MATLAB访问帮助文档,只需输入:
gdoc
,这将在MATLAB的帮助浏览器中打开GIBBON文档页面。该文档可以搜索,并像MATLAB的其他帮助和文档一样集成。您也可以在"补充软件"下手动找到此页面,如下所示。 - 要打开特定函数的GIBBON文档,可以使用
gdoc <函数名>
(类似于MATLAB的doc
函数)。例如,要获取im2patch
的帮助,使用gdoc im2patch
。这将在集成帮助中搜索im2patch并显示结果。
在哪里找到函数和可执行的帮助和演示文件
-
lib
文件夹包含所有GIBBON的函数。 -
lib_ext
文件夹包含由他人开发的外部函数和库。 -
docs
文件夹包含帮助和文档文件,以及演示文件,这些文件在"发布"时(使用MATLAB的发布功能)会创建.html文档文件(位于docs/html
中),这些文件被集成到MATLAB中。 -
任何函数
functionName
的帮助信息源文件名为HELP_functionName
,演示的源文件名中包含DEMO_
。因此,如果对重现或从帮助和文档中的代码开始感兴趣,只需在MATLAB命令窗口中输入以HELP_
或DEMO_
开头的代码名称,例如,HELP_ind2patch
可用于生成ind2patch
函数的帮助信息。用户可以通过在命令窗口中输入open HELP_ind2patch
来开始编辑文件。通过发布(使用gpublish <HELP_functionName>
)HELP_或DEMO_文件,会在docs\html
文件夹中创建.html文件。因此,如果用户修改或贡献lib
文件夹中的代码并生成相关的HELP_
或DEMO_
文件,新的帮助和文档就会被添加并在网站上呈现。要使新的帮助和文档集成到MATLAB中,请运行createHelpDemoDocumentation
函数并重启MATLAB。 -
许多
DEMO_
文件都集中于FEBio的使用。例如,DEMO_febio_0001_cube_uniaxial
演示了一个简单的立方体受单轴载荷的情况。其他演示则关注不同的载荷类型、单步与多步分析、不同材料和反向分析(例如DEMO_febio_0042_inverse_FEA_cube_uniaxial
)。
测试
可以通过运行 testGibbon('all','test');
来测试 GIBBON 的核心功能。使用 testGibbon('demo','test');
或 testGibbon('help','test');
仅运行演示或帮助文件。
GIBBON 目前使用最新版本的 MATLAB(或最新预发布版)进行开发和测试,并已在 Windows 10、Ubuntu 20.04 和 Mac OS 上进行了测试。GIBBON 的大部分功能与旧版 MATLAB 兼容,特别是 MATLAB R2014a 及更新版本(Delaunay 剖分和工具箱帮助集成等功能已经发生了重大变化)。如果某个特定功能不适用于您的 MATLAB 环境,请告知开发人员(或提出问题)。代码很可能可以轻松修改以适用于您的版本。
GIBBON 的大部分功能不依赖于特殊的 MATLAB 工具箱。但是有些函数确实需要。以下是 GIBBON 中使用的工具箱列表:
- 图像处理工具箱
- 统计和机器学习工具箱
- 符号数学工具箱
- 曲线拟合工具箱
- 并行计算工具箱
许可证
GIBBON 的使用遵循以下许可: 。许可证文件可在 GitHub 存储库中找到。
引用 GIBBON
Moerman, (2018). GIBBON: The Geometry and Image-Based Bioengineering add-On. Journal of Open Source Software, 3(22), 506, https://doi.org/10.21105/joss.00506
贡献
我们非常欢迎您为 GIBBON 做出贡献,甚至加入开发团队!我们欢迎各种形式的贡献,包括技术内容、文档开发或网站改进。请阅读我们的贡献指南。
您也可以通过 Gitter 聊天提出问题并了解更多关于贡献的信息:
行为准则
请参阅 CODE_OF_CONDUCT
路线图
请参阅 ROADMAP