# OrisysSDK API 文档

本文件提供了 OrisysSDK 的各类方法

----
## `Sensor` 类别
### 描述
创建一个传感器实例
### 输入参数
* **cam_id** (`int | str`, 可选): 传感器 ID、序列号或视频路径。默认为 `0`。
* **isstitch** (`bool`，可选): 是否启用图像拼接，默认为 `True`。
* **cuda** (`bool`，可选): 是否使用 GPU cuda 加速，默认为 `False`。
* **cfg** (`str`，可选): 指定拼接标定数据，默认为 `/config/cal.npy`。
  
### 返回
* `Sensor` 对象
### 示例

```python

# Example 1：  用相机编号创建
from xensesdk import Sensor
from src.sensor import Sensor
sensor = Sensor(0)

# Example 2： 用视频文件创建
sensor = Sensor("/data/data.mp4")

# Example 3：  用相机编号开启
sensor = Sensor.create(0) 
```

---

## 2. `get_img` 方法

### 描述

从传感器获取图像，进行复眼图像提取和拼接。

### 返回

* 提取（`issitch = False`）或拼接后（`issitch = True`）的图像

---

## 3. `compute_deformation` 方法

### 描述

计算传感器变形和应力

---
## 4. `compute_deformation` 方法

### 描述

计算传感器变形和应力

---

## 常见问题解答 (FAQ)
TBC