0.3.1 stable release

Readme.md

@@ -73,7 +73,7 @@ conda install conda-forge::pyvkfft
 
 * **vid_src** (`int | str`, 必填): 传感器 ID、相机编号或视频路径。默认为 `0`。  
 * **config_name** (`str`，可选): 传感器配置`json`文件路径，用于加载对应的参数配置，默认为 `./config/ddjx01`。  
-* **cal_path** (`str`，可选): 复眼拼接校准文件路径，默认为 `./config/cal.npy`。有多个传感器同时运行时建议传感器类创建时建议填写，避免校准文件覆写。在首次运行时程序会在找不到文件时自动创建。  
+* * **cal_path** (`str`，可选，已弃用): 该参数已弃用，当前版本中不再使用，传入后也会被忽略。为兼容旧代码暂时保留。: 复眼拼接校准文件路径，默认为 `./config/cal.npy`。有多个传感器同时运行时建议传感器类创建时建议填写，避免校准文件覆写。在首次运行时程序会在找不到文件时自动创建。  
 * **backend** (`str`，可选): 光流场解耦计算后端，默认为 `auto`，可选`cupy`,`opencl`,`cpu`。  
 * **verbose** (`bool`，可选): 是否输出初始化及运行过程中的详细日志信息，默认为 `False`。  
 
@@ -99,12 +99,12 @@ sensor = Sensor("/data/data.mp4")
 
 采集并预处理一帧图像并存到`Sensor` 类别中。
 
+
 ### 返回
-* `np.ndarray`：处理后的BGR格式图像(`uint8`，尺寸为json文件中`resolution_stitch`对应分辨率)。
-* `None`：当输入源读取失败（例如视频结束、摄像头断开）时返回。
+* `bool`：是否成功读取图像。
 
 ### 状态更新
-* 成功时更新`sensor`类里面的图像。
+* 成功时更新`sensor`类里面的`sensor.img`。处理后的BGR格式图像(`uint8`，尺寸为json文件中`resolution_stitch`对应分辨率)。
 ### 示例
 
 ```python
@@ -123,6 +123,8 @@ sensor.get_img()
 ### 输入参数
 * **check_motion**(`bool`，可选): 为 `True` 时先根据光流判断是否有运动，有运动才做 HHD 分解；为 `False` 时每帧都做 HHD。默认 `True`。
 * **threshold**(`float`，可选): **check_motion** 功能的阈值，默认为`6`。
+* **tail_frames** (`int`，可选):  光流变化低于阈值后继续解算多少帧，确保传感器回复，，默认为 `10`.
+
 ### 返回
 
 * `bool`：是否接触到物体，如果**check_motion**为`False`时返回`None`。