make variables public, vesion variable and minor changes

This commit is contained in:
bluepulsar
2026-01-04 13:29:26 +08:00
parent 807785ca7f
commit 1fe6fed9e6
6 changed files with 127 additions and 112 deletions
+25 -22
View File
@@ -5,12 +5,12 @@
1. 根据平台和python 版本下载对应的`.whl`文件
2. 运行pip命令安装:
```bash
pip install orisys-{version}-{python}-none-{os}_amd64.whl
pip install orisys-{version}-{python-version}-none-{os}_amd64.whl
```
3. 并测试导入:
```python
import orisys
orisys.__version__
print(orisys.__version__)
```
---
## `Sensor` 类别
@@ -39,7 +39,7 @@ sensor = Sensor("/data/data.mp4")
---
## 2. `get_img` 方法
## 2. `Sensor.get_img` 方法
### 描述
@@ -59,7 +59,7 @@ if img is None:
```
---
## 3. `compute_deformation` 方法
## 3. `Sensor.compute_deformation` 方法
### 描述
@@ -81,7 +81,7 @@ if img is None:
sensor.compute_deformation()
```
---
## 4. `compute_contact` 方法
## 4. `Sensor.compute_contact` 方法
### 描述
基于已计算的法向形变场进行接触区域分析,输出接触质心与轮廓等信息,并生成接触强度图。
@@ -120,7 +120,7 @@ centroid, contour, depth = sensor.read_info(
)
```
---
## 4. `read_info` 方法
## 4. `Sensor.read_info` 方法
### 描述
@@ -176,7 +176,7 @@ flow = sensor.read_info(sensor.info.VRAW)
```
---
## 5. `disconnect` 方法
## 5. `Sensor.disconnect` 方法
### 描述
@@ -188,21 +188,7 @@ flow = sensor.read_info(sensor.info.VRAW)
---
# 配置标定相关
## 1. `export_config` 方法
### 描述
导出当前传感器实例使用的配置参数字典。
### 输入参数
* **config_name**: 需要导出的配置参数字典名字`str`
* **path**: 导出的路径,默认`"./config/exported_config.json"`
### 返回
* `dict`: 导出的配置参数字典。
---
## 2. `list_config` 方法
## 1. `list_config` 方法
### 描述
列出内置传感器配置参数字典。
@@ -210,6 +196,23 @@ flow = sensor.read_info(sensor.info.VRAW)
### 返回
* `list`: 内置传感器配置参数字典的名字列表。
---
## 2. `export_config` 方法
### 描述
导出当前传感器实例使用的配置参数字典。
### 输入参数
* **config_name**: 需要导出的配置参数字典名字,`str`
* **path**: 导出的路径,默认`"./config/exported_config.json"`
### 返回
* `dict`: 导出的配置参数字典。
### 保存
* 导出内置的`config_name`配置参数字典至`path`
---
---