Open3D

本文集文档发布于灏天文库

4.2 Open3D 扩展与贡献

文档摘要

4.2 Open3D 扩展与贡献 第四章 4.2 Open3D 扩展与贡献：深度解析与实践指南 Open3D 作为一个强大的开源库，在 3D 数据处理领域占据着重要的地位。其模块化、高效的设计，以及友好的 Python 和 C++ 接口，吸引了大量的研究人员和开发者。为了满足日益增长的应用需求和不断涌现的新技术，Open3D 鼓励用户进行扩展与贡献，共同构建一个更加完善、强大的 3D 数据处理生态系统。 4.2.1 Open3D 扩展机制概述 Open3D 的设计理念之一就是可扩展性。它提供了多种扩展机制，允许用户根据自身需求定制和增强 Open3D 的功能。

4.2 Open3D 扩展与贡献

第四章 4.2 Open3D 扩展与贡献：深度解析与实践指南

Open3D 作为一个强大的开源库，在 3D 数据处理领域占据着重要的地位。其模块化、高效的设计，以及友好的 Python 和 C++ 接口，吸引了大量的研究人员和开发者。为了满足日益增长的应用需求和不断涌现的新技术，Open3D 鼓励用户进行扩展与贡献，共同构建一个更加完善、强大的 3D 数据处理生态系统。

4.2.1 Open3D 扩展机制概述

Open3D 的设计理念之一就是可扩展性。它提供了多种扩展机制，允许用户根据自身需求定制和增强 Open3D 的功能。主要的扩展方式可以归纳为以下几个方面：

  • Python 扩展: 利用 Python 语言的灵活性和丰富的生态，可以快速实现一些高层次的应用逻辑和算法原型。Open3D 提供了 Python 绑定，使得用户可以使用 Python 脚本调用 Open3D 的核心功能，并在此基础上进行二次开发。

  • C++ 模块开发: 对于性能敏感型应用或者需要深入底层算法优化的场景，C++ 是更合适的选择。Open3D 的核心库是用 C++ 编写的，用户可以基于 C++ 接口开发新的模块，并将其集成到 Open3D 中。

  • 数据格式支持扩展: Open3D 默认支持多种常用的 3D 数据格式，但随着新的数据采集技术和应用场景的出现，可能需要支持新的数据格式。Open3D 允许用户扩展其数据读取和写入能力，以适应不同的数据来源。

  • 算法与功能扩展: Open3D 提供了丰富的 3D 数据处理算法，但仍然存在许多领域可以进行扩展，例如新的几何处理算法、渲染技术、机器学习模型集成等。用户可以根据自己的研究方向和应用需求，开发新的算法和功能模块，并将其贡献到 Open3D 社区。

mermaid

4.2.2 Python 扩展实践与详解

Python 扩展是 Open3D 最为便捷的扩展方式之一。利用 Python 语言的简洁性和丰富的库支持，用户可以快速构建基于 Open3D 的应用，并实现一些定制化的功能。

4.2.2.1 基于现有 Open3D 功能的 Python 扩展

最简单的 Python 扩展方式是利用 Open3D 提供的 Python API，将多个 Open3D 功能组合起来，实现更复杂的工作流程或者应用场景。

代码实践示例：点云降采样与法线估计可视化

假设我们需要对一个点云进行降采样，并估计其法线，然后将结果可视化。利用 Open3D 的 Python API，我们可以轻松实现这个功能：

import open3d as o3d
import numpy as np
# 1. 读取点云数据
pcd = o3d.io.read_point_cloud("path/to/your/point_cloud.ply")
# 2. 点云降采样 (体素降采样)
voxel_size = 0.02  # 体素大小
downsampled_pcd = pcd.voxel_down_sample(voxel_size=voxel_size)
print(f"原始点云点数: {len(pcd.points)}")
print(f"降采样后点云点数: {len(downsampled_pcd.points)}")
# 3. 法线估计
radius_normal = 0.1  # 法线估计的搜索半径
max_nn = 30          # 法线估计的最大近邻点数
downsampled_pcd.estimate_normals(search_param=o3d.geometry.KDTreeSearchParamHybrid(radius=radius_normal, max_nn=max_nn))
downsampled_pcd.orient_normals_towards_camera_location(camera_location=np.array([0., 0., 0.])) # 法线方向对齐相机
# 4. 可视化
o3d.visualization.draw_geometries([downsampled_pcd],
                                   zoom=0.8,
                                   front=[0.645, -0.749, -0.109],
                                   lookat=[2.468, 2.018, 1.771],
                                   up=[-0.174, -0.009, 0.985],
                                   point_show_normal=True) # 显示法线
​

代码详解：

  1. import open3d as o3d: 导入 Open3D 库，并将其别名为 o3d，方便后续调用。

  2. pcd = o3d.io.read_point_cloud(...): 使用 o3d.io.read_point_cloud 函数读取指定路径的点云数据。Open3D 支持多种点云格式，如 PLY, PCD, OBJ 等。

  3. downsampled_pcd = pcd.voxel_down_sample(...): 使用 voxel_down_sample 函数进行体素降采样。voxel_size 参数控制体素的大小，体素越大，降采样程度越高。

  4. downsampled_pcd.estimate_normals(...): 使用 estimate_normals 函数估计点云的法线。search_param 参数定义了法线估计的搜索策略，这里使用了混合搜索策略 KDTreeSearchParamHybrid，结合了半径搜索和近邻点搜索。

  5. downsampled_pcd.orient_normals_towards_camera_location(...): 调整法线方向，使其朝向相机位置，方便可视化。

  6. o3d.visualization.draw_geometries(...): 使用 draw_geometries 函数可视化点云。point_show_normal=True 参数设置显示点云的法线。

这个简单的例子展示了如何利用 Open3D 的 Python API，将点云读取、降采样、法线估计和可视化等功能组合起来，完成一个基本的 3D 数据处理流程。用户可以根据自己的需求，灵活地组合 Open3D 提供的各种功能，构建更复杂的 Python 应用。

4.2.2.2 Python 函数封装与模块化

为了提高代码的可重用性和可维护性，我们可以将常用的功能封装成 Python 函数或者模块。

代码实践示例：封装点云滤波函数

假设我们需要经常使用基于统计滤波的点云去噪功能。我们可以将其封装成一个 Python 函数：

import open3d as o3d
def statistical_outlier_removal_filter(pcd, nb_neighbors=20, std_ratio=2.0):
    """
    使用统计滤波去除点云离群点.
    Args:
        pcd (open3d.geometry.PointCloud): 输入点云.
        nb_neighbors (int): 近邻点数量.
        std_ratio (float): 标准差倍数阈值.
    Returns:
        open3d.geometry.PointCloud: 滤波后的点云.
    """
    cl, ind = pcd.remove_statistical_outlier(nb_neighbors=nb_neighbors,
                                                std_ratio=std_ratio)
    return cl
# 使用封装的函数
pcd = o3d.io.read_point_cloud("path/to/your/point_cloud.ply")
filtered_pcd = statistical_outlier_removal_filter(pcd, nb_neighbors=30, std_ratio=1.5)
o3d.visualization.draw_geometries([pcd, filtered_pcd],
                                   zoom=0.8,
                                   front=[0.645, -0.749, -0.109],
                                   lookat=[2.468, 2.018, 1.771],
                                   up=[-0.174, -0.009, 0.985],
                                   window_name="原始点云 vs 滤波后点云")
​

代码详解：

  1. def statistical_outlier_removal_filter(...): 定义了一个名为 statistical_outlier_removal_filter 的 Python 函数，接受点云、近邻点数量和标准差倍数阈值作为参数。

  2. cl, ind = pcd.remove_statistical_outlier(...): 函数内部调用 Open3D 的 remove_statistical_outlier 函数进行统计滤波。该函数返回滤波后的点云 cl 和离群点索引 ind。

  3. return cl: 函数返回滤波后的点云。

通过将统计滤波功能封装成函数，我们可以在不同的 Python 脚本中重复使用这个功能，提高了代码的模块化程度和可维护性。用户可以将常用的扩展功能封装成 Python 模块，方便管理和共享。

4.2.3 C++ 模块开发实践与详解

对于需要高性能或者需要深入底层算法优化的场景，C++ 模块开发是更合适的扩展方式。Open3D 允许用户使用 C++ 编写新的模块，并将其编译成共享库，然后在 Python 中调用。

4.2.3.1 C++ 模块开发基本流程

开发 Open3D C++ 模块的基本流程如下：

  1. 环境配置: 确保已经安装了 Open3D 的开发环境，包括 CMake, C++ 编译器等。

  2. 创建 C++ 模块项目: 创建一个新的 CMake 项目，用于存放 C++ 模块的源代码和 CMake 配置文件。

  3. 编写 C++ 代码: 实现新的 3D 数据处理算法或功能，并将其封装成 C++ 类或函数。

  4. 编写 Python 绑定: 使用 Pybind11 库编写 Python 绑定代码，将 C++ 代码暴露给 Python。

  5. 配置 CMakeLists.txt: 配置 CMakeLists.txt 文件，指定编译选项、依赖库、Python 绑定等。

  6. 编译 C++ 模块: 使用 CMake 编译 C++ 模块，生成共享库。

  7. Python 中导入和使用: 将生成的共享库添加到 Python 路径，然后在 Python 脚本中导入和使用。

4.2.3.2 代码实践示例：自定义点云滤波算法 (C++)

我们将实现一个简单的自定义点云滤波算法，该算法基于点的平均距离进行滤波。如果一个点的平均距离大于阈值，则认为该点是离群点并移除。

1. 创建 C++ 模块项目

创建一个名为 custom_filter 的文件夹，并在其中创建以下文件：

  • custom_filter.cpp: C++ 源代码文件

  • CMakeLists.txt: CMake 配置文件

2. 编写 C++ 代码 (custom_filter.cpp)

#include <open3d/geometry/PointCloud.h>
#include <open3d/utility/Helper.h>
#include <pybind11/pybind11.h>
#include <vector>
namespace py = pybind11;
namespace o3d = open3d;
o3d::geometry::PointCloud RemoveOutliersByAvgDistance(const o3d::geometry::PointCloud& pcd, double avg_dist_threshold) {
    o3d::geometry::PointCloud filtered_pcd;
    std::vector<double> avg_distances;
    std::vector<int> outlier_indices;
    // 计算每个点的平均距离
    const auto& points = pcd.points_;
    for (size_t i = 0; i < points.size(); ++i) {
        double avg_dist = 0.0;
        int count = 0;
        for (size_t j = 0; j < points.size(); ++j) {
            if (i != j) {
                avg_dist += (points[i] - points[j]).norm();
                count++;
            }
        }
        avg_distances.push_back(avg_dist / count);
    }
    // 找出离群点索引
    for (size_t i = 0; i < avg_distances.size(); ++i) {
        if (avg_distances[i] > avg_dist_threshold) {
            outlier_indices.push_back(i);
        }
    }
    // 移除离群点
    filtered_pcd = *pcd.SelectByIndex(outlier_indices, true); // true 表示移除索引对应的点
    return filtered_pcd;
}
PYBIND11_MODULE(custom_filter, m) {
    m.def("remove_outliers_by_avg_distance", &RemoveOutliersByAvgDistance, "Remove outliers based on average distance");
}
​

代码详解：

  • #include <open3d/geometry/PointCloud.h>: 包含 Open3D 点云头文件。

  • #include <pybind11/pybind11.h>: 包含 Pybind11 头文件，用于 Python 绑定。

  • RemoveOutliersByAvgDistance(...): 自定义点云滤波函数，接受点云和平均距离阈值作为参数，返回滤波后的点云。

    • 计算每个点的平均距离：遍历所有点，计算每个点与其他点的距离之和，然后除以点的数量得到平均距离。

    • 找出离群点索引：遍历平均距离列表，如果平均距离大于阈值，则将该点的索引添加到离群点索引列表中。

    • 移除离群点：使用 pcd.SelectByIndex(outlier_indices, true) 函数，根据离群点索引列表移除点云中的离群点。

  • PYBIND11_MODULE(custom_filter, m) { ... }: Pybind11 模块定义，将 C++ 函数 RemoveOutliersByAvgDistance 暴露给 Python，模块名为 custom_filter，在 Python 中可以使用 import custom_filter 导入。

3. 配置 CMakeLists.txt

cmake_minimum_required(VERSION 3.18)
project(custom_filter)
find_package(Open3D REQUIRED)
find_package(pybind11 REQUIRED)
find_package(PythonLibs REQUIRED)
include_directories(${OPEN3D_INCLUDE_DIRS} ${PYBIND11_INCLUDE_DIRS} ${PYTHON_INCLUDE_DIRS})
link_directories(${OPEN3D_LIBRARY_DIRS} ${PYTHON_LIBRARY_DIRS})
add_library(custom_filter SHARED custom_filter.cpp)
target_link_libraries(custom_filter ${OPEN3D_LIBRARIES} pybind11::module ${PYTHON_LIBRARIES})
set_target_properties(custom_filter PROPERTIES
    PREFIX ""
    SUFFIX ".so" # 或者 .dylib (macOS), .dll (Windows)
)
install(TARGETS custom_filter DESTINATION .) # 安装到当前目录
​

代码详解：

  • cmake_minimum_required(VERSION 3.18): 指定 CMake 最低版本。

  • project(custom_filter): 定义项目名称为 custom_filter。

  • find_package(Open3D REQUIRED): 查找 Open3D 库，要求必须找到。

  • find_package(pybind11 REQUIRED): 查找 Pybind11 库，要求必须找到。

  • find_package(PythonLibs REQUIRED): 查找 Python 库，要求必须找到。

  • include_directories(...): 添加头文件搜索路径，包括 Open3D, Pybind11 和 Python 的头文件路径。

  • link_directories(...): 添加库文件搜索路径，包括 Open3D 和 Python 的库文件路径。

  • add_library(custom_filter SHARED custom_filter.cpp): 添加共享库目标 custom_filter，源文件为 custom_filter.cpp。

  • target_link_libraries(...): 链接库，包括 Open3D 库、Pybind11 模块和 Python 库。

  • set_target_properties(...): 设置目标属性，例如共享库的前缀和后缀。

  • install(TARGETS custom_filter DESTINATION .): 安装目标，将共享库安装到当前目录。

4. 编译 C++ 模块

在 custom_filter 文件夹下创建 build 文件夹，并进入 build 文件夹，执行以下命令：

cmake ..
make -j$(nproc) # 使用多核编译加速
​

编译成功后，在 build 文件夹下会生成共享库文件，例如 custom_filter.so (Linux), custom_filter.dylib (macOS), custom_filter.dll (Windows)。

5. Python 中导入和使用

将生成的共享库文件 (例如 custom_filter.so) 复制到你的 Python 脚本所在的目录，或者添加到 Python 路径中。然后在 Python 脚本中导入并使用：

import open3d as o3d
import custom_filter  # 导入自定义 C++ 模块
# 读取点云
pcd = o3d.io.read_point_cloud("path/to/your/point_cloud.ply")
# 使用自定义 C++ 滤波函数
filtered_pcd = custom_filter.remove_outliers_by_avg_distance(pcd, avg_dist_threshold=0.1)
# 可视化
o3d.visualization.draw_geometries([pcd, filtered_pcd],
                                   zoom=0.8,
                                   front=[0.645, -0.749, -0.109],
                                   lookat=[2.468, 2.018, 1.771],
                                   up=[-0.174, -0.009, 0.985],
                                   window_name="原始点云 vs C++ 滤波后点云")
​

代码详解：

  • import custom_filter: 导入自定义 C++ 模块 custom_filter。

  • filtered_pcd = custom_filter.remove_outliers_by_avg_distance(...): 调用 C++ 模块中的 remove_outliers_by_avg_distance 函数进行点云滤波。

通过这个例子，我们演示了如何开发一个简单的 Open3D C++ 模块，并将其集成到 Python 中使用。用户可以根据自己的需求，开发更复杂的 C++ 模块，例如实现更高效的算法、扩展 Open3D 的数据结构等。

mermaid

4.2.4 Open3D 社区贡献

Open3D 是一个开源项目，社区贡献是其持续发展的重要动力。Open3D 社区欢迎各种形式的贡献，包括代码贡献、文档改进、Bug 报告、功能建议等。

4.2.4.1 贡献流程

贡献 Open3D 的基本流程通常遵循 GitHub 的 Pull Request (PR) 工作流程：

  1. Fork 仓库: 在 GitHub 上 Fork Open3D 仓库到你自己的账号下。

  2. Clone Forked 仓库: 将 Forked 仓库 Clone 到本地。

  3. 创建 Feature 分支: 在本地仓库中创建一个新的 Feature 分支，用于开发你的贡献内容。分支命名应清晰明了，例如 feature/new-filter-algorithm。

  4. 代码开发与测试: 在 Feature 分支上进行代码开发，并编写相应的单元测试。

  5. 提交代码: 将代码提交到本地仓库，并 Push 到你的 Forked 仓库的 Feature 分支。

  6. 创建 Pull Request: 在 GitHub 上，从你的 Feature 分支向 Open3D 官方仓库的 master 分支创建一个 Pull Request。

  7. 代码审查与修改: Open3D 社区维护者会对你的 Pull Request 进行代码审查，并提出修改意见。根据审查意见进行修改，并重新 Push 到你的 Feature 分支。

  8. 合并 Pull Request: 当 Pull Request 通过代码审查后，Open3D 社区维护者会将你的 Pull Request 合并到官方仓库的 master 分支。

mermaid

4.2.4.2 贡献指南与注意事项

  • 遵循代码规范: Open3D 有一套代码规范，贡献代码需要遵循这些规范，保证代码风格的一致性。

  • 编写单元测试: 为了保证代码的质量和稳定性，贡献代码需要编写相应的单元测试，并确保测试覆盖率。

  • 完善文档: 如果贡献了新的功能或模块，需要编写相应的文档，包括 API 文档、使用示例等。

  • 保持沟通: 在贡献过程中，及时与 Open3D 社区维护者沟通，了解贡献进度和审查意见。

  • 从小处着手: 如果你是第一次贡献 Open3D，可以从小处着手，例如修复 Bug、改进文档等，逐步熟悉贡献流程。

  • 尊重社区: Open3D 社区是一个友好的社区，贡献者应尊重社区成员，积极参与社区讨论。

4.2.4.3 贡献的价值与意义

贡献 Open3D 不仅可以帮助你提升技术能力，还可以为 Open3D 社区做出贡献，共同推动 3D 数据处理技术的发展。你的贡献可能会被全球数以万计的 Open3D 用户使用，产生广泛的影响。同时，参与开源社区也是一个学习和交流的好机会，你可以结识来自世界各地的开发者，学习他们的经验和技术。

4.2.5 总结与展望

Open3D 的扩展与贡献机制为用户提供了广阔的定制和发展空间。无论是简单的 Python 扩展，还是深入的 C++ 模块开发，都能够帮助用户根据自身需求定制 Open3D 的功能，解决实际问题。而积极参与 Open3D 社区贡献，不仅可以提升个人技术能力，更能为 Open3D 的发展贡献力量，共同构建一个更加完善、强大的 3D 数据处理生态系统。

随着 3D 数据处理技术的不断发展，Open3D 的扩展与贡献领域也将更加广阔。我们期待更多开发者能够加入 Open3D 社区，共同探索 3D 技术的未来，为 Open3D 注入新的活力，使其在更多领域发挥更大的作用。

发布者: 作者: 转发
评论区 (0)
U
0/500