bluepulsar
90 lines
2.0 KiB
Markdown
90 lines
2.0 KiB
Markdown
# OrisysSDK API 文档
|
||
|
||
本文件提供了 OrisysSDK 的各类方法
|
||
|
||
---
|
||
## `Sensor` 类别
|
||
### 描述
|
||
创建一个传感器实例
|
||
### 输入参数
|
||
* **cam_id** (`int | str`, 可选): 传感器 ID、序列号或视频路径。默认为 `0`。
|
||
* **isstitch** (`bool`，可选): 是否启用图像拼接，默认为 `True`。
|
||
* **cuda** (`bool`，可选): 是否使用 GPU cuda 加速，默认为 `False`。
|
||
|
||
|
||
### 返回
|
||
* `Sensor` 对象
|
||
### 示例
|
||
|
||
```python
|
||
# Example 1： 用相机编号创建
|
||
from xensesdk import Sensor
|
||
from src.sensor import Sensor
|
||
sensor = Sensor(0)
|
||
|
||
# Example 2： 用视频文件创建
|
||
sensor = Sensor("/data/data.mp4")
|
||
```
|
||
|
||
---
|
||
|
||
## 2. `get_img` 方法
|
||
|
||
### 描述
|
||
|
||
从传感器获取图像，进行复眼图像提取和拼接。
|
||
|
||
### 返回
|
||
|
||
* 提取（`issitch = False`）或拼接后（`issitch = True`）的图像
|
||
|
||
---
|
||
|
||
## 3. `compute_deformation` 方法
|
||
|
||
### 描述
|
||
|
||
计算传感器变形
|
||
|
||
---
|
||
## 4. `read_info` 方法
|
||
|
||
### 描述
|
||
|
||
获取指定类型的传感器数据，返回数量和顺序与输入参数一致。
|
||
|
||
### 输入参数
|
||
|
||
* **args**: 任意数量的 `Sensor.info` 枚举，用于指定需要获取的数据类型。支持的枚举值及对应数据如下：
|
||
|
||
* VRAW: Optional[np.ndarray] # 原始光流场, shape=(400, 400, 2)
|
||
* VNORMAL: Optional[np.ndarray] # 法向光流场, shape=(400, 400, 2)
|
||
* VSHEAR: Optional[np.ndarray] # 切向光流场, shape=(400, 400,2)
|
||
* DEPTH: Optional[np.ndarray] # 深度场, shape=(400, 400,1)
|
||
|
||
* FNORMAL: Optional[np.float64] # 法相力信息
|
||
* FSHEARX: Optional[np.float64] # 横向切向力分量
|
||
* FSHEARY: Optional[np.float64] # 纵向切向力分量
|
||
|
||
* FPS: Optional[float] # 输出帧率
|
||
* TIMESTAMP: Optional[str] # 时间戳
|
||
|
||
* TimeStamp: Optional[float] # 传感器时间戳，单位s
|
||
|
||
### 返回
|
||
|
||
* 所请求的传感器数据（返回数量和顺序与输入参数一致）
|
||
---
|
||
|
||
## 5. `disconnect` 方法
|
||
|
||
### 描述
|
||
|
||
断开及释放资源。
|
||
|
||
---
|
||
|
||
---
|
||
|
||
## 常见问题解答 (FAQ)
|
||
TBC |