Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
Merge branch 'master' of https://github.com/OpenHUTB/carla_doc

# Conflicts:
#	docs/todo.md
  • Loading branch information
nongfugengxia committed May 20, 2024
2 parents 338149b + 0635dff commit 0758083
Show file tree
Hide file tree
Showing 31 changed files with 209 additions and 242 deletions.
4 changes: 2 additions & 2 deletions docs/adv_procedural_building_tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ __程序化建筑工具__ 有助于生成虚拟三维建筑,可以通过简单

- __Air conditioner meshes__: 在指定插座点处添加到窗户的空调装置

- __Pipe meshes__: 垂直向下延伸到建筑物的管道,模仿屋顶的排水管
- __Pipe meshes__: 垂直向下延伸到建筑物的管道,仿真屋顶的排水管

- __Wire meshes__: 沿着建筑物垂直延伸的电线,模仿电视天线延伸和闪电接地线
- __Wire meshes__: 沿着建筑物垂直延伸的电线,仿真电视天线延伸和闪电接地线

- __Antenna meshes__: 从窗户伸出的电视天线

Expand Down
2 changes: 1 addition & 1 deletion docs/cont_code_of_conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@
---
## 归属

本行为准则改编自 [贡献者契约][homepage]1.4 版,可从<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>获取。
本行为准则改编自 [贡献者契约][homepage]1.4 版,可从 [链接](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) 获取。

[homepage]: https://www.contributor-covenant.org
19 changes: 9 additions & 10 deletions docs/core_actors.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@ spectator = world.get_spectator()
transform = vehicle.get_transform()
spectator.set_transform(carla.Transform(transform.location + carla.Location(z=50),
carla.Rotation(pitch=-90)))

```

### 交通标志和交通灯
Expand Down Expand Up @@ -217,31 +216,31 @@ if traffic_light.get_state() == carla.TrafficLightState.Red:

* __[carla.VehicleControl](python_api.md#carla.VehicleControl)__ 提供油门、转向、刹车等驾驶命令的输入。
```py
vehicle.apply_control(carla.VehicleControl(throttle=1.0, steer=-1.0))
vehicle.apply_control(carla.VehicleControl(throttle=1.0, steer=-1.0))
```
* __[carla.VehiclePhysicsControl](python_api.md#carla.VehiclePhysicsControl)__ 定义车辆的物理属性并包含另外两个控制器:

* [carla.GearPhysicsControl](python_api.md#carla.GearPhysicsControl) 控制齿轮。
* [carla.WheelPhysicsControl](python_api.md#carla.WheelPhysicsControl) 提供对每个轮子的特定控制。

```py
vehicle.apply_physics_control(carla.VehiclePhysicsControl(max_rpm = 5000.0, center_of_mass = carla.Vector3D(0.0, 0.0, 0.0), torque_curve=[[0,400],[5000,400]]))
vehicle.apply_physics_control(carla.VehiclePhysicsControl(max_rpm = 5000.0, center_of_mass = carla.Vector3D(0.0, 0.0, 0.0), torque_curve=[[0,400],[5000,400]]))
```

车辆有一个 [carla.BoundingBox](python_api.md#carla.BoundingBox) 封装它们。该边界框允许将物理原理应用于车辆并检测碰撞。

```py
box = vehicle.bounding_box
print(box.location) # 相对车辆的位置
print(box.extent) # XYZ half-box extents in meters.
box = vehicle.bounding_box
print(box.location) # 相对车辆的位置
print(box.extent) # XYZ half-box extents in meters.
```

通过启用 [扫轮碰撞参数][enable_sweep] 可以改善车轮的物理特性。默认的轮子物理系统对每个轮子使用从轴到地板的单射线投射,但是当启用扫轮碰撞时,将检查轮子的整个体积是否发生碰撞。它可以这样启用:

```py
physics_control = vehicle.get_physics_control()
physics_control.use_sweep_wheel_collision = True
vehicle.apply_physics_control(physics_control)
physics_control = vehicle.get_physics_control()
physics_control.use_sweep_wheel_collision = True
vehicle.apply_physics_control(physics_control)
```

[enable_sweep]: https://carla.readthedocs.io/en/latest/python_api/#carla.VehiclePhysicsControl.use_sweep_wheel_collision
Expand All @@ -252,7 +251,7 @@ if traffic_light.get_state() == carla.TrafficLightState.Red:
* __自动驾驶模式__ 会将车辆订阅到 [交通管理器](adv_traffic_manager.md) 以仿真真实的城市状况。该模块是硬编码的,不是基于机器学习的。

```py
vehicle.set_autopilot(True)
vehicle.set_autopilot(True)
```
* __车灯__ 必须由用户打开和关闭。每辆车都有一组在[__carla.VehicleLightState__](python_api.md#carla.VehicleLightState) 中列出的灯。并非所有车辆都集成了车灯。截至撰写本文时,配备集成车灯的车辆如下:
* __自行车:__ 所有自行车都有前后位置灯。
Expand Down
31 changes: 14 additions & 17 deletions docs/cpp_client.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
C++ 客户端示例
==================

此示例使用CARLA的C++API创建一个应用程序,以从C++连接和控制仿真器。
此示例使用 Carla 的C++API创建一个应用程序,以从C++连接和控制仿真器。

编译和运行
---------------
Expand All @@ -15,16 +15,16 @@ make run
它的工作原理
------------

为了将应用程序链接到 LibCarla,我们需要使用与应用程序相同的编译器和配置来编译LibCarla。为此,我们生成一个 CMake 工具链文件,指定所需的编译器和标志
为了将应用程序链接到 LibCarla,我们需要使用与应用程序相同的编译器和配置来编译 LibCarla。为此,我们生成一个 CMake 工具链文件,指定所需的编译器和标志

```cmake
# Example ToolChain.cmake
# ToolChain.cmake 示例
set(CMAKE_C_COMPILER /usr/bin/clang-8)
set(CMAKE_CXX_COMPILER /usr/bin/clang++-8)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14 -O3 -DNDEBUG" CACHE STRING "" FORCE)
```

We pass this file to CMake when compiling LibCarla.client
编译LibCarla.client时,我们将此文件传递给CMake

```sh
cd /path/to/carla-root-folder
Expand All @@ -47,29 +47,26 @@ ninja
ninja install
```

This will generate the following structure at the provided install path
这将在提供的安装路径上生成以下结构

```
libcarla-install
├── include
   ├── carla
   ├── cephes
   ├── pugixml
│ ├── carla
│ ├── cephes
│ ├── pugixml
| ├── ...
   └── system
   ├── boost
   ├── recast
   └── rpc
│ └── system
│ ├── boost
│ ├── recast
│ └── rpc
└── lib
├── libcarla_client.a
├── librpc.a
├── libboost_filesystem.a
└── ...
```

Our application needs to be linked at minimum against `libcarla_client.a`,
`librpc.a`, `libRecast.a`, and `libDetour*.a`. If we make use of IO
functionality and/or image processing we would need to link against
`boost_filesystem`, `png`, `tiff`, and/or `jpeg`.
我们的应用程序至少需要链接到`libcarla_client.a``librpc.a``libRecast.a``libDetour*.a`。如果我们利用IO我们需要链接的功能和/或图像处理`boost_filesystem``png``tiff`和/或`jpeg`

For more details take a look at the Makefile provided.
有关更多详细信息,请查看提供的 Makefile
2 changes: 1 addition & 1 deletion docs/custom_plate.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

- 车牌替换成功后,将场景导出,打包成可执行文件。

- 运行python脚本在场景中添加已经被替换过车牌的车辆,调整视角,观察车牌。最后显示结果如下图所示:
- 运行 Python 脚本在场景中添加已经被替换过车牌的车辆,调整视角,观察车牌。最后显示结果如下图所示:

![](img/plate/result.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/ecosys_iss.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [智能驾驶系统](https://tis.ios.ac.cn/iss/)

智能自动驾驶系统(Intelligent Self-driving System, ISS)是一个用Python 和 C++ 编写的模块化框架,旨在构建一个适合研究的可扩展工作空间。该框架将包含用于自动驾驶相关任务的传统和深度学习算法,例如感知、定位、映射、预测、规划和控制。对外部库依赖性最小的模块化设计可以为研究人员评估自动驾驶系统的算法提供透明、干净的工作空间。
智能自动驾驶系统(Intelligent Self-driving System, ISS)是一个用 Python 和 C++ 编写的模块化框架,旨在构建一个适合研究的可扩展工作空间。该框架将包含用于自动驾驶相关任务的传统和深度学习算法,例如感知、定位、映射、预测、规划和控制。对外部库依赖性最小的模块化设计可以为研究人员评估自动驾驶系统的算法提供透明、干净的工作空间。

![ISS Architecture](img/ecosys_iss/ISS_Framework.png)

Expand Down
16 changes: 8 additions & 8 deletions docs/ecosys_simready.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# NVIDIA Omniverse 的 SimReady 内容

NVIDIA 的 [__SimReady__](https://developer.nvidia.com/omniverse/simready-assets) 规范支持准备专 __为仿真而构建的三维内容__,有助于简化仿真三维虚拟环境的内容创建管道,以实现机器人和自动驾驶中的机器学习目的。通过现已集成到 CARLA 中的 Omniverse 虚幻引擎插件,用户只需点击几下即可导入 SimReady 内容,例如已配置工作灯、门、车轮和道具的车辆,可立即用于装饰 CARLA 地图。 CARLA 的 Omniverse 集成能够显着加速您的环境构建流程,并为 [__Omniverse 生态系统__](https://www.nvidia.com/en-us/omniverse/ecosystem/) 中的整个应用程序世界打开大门。
NVIDIA 的 [__SimReady__](https://developer.nvidia.com/omniverse/simready-assets) 规范支持准备专 __为仿真而构建的三维内容__,有助于简化仿真三维虚拟环境的内容创建管道,以实现机器人和自动驾驶中的机器学习目的。通过现已集成到 Carla 中的 Omniverse 虚幻引擎插件,用户只需点击几下即可导入 SimReady 内容,例如已配置工作灯、门、车轮和道具的车辆,可立即用于装饰 Carla 地图。 Carla 的 Omniverse 集成能够显着加速您的环境构建流程,并为 [__Omniverse 生态系统__](https://www.nvidia.com/en-us/omniverse/ecosystem/) 中的整个应用程序世界打开大门。

!!! 笔记
Omniverse 虚幻引擎连接器目前仅在 Windows 中可用。

请按照以下步骤开始使用 Omniverse 并在 CARLA 中使用 SimReady 内容:
请按照以下步骤开始使用 Omniverse 并在 Carla 中使用 SimReady 内容:

首先,您应该先 [安装 NVIDIA Omniverse](https://docs.omniverse.nvidia.com/install-guide/latest/index.html)

Expand All @@ -28,9 +28,9 @@ NVIDIA 的 [__SimReady__](https://developer.nvidia.com/omniverse/simready-assets
4. 创建管理员详细信息
5. 选择*Local Nucleus Service*旁边的文件夹图标,这应该在 Web 浏览器中打开本地主机服务器

### 3. 连接CARLA仿真器
### 3. 连接 Carla 仿真器

1. 从CARLA 根文件夹命令行使用 `make launch` 启动 CARLA
1. 从 Carla 根文件夹命令行使用 `make launch` 启动 CARLA
2. 如果现有服务器处于活动状态并且您想要重新启动设置,请单击*Clean Local Assets*(可选)
3. 选择 *Omniverse* 图标并单击 *Add Server*
4. 为服务器命名并单击*Add to Content Browser*
Expand All @@ -39,8 +39,8 @@ NVIDIA 的 [__SimReady__](https://developer.nvidia.com/omniverse/simready-assets
7. Omniverse 文件夹现在应该在虚幻引擎内容浏览器的 Content/Omniverse 文件夹中可见
8. 再次访问您的网络浏览器
9. 单击*Connect to a Server*
10. 使用您为 CARLA 服务器设置的服务器名称进行身份验证
11. 使用您为 CARLA 服务器设置的管理员详细信息
10. 使用您为 Carla 服务器设置的服务器名称进行身份验证
11. 使用您为 Carla 服务器设置的管理员详细信息
12. 服务器文件夹现在应该显示在您的浏览器中

### 4. 导入 SimReady 资产
Expand All @@ -52,7 +52,7 @@ NVIDIA 的 [__SimReady__](https://developer.nvidia.com/omniverse/simready-assets

### 5. 使用 Omniverse 连接器将车辆加载到 CARLA

1. 在虚幻引擎中打开 CARLA 项目
1. 在虚幻引擎中打开 Carla 项目
2. 导航至 `CarlaTools/Content/USDImporter`
3. 右键单击 *UW_USDVehicleImporterEditorWidget*
4. 选择 *Run Editor Utility Widget*
Expand All @@ -62,4 +62,4 @@ NVIDIA 的 [__SimReady__](https://developer.nvidia.com/omniverse/simready-assets
8. 选择 *Import Asset*
9. 您应该会看到车辆显示在引擎中您在 *Import destination* 字段中指定的文件夹中
10. 打开另一个地图场景(它可能已打开包含导入数据的新场景),应出现*Save Content* 提示。取消选中 *Untitled* 场景,然后单击 *Save selected* 以保存新内容
11. 该车辆现已可在 CARLA 内使用,并将通过 Python API 提供
11. 该车辆现已可在 Carla 内使用,并将通过 Python API 提供
4 changes: 2 additions & 2 deletions docs/file_specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
执行`Makefile`,调用`Util/BuildTools/Windows.mk`,真正执行的是`BuildLibCarla.bat`,构建LibCarla的服务端和客户端;

### Build
* `Xerces`是由Apache组织所推动的一项XML文档解析开源项目
* `SQLite`是一款轻型的数据库,是遵守ACID的关系型数据库管理系统,它包含在一个相对小的C库中。
* `Xerces`是由 Apache 组织所推动的一项 XML 文档解析开源项目
* `SQLite`是一款轻型的数据库,是遵守 ACID 的关系型数据库管理系统,它包含在一个相对小的C库中。
* `PROJ`是一种通用坐标转换软件,它将坐标从一个坐标参考系(CRS)转换为另一个坐标参考系。这包括地图投影和大地坐标变换。

Binary file added docs/img/leaderboard/Town12route.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/iss_install.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# 智能自动驾驶系统

智能自动驾驶系统(ISS)是一个用Python和C++编写的模块化框架,旨在构建一个适合研究的可扩展工作空间。该框架将包含用于自动驾驶相关任务的传统和深度学习算法,例如感知、定位、映射、预测、规划和控制。对外部库依赖性最小的模块化设计可以为研究人员评估自动驾驶系统的算法提供透明、干净的工作空间。
智能自动驾驶系统(ISS)是一个用 Python 和 C++ 编写的模块化框架,旨在构建一个适合研究的可扩展工作空间。该框架将包含用于自动驾驶相关任务的传统和深度学习算法,例如感知、定位、映射、预测、规划和控制。对外部库依赖性最小的模块化设计可以为研究人员评估自动驾驶系统的算法提供透明、干净的工作空间。

ISS 的代码可以从其 [*Github 仓库*](https://github.com/CAS-LRJ/ISS) 下载,其中可以找到详细的安装说明。

Expand Down
2 changes: 1 addition & 1 deletion docs/large_map_roadrunner.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ RoadRunner是MATLAB校园许可的一部分,因此许多大学可以提供无

如何在RoadRunner中构建一个大地图的细节超出了本指南的范围,但是,在[RoadRunner文档](rr_tutorials)中有视频教程。

如果您正在构建带有高程的大地图,则建议地图的最大尺寸为20km × 20km。大于这个值的地图可能会导致RoadRunner在导出时崩溃
如果您正在构建带有高程的大地图,则建议地图的最大尺寸为20km 20km。大于这个值的地图可能会导致 RoadRunner 在导出时崩溃

[rr_tutorials]: https://www.mathworks.com/support/search.html?fq=asset_type_name:video%20category:roadrunner/index&amp;page=1&amp;s_tid=CRUX_topnav

Expand Down
2 changes: 1 addition & 1 deletion docs/leaderboard_get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ def sensors(self):
!!! 注意
试图设置过多的传感器单元会导致设置失败。

还有一些空间限制限制了传感器在车辆体积内的放置。如果传感器在任何轴(例如`[3.1,0.0,0.0]`上距离其父传感器超过3米,则设置将失败。
还有一些空间限制限制了传感器在车辆体积内的放置。如果传感器在任何轴(例如`[3.1,0.0,0.0]`上距离其父传感器超过 3 米,则设置将失败。


## 重写 run_step 方法
Expand Down
2 changes: 1 addition & 1 deletion docs/map_town07.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![town_07_slideshow](./img/catalogue/maps/town07/town07_slideshow.webp)

城镇 7 模仿了一个安静的乡村社区,绿色的景观充满了玉米地、谷仓、粮仓和风车。
城镇 7 仿真了一个安静的乡村社区,绿色的景观充满了玉米地、谷仓、粮仓和风车。

**城镇 7 是附加地图包的一部分,应 [与 Carla 包一起下载](https://github.com/carla-simulator/carla/releases) 。将下载的 ZIP 文件移动到解压的 Carla 包的 `Import` 文件夹中,然后运行 `Util/ImportAssets.sh` 脚本。**

Expand Down
2 changes: 1 addition & 1 deletion docs/pcl_recorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ros2 launch pcl_recorder pcl_recorder.launch.py
__2.__ 捕获驱动完成后,减小点云的整体大小:

```
# Create one point cloud file
# 创建一个点云文件
pcl_concatenate_points_pcd /tmp/pcl_capture/*.pcd
# Filter duplicates
Expand Down
10 changes: 5 additions & 5 deletions docs/ref_cpp.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# [C++ 参考](https://carla.readthedocs.io/en/latest/ref_cpp/)
我们使用 Doxygen 生成 C++ 代码的文档:

[Libcarla/source](http://carla.org/Doxygen/html/dir_b9166249188ce33115fd7d5eed1849f2.html)<br>
[Unreal/CarlaUE4/Source](http://carla.org/Doxygen/html/dir_733e9da672a36443d0957f83d26e7dbf.html)<br>
[Libcarla/source](http://carla.org/Doxygen/html/dir_b9166249188ce33115fd7d5eed1849f2.html) <br>
[Unreal/CarlaUE4/Source](http://carla.org/Doxygen/html/dir_733e9da672a36443d0957f83d26e7dbf.html) <br>
[Unreal/CarlaUE4/Plugins](http://carla.org/Doxygen/html/dir_8fc34afb5f07a67966c78bf5319f94ae.html)

生成的文档可通过此链接获取: **<http://carla.org/Doxygen/html/index.html>**
生成的文档可通过此 [链接](http://carla.org/Doxygen/html/index.html) 获取。

!!! 笔记
文档更新由 GitHub 自动完成。
Expand All @@ -19,13 +19,13 @@

```sh
# linux
> sudo apt-get install doxygen graphviz
sudo apt-get install doxygen graphviz
```

2- 安装后,转到 _Doxyfile_ 文件所在的项目根文件夹并运行以下命令:

```sh
> doxygen
doxygen
```

它将开始构建文档网页。
Expand Down
4 changes: 2 additions & 2 deletions docs/ref_sensors.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ for location in lidar_measurement:

测量的点作为[carla.RadarDetection](python_api.md#carla.RadarDetection)数组包含在[carla.RadarMeasurement](python_api.md#carla.RadarMeasurement)中,该数组指定它们的极坐标、距离和速度。雷达传感器提供的原始数据可以轻松转换为 __numpy__ 可管理的格式:
```py
# To get a numpy [[vel, azimuth, altitude, depth],...[,,,]]:
# 为了获得 numpy [[vel, azimuth, altitude, depth],...[,,,]]:
points = np.frombuffer(radar_data.raw_data, dtype=np.dtype('f4'))
points = np.reshape(points, (len(radar_data), 4))
```
Expand Down Expand Up @@ -597,7 +597,7 @@ if routing_targets:

```py
# rss_sensor.py 代码片段
# The function is registered as actor_constellation_callback
# 注册该函数为 actor_constellation_callback
def _on_actor_constellation_request(self, actor_constellation_data):
actor_constellation_result = carla.RssActorConstellationResult()
actor_constellation_result.rss_calculation_mode = ad.rss.map.RssMode.NotRelevant
Expand Down
2 changes: 1 addition & 1 deletion docs/release_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Carla 仿真器
./manual_control.py
```

这应该会打开一个新窗口,其中包含汽车的第三人称视图,您可以使用 WASD/箭头键驾驶这辆车。按“h”查看所有可用选项。
这应该会打开一个新窗口,其中包含汽车的第三人称视图,您可以使用 `WASD/箭头键`驾驶这辆车。按“h”查看所有可用选项。

有关更多详细信息和运行选项,请参阅我们的[在线文档](<http://carla.readthedocs.io>)

Expand Down
4 changes: 2 additions & 2 deletions docs/ros_compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

## ROS 参数

默认情况下,在 ROS 2 中设置或访问参数之前需要声明参数。ROS 1 中并非如此。为了保持 ROS 1 和 ROS 2 模式以相似的方式工作,在 ROS 2 的`CompatibleNode`版本中将参数 `allow_undeclared_parameters` 设置为`True`允许使用参数而无需事先声明。TrueCompatibleNode
默认情况下,在 ROS 2 中设置或访问参数之前需要声明参数。ROS 1 中并非如此。为了保持 ROS 1 和 ROS 2 模式以相似的方式工作,在 ROS 2 的`CompatibleNode`版本中将参数 `allow_undeclared_parameters` 设置为`True`允许使用参数 `TrueCompatibleNode` 而无需事先声明。

---

## 服务

在 ROS 2 中,服务可以异步调用。ROS 1 中并非如此。因此,ROS 2 版本的`call_service()`方法在异步调用后会等待服务器的响应,以模仿 ROS 1 的同步行为。
在 ROS 2 中,服务可以异步调用。ROS 1 中并非如此。因此,ROS 2 版本的`call_service()`方法在异步调用后会等待服务器的响应,以仿真 ROS 1 的同步行为。

!!! 笔记
在等待响应时,ROS 2 的`call_service()`方法会旋转节点。如果另一个线程并行旋转同一节点,这可能会导致问题(错误或死锁)。
Loading

0 comments on commit 0758083

Please sign in to comment.