使用pybind11生成C++的Python binding示例

最新推荐文章于 2024-07-25 11:22:43 发布

TracelessLe

最新推荐文章于 2024-07-25 11:22:43 发布

阅读量1.3k

点赞数 2

分类专栏： # OpenCV # Python # C/C++ 文章标签： c++ python opencv linux cmake

本文为原创文章，独家发布在blog.csdn.net/TracelessLe。未经个人允许不得转载。如需帮助请email至tracelessle@163.com。

本文链接：https://blog.csdn.net/tracelessle/article/details/110356588

版权

Python 同时被 3 个专栏收录

63 篇文章 2 订阅

订阅专栏

OpenCV

27 篇文章 8 订阅

订阅专栏

C/C++

15 篇文章 0 订阅

订阅专栏

前言

C++作为一种编译型语言，在其设计之初就偏重于性能、效率和灵活性，偏向应用于系统编程、嵌入式、资源受限的软件和系统。Python作为一种解释型语言，内置了如str, tuple, list, dict等常用数据结构，支持自动垃圾回收，拥有简洁的语法、丰富的内置库和第三方库，被越来越广泛地使用在各种场景中。但Python在高便捷性的同时无可避免的缺乏高性能。

在部分应用场景中，我们需要在Python的灵活性上架构应用，底层算法希望借助C++的高性能，那么我们可以考虑将C++开发的模块做成Python的bindings供Python调用。

在这里插入图片描述

而pybind11则是C++和Python两种语言之间的一座桥梁。Pybind11是一个轻量级只包含头文件的库，用于C++和Python之间的接口转换，可以为C++代码创建Python bindings。Pybind11通过C++编译时的自省来推断类型信息，来最大程度地减少传统拓展 Python 模块时繁杂的样板代码，已实现STL数据结构、智能指针、类、函数重载、实例方法等到Python的映射转换，其中函数可以接收和返回自定义数据类型的值、指针或引用。

步骤

以基于OpenCV和CUDA实现的GPU版本导向滤波算法为例，演示Pybind11的应用。

代码地址：https://github.com/TracelessLe/pybind11_guidedfilter_cuda

创建工程目录pybind11_guidedfilter_cuda和C++代码

其中核心代码guidedfilter.cpp和guidedfilter.h来自Github用户acstacey的项目“GLFCV - Light field disparity estimation using a guided filter cost volume”。

部分代码一瞥：

在guidedfilter.cpp前面加入下述代码
```
#include <pybind11/pybind11.h>
#include "ndarray_converter.h"
namespace py = pybind11;
```
在末尾加上下述代码：
```
PYBIND11_MODULE(gfcuda, m)
{
    NDArrayConverter::init_numpy();

    m.def("guidedFilter", &guidedFilter, "cv::cuda::guidedFilter", py::arg("guide"), py::arg("src"), py::arg("radius"), py::arg("eps"), py::arg("dDepth"));

}
```
目的是通过pybind11针对此cpp生成一个名为gfcuda的python binding，通过Python下的gfcuda.guidedFilter()的方法指向的C++函数"cv::cuda::guidedFilter"。
拷贝Pybind11工程到工程目录pybind11_guidedfilter_cuda下

Pybind11 CSDN资源链接：https://download.csdn.net/download/TracelessLe/13204469
Pybind11 GitHub链接：https://github.com/pybind/pybind11
将下载下来的包进行解压，解压后的pybind11文件夹拷贝到工程目录pybind11_guidedfilter_cuda下。
拷贝ndarray_converter.cpp和ndarray_converter.h【此项目需要】
由于涉及到numpy数组转换，拷贝相应.cpp和.h文件。
其中ndarray_converter.cpp和ndarray_converter.h来自Github用户mfedoseeva的项目“roboy-activity-recognition”。

编写CMakeLists.txt
CMakeLists.txt是C++项目的编译链接设置文件，在本项目中，需要用到的外部依赖有OpenCV和CUDA，所以需要根据你自己的路径去设置。另外需要注意添加pybind11_add_module(gfcuda ${SOURCES})等用于生成binding的语句。总体设置如下：

#Change this if you need to target a specific CMake version
cmake_minimum_required(VERSION 2.8)

# Enable C++11
set(CMAKE_CXX_STANDARD 11)

# Set up project
project(guided_filter_cuda)
add_subdirectory(pybind11)


SET(SOURCES
  ${CMAKE_CURRENT_SOURCE_DIR}/guidedfilter.cpp
  ${CMAKE_CURRENT_SOURCE_DIR}/ndarray_converter.cpp
  ${CMAKE_CURRENT_SOURCE_DIR}/ndarray_converter.h
)

pybind11_add_module(gfcuda ${SOURCES})

# Detect and add OpenCV
set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}" ${CMAKE_MODULE_PATH})
find_package(OpenCV REQUIRED HINTS /usr/local/share/opencv4)

find_package(CUDA 10.2 REQUIRED)

# Define sources and executable
set(EXECUTABLE_NAME "gfcuda")

# Link against OpenCV
include_directories(${OpenCV_INCLUDE_DIR})
target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${OpenCV_LIBS})

# Link against CUDA
include_directories(${CUDA_INCLUDE_DIRS})
target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${CUDA_LIBRARIES})

特别注意设置OpenCV和CUDA库的路径：

target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${OpenCV_LIBS})

target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${CUDA_LIBRARIES})

编译
```
cmake .
make
```
编译完成后会生成一个600K左右的.so文件如“gfcuda.cpython-37m-x86_64-linux-gnu.so”，将这个.so文件拷贝到你的工程目录即可通过import gfcuda使用。

在Python中使用

import cv2
import gfcuda

img = cv2.imread('cat.png')
guide = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)
final_img = gfcuda.guidedFilter(guide=guide, src=img, radius=5, eps=50*50, dDepth=-1)
cv2.imwrite('out.png', final_img)