基于UE5和ROS2的激光雷达+深度RGBD相机小车的仿真指南(一)---UnrealCV获取深度+分割图像

前言

本系列教程旨在使用UE5配置一个具备激光雷达+深度摄像机的仿真小车，并使用通过跨平台的方式进行ROS2和UE5仿真的通讯，达到小车自主导航的目的。
本教程使用的环境：
- ubuntu 22.04 ros2 humble
- windows11 UE5.4.3
- python8
本系列教程将涉及以下内容：
- UE仿真环境和简易小车的搭建
- UE仿真雷达数据和RGBD深度相机数据的获取
- 使用ROS2和UE5进行通讯
- 使用ROS2导航Nav2及其相关模块对小车进行自主通讯
- UE5部分C++编写和ROS2C++代码编写
- 部分插件使用python进行编写
本教程默认有ROS2导航及其gazebo仿真相关方面基础，Nav2相关的学习教程可以参考本人的其他博客Nav2代价地图实现和原理–Nav2源码解读之CostMap2D(上)-CSDN博客

UE介绍

请添加图片描述

UE5（Unreal Engine5）是由Epic Games开发的一款功能强大、跨平台的最新版的游戏开发引擎，以其高质量的实时渲染效果、多编程语言支持、丰富的市场资源和活跃的社区而闻名，广泛应用于游戏、影视、建筑等多个领域，不断推动着数字内容产业的发展。
目前Unreal Engine（UE）主要支持以下编程语言：
- 1. C++：
  - C++是UE的核心编程语言，用于编写引擎的底层架构和游戏逻辑。
  - 它提供了最高的性能和灵活性，允许开发者直接访问和修改引擎的各个组件。
  - C++在UE中通过自定义的反射系统与蓝图系统紧密集成，使得C++类和函数可以在蓝图可视化编程环境中被使用。
1. 蓝图（Blueprint）：
  - 蓝图是UE的一种可视化脚本系统，它允许开发者通过拖拽连接节点的方式来创建逻辑和功能，无需编写传统的代码。
  - 蓝图降低了编程的入门门槛，使得非程序员也能参与到游戏和应用的开发中。
  - 蓝图可以与C++代码无缝交互，使得开发者可以根据需要选择最适合的编程方法。

安装

本系列教程将使用最新版的UE5.4.3作为教程使用
在下载UE需要先安装Epic Games Launcher,下载链接
下载完后初次进入会要求注册Epic账号，注册好后选择虚幻引擎的库选项，选择“+”号在下拉的菜单栏中选择5.4.3即可完成下载
注意下载可能需要根据个人需求安装对应的编辑器，这里我们使用的是VisualStudio2022
完成安装后我们选择创建一个全新的C++空白模板项目
创建完项目打开我们会得到以下的画面，这样就完成UE5.4版本的安装

`UnrealCV`插件

UnrealCV是一个开源项目，旨在将Unreal Engine（UE）与计算机视觉（CV）领域结合起来。它允许开发者利用UE的高质量渲染能力来生成用于机器学习和计算机视觉研究的数据集和场景。UnrealCV提供了一个Python接口，允许用户通过Python脚本控制UE引擎，从而实现自动化场景渲染、数据采集和交互。
更多内容->UnrealCV官网

安装

这里来介绍以下如何为UE5配置UnrealCV插件插件
首先我们先登录UnrealCV的github仓库，由于官方提供的二进制release目前只支持到UE4.16版本，所以这里我们选择源码安装
注意选择5.2分支，目前UnrealCV已经支持到UE5.4版本
git clone后我们会得到一个unrealcv的文件夹，文件夹内容大致如下
找到你的项目文件夹(该文件夹下有一个以.uproject结尾的项目文件)，创建一个名为Plugins的文件夹
把上述你下载的unrealcv文件夹整个移动到Plugins文件交下，然后重新打开这个项目，项目会弹出UnrealCV插件是否进行编译的提示，选择是，然后就会进行编译
安装好后，在UE5界面左上角的编辑，在下拉菜单找到插件，搜索UnrealCV
返回UE主界面，找到绿色箭头开始运行此关卡(请务必记得这一步!!!)
在左下方的控制台输入vget /unrealcv/status确认插件配置情况
在左侧输出日志得到如下输出则表示插件配置成功

报错指南

控制台输入vget /unrealcv/status后UE直接闪退
检查是否进行绿色箭头开始运行此关卡此步骤(八成问题)
检查UE下载是否完全，检查UE版本是否为5.4.3，检查unrealcv下载的分支是否为5.2

使用python对Unreal客户端与服务器进行连接通讯

UnrealCV 实现了在游戏和计算机视觉算法之间的进程间通信 (IPC)。这种通信可以用下图来总结。由UE创建的游戏将通过加载UnrealCV服务器作为其模块来扩展。当游戏启动时，UnrealCV将启动一个TCP 服务器并等待命令。任何程序都可以使用UnrealCV客户端代码发送纯文本 UnrealCV 命令来控制场景或检索信息。
下面我们来简单的写一段代码进行通讯测试，默认的UnrealCV服务器运行在本地的9000端口，我们通过简单的配置完成下述代码

from unrealcv import Client  
client = Client(('localhost', 9000))  
  
# 连接到 UnrealCV 服务器  
if client.connect():  
    print('UnrealCV connected successfully')  
else:  
    print('UnrealCV is not connected')  
    exit()  
  
response = client.request('vget /unrealcv/status')  
print(response)  
# 断开连接  
client.disconnect()

上述运行结果将会输出和我们在UE控制台同样的内容输出，即视为通讯连接成功，此过程中确保UE允许了UnrealCV插件且UE处于运行此关卡中

使用`UnrealCV`进深度和分割图像的获取

这里我们介绍UnrealCV的一些基础用法，首先我们使用UE简单在摄像机视角前搭建一些简单物体
为相机添加初始位置,这里我们假定设置相机的位置为0,0,0（运行此关卡默认的摄像头视角就是0,0,0），注意这里必须设置，否则后面拍摄的深度和分割图像可能无法正确拍摄。

camera_settings = {  
    'location': {'x': 0, 'y': 0, 'z': 0},  # 相机位置  
    'rotation': {'pitch': 0, 'yaw': 0, 'roll': 0}  # 相机旋转  
}  
# 使用 vset 命令设置相机的位置  
client.request('vset /camera/0/location {x} {y} {z}'.format(**camera_settings['location']))  
  
# 使用 vset 命令设置相机的旋转  
client.request('vset /camera/0/rotation {pitch} {yaw} {roll}'.format(**camera_settings['rotation']))

然后我们在上述连接的基础上添加如下代码，下述的代码将保存
- lit:摄像机原始图像
- object_mask:物体分割图像
- depth:深度图像(注意这里深度图像保存为npy格式)

client.request('vget /camera/0/lit C:/Users/lzh/Desktop/UE5_ROS2_project/camera/lit.png')  
client.request('vget /camera/0/object_mask C:/Users/lzh/Desktop/UE5_ROS2_project/camera/object_mask.png')  
client.request('vget /camera/0/depth C:/Users/lzh/Desktop/UE5_ROS2_project/camera/depth.npy')

我们简单对图像进行展示,便得到以下图像

# 加载图像  
lit_img = plt.imread(r'C:/Users/lzh/Desktop/UE5_ROS2_project/camera/lit.png')  
object_mask_img = plt.imread(r'C:/Users/lzh/Desktop/UE5_ROS2_project/camera/object_mask.png')  
depth_img = np.load(r'C:\Users\lzh\Desktop\UE5_ROS2_project\camera\depth.npy')  
  
# 创建图形和子图  
fig, axes = plt.subplots(1, 3, figsize=(15, 5))  
  
# 显示 lit 图像  
axes[0].imshow(lit_img)  
axes[0].set_title('Lit Image')  
axes[0].axis('off')  
  
# 显示 object_mask 图像  
axes[1].imshow(object_mask_img, cmap='gray')  
axes[1].set_title('Object Mask')  
axes[1].axis('off')  
  
# 显示 depth 图像  
axes[2].imshow(depth_img, cmap='gray', vmin=0, vmax=1300)  
axes[2].set_title('Depth Image')  
axes[2].axis('off')  
  
# 显示图形  
plt.tight_layout()  
plt.show()

实时进行图像读取与显示

上面我们进行了单张文件的保存，下面我们来介绍如何进行实时读取,这里我们介绍核心函数，通过下述三个函数，我们就能实时返回读取到的图像数据,为此我们需要进行解码

data=client.request('vget /camera/0/lit png')
data=client.request('vget /camera/0/object_mask png')
data=client.request('vget /camera/0/depth npy')

对于普通图像和分割图像，我们只需要

lit_img = cv2.imdecode(np.frombuffer(self.data, np.uint8), cv2.IMREAD_COLOR)
object_mask_img = cv2.imdecode(np.frombuffer(self.data, np.uint8), cv2.IMREAD_COLOR)

对于深度图像，如果我们希望使用opencv-python进行展示，我们需要进行转换

import io
def read_npy(self,res):  
    return np.load(io.BytesIO(res))
depth_img = self.read_npy(self.data)  
gray_depth = cv2.convertScaleAbs(depth_img, alpha=(255.0 / 1300.0))  
# 使用cv2.applyColorMap将灰度图转换为伪彩色图  
colored_depth = cv2.applyColorMap(gray_depth, cv2.COLORMAP_JET)

通过上述核心代码，我们只需要简单写一个循环，进行展示即可
在不额外添加移动物体以及移动摄像机的前提下，我们移动观测者小球，便能得到以下实时画面

封装

为了后续教程我们方便使用，我们封装以下整个流程

from unrealcv import Client  
import cv2  # OpenCV  
import numpy as np  
import io  
import time  
class UE5CameraCenter:  
    def __init__(self):  
        self._client = Client(('localhost', 9000))  
        self._connection_check()  
        self._camera_init()  
  
        self._lit_image=LitImage()  
        self._object_mask=ObjectMaskImage()  
        self._depth_mask=DepthImage()  
    def __del__(self):  
        self._client.disconnect()  
    def _connection_check(self):  
        '''检查是否连接'''  
        if self._client.connect():  
            print('UnrealCV connected successfully')  
        else:  
            print('UnrealCV is not connected')  
            exit()  
    def set_camera_pose(self,x,y,z,pitch,yaw,roll):  
        '''设置摄像头位置'''  
        camera_settings = {  
            'location': {'x': x, 'y': y, 'z': z},  # 相机位置  
            'rotation': {'pitch': pitch, 'yaw': yaw, 'roll': roll}  # 相机旋转  
        }  
        # 设置相机的位置  
        self._client.request('vset /camera/0/location {x} {y} {z}'.format(**camera_settings['location']))  
  
        # 设置相机的旋转  
        self._client.request('vset /camera/0/rotation {pitch} {yaw} {roll}'.format(**camera_settings['rotation']))  
  
    def _camera_init(self):  
        '''摄像头初始化'''  
        self.set_camera_pose(0,0,0,0,0,0)  
  
    def get_camera_data(self, camera_type):  
        valid_types = {'lit', 'object_mask', 'depth'}  
        # 检查 camera_type 是否在有效类型中  
        if camera_type not in valid_types:  
            raise ValueError(f"Invalid camera type. Expected one of {valid_types}, but got '{camera_type}'.")  
        # 根据camera_type获取相应的数据  
        if camera_type == 'lit':  
            return self._lit_image.get_image(self._client)  
        elif camera_type == 'object_mask':  
            return self._object_mask.get_image(self._client)  
        elif camera_type == 'depth':  
            return self._depth_mask.get_image(self._client)  
    def test(self):  
        while True :  
  
            self._lit_image.get_image(self._client)  
            self._object_mask.get_image(self._client)  
            self._depth_mask.get_image(self._client)  
  
            self._lit_image.display()  
            self._object_mask.display()  
            self._depth_mask.display()  
  
  
class Image:  
    def __init__(self):  
        self.data_np = None  
    def get_image(self,client):  
        pass  
    def display(self):  
        pass  
  
class LitImage(Image):  
    def __init__(self):  
        self.data_np = None  
    def get_image(self,client):  
        data = client.request('vget /camera/0/lit png')  
        self.data_np=cv2.imdecode(np.frombuffer(data, np.uint8), cv2.IMREAD_COLOR)  
    def display(self):  
        cv2.imshow("lit_img", self.data_np)  
        key = cv2.waitKey(1)  
class ObjectMaskImage(Image):  
    def __init__(self):  
        self.data_np = None  
    def get_image(self,client):  
        data=client.request('vget /camera/0/object_mask png')  
        self.data_np=cv2.imdecode(np.frombuffer(data, np.uint8), cv2.IMREAD_COLOR)  
    def display(self):  
        cv2.imshow("object_mask_data", self.data_np)  
        key = cv2.waitKey(1)  
class DepthImage(Image):  
    def __init__(self):  
        self.data_np = None  
    def get_image(self,client):  
        data=client.request('vget /camera/0/depth npy')  
        self.data_np = self.read_npy(data)  
    def display(self):  
        gray_depth = cv2.convertScaleAbs(self.data_np, alpha=(255.0 / 1300.0))  
        # 使用cv2.applyColorMap将灰度图转换为伪彩色图  
        colored_depth = cv2.applyColorMap(gray_depth, cv2.COLORMAP_JET)  
        cv2.imshow("depth_img", colored_depth)  
    def read_npy(self,res):  
        return np.load(io.BytesIO(res))  
  
def main():  
    ue5_cam_center=UE5CameraCenter()  
    ue5_cam_center.test()  
if __name__ =='__main__':  
   main()