凯视佳产品文档 产品文档与技术支持

CBXS3D SDK · ROI 与测量量程

版本 1.0 · 更新于 2026-10-21 · 阅读 0

视场（ROI）读写与 ROI 上限。

本组对应头文件 @defgroup ROI。ROI 以原始图像左上角为原点，决定 X 方向测量区间与 Z 方向量程。

CBXS_GetRoiMax

int CBXS_GetRoiMax(void* handle, int* pnColMax, int* pnRowMax)

获取 ROI 可设置的最大范围。

参数 方向 说明
pnColMax out 行宽（列）最大设置范围，单位：像素
pnRowMax out 行高（行）最大设置范围，单位：像素

返回：成功返回 CBXS_RET_SUCCESS；失败返回错误码

CBXS_SetRoi

int CBXS_SetRoi(void* handle, int nColStart, int nRowStart, int nColSize, int nRowSize)

设置视场范围（ROI）。

参数 方向 说明
nColStart in 列起始：水平像素起始位置，以原始图像左上角为原点
nRowStart in 行起始：垂直行起始位置，以原始图像左上角为原点
nColSize in 列宽：水平像素数，决定 X 方向测量量程
nRowSize in 行高：垂直像素数，决定 Z 方向测量量程

返回：成功返回 CBXS_RET_SUCCESS

说明

  • 采集启动后 ROI 不可修改，需先停止采集。

CBXS_GetRoi

int CBXS_GetRoi(void* handle, int* pnColStart, int* pnRowStart, int* pnColSize, int* pnRowSize)

获取当前视场范围（ROI）。

参数 方向 说明
pnColStart out 列起始位置，单位：像素
pnRowStart out 行起始位置，单位：像素
pnColSize out 列宽（像素数）
pnRowSize out 行高（像素数）

返回：成功返回 CBXS_RET_SUCCESS；失败返回错误码