Leaper Vision Toolkit
中文 / English 2.x
Public 成员函数
ILIBService接口 参考

该接口提供连接到灵闪服务的功能。 更多...

类 ILIBService 继承关系图:
LIBService

Public 成员函数

int ExecuteTaskSync (int taskId, ILImage *image, ILIBTaskResult **taskResult)
 
ILIBAlgoConfigGetAlgoConfig (int taskId, LString algoName)
 
LString GetErrMsg (int errCode)
 
int GetGlobalVariableValue (LString gvName, ILIBData **val)
 
ILIBTaskConfigGetTaskConfig (int taskId)
 
BOOL IsReady ()
 
int LoadAlgoConfig (int taskId, LString algoName, BSTR filename)
 
int LoadGlobalAction (LString filename)
 
int LoadTask (LString filename, int *taskId)
 
int PrepareTask (int taskId)
 
int SaveAlgoConfig (int taskId, LString algoName, BSTR filename)
 
int SaveTask (int taskId, BSTR filename)
 
int SetAlgoConfig (int taskId, LString algoName, ILIBAlgoConfig *algoConfig)
 
int SetGlobalVariableValue (LString gvName, ILIBData *val)
 
int SetTaskConfig (int taskId, ILIBTaskConfig *taskConfig)
 
void SetUp (LString ibPath)
 
void TearDown ()
 
int UnloadTask (int taskId)
 

详细描述

该接口提供连接到灵闪服务的功能。

灵闪是一个基于利珀科技机器视觉基础框架开发的轻便的智能算法配置及组合工具平台。 通过所见即所得的交互界面和简单的拖拽操作,用于快速开发和迭代定位、测量、缺陷检测等机器视觉任务。 灵闪平台提供一系列覆盖具体应用需求的算法工具包: 特征定位、数量检测、有无判定、基础计算、图像变换、结合测量和计算、相机标定、符号识别、物体分类等等。

LPV IB 服务模块帮助用户在基于灵闪快速编辑机器视觉方案的基础上,将其集成到 LPV 应用程序中运行、操作, 实现更大程度上的灵活性和可扩展性。

使用这个接口,需要创建一个 LIBService 对象。

示例代码

注:该接口在 Linux / MacOS 平台暂不可用。

成员函数说明

◆ ExecuteTaskSync()

int ExecuteTaskSync ( int  taskId,
ILImage image,
ILIBTaskResult **  taskResult 
)

在输入的图像上,执行灵闪作业,获得执行结果。

参数
[in]taskId灵闪作业的唯一标识 ID
[in]image输入的图像
[out]taskResult返回作业的执行结果
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.

◆ GetAlgoConfig()

ILIBAlgoConfig* GetAlgoConfig ( int  taskId,
LString  algoName 
)

在指定 ID 的对应作业中,获取指定名称的算法工具的配置。
该方法提供一种更便捷的直接获取某个算法工具配置的方式。
若无法找到对应 ID 的灵闪作业,或无法在该作业中找到对应名称的算法工具,则返回 null

参数
[in]taskId灵闪作业的唯一标识 ID
[in]algoName算法工具的唯一名称
返回值
algoConfig返回算法工具的配置
参见
SetAlgoConfig(), GetTaskConfig().

◆ GetErrMsg()

LString GetErrMsg ( int  errCode)

获取错误码对于的错误信息。

参数
[in]errCode错误码,由 IB 服务相关接口函数返回。
返回值
errMsg返回错误信息。

◆ GetGlobalVariableValue()

int GetGlobalVariableValue ( LString  gvName,
ILIBData **  val 
)

通过名称获取指定全局变量的值。

参数
[in]gvName指定全局变量的名称
[out]val返回全局变量的值
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
SetGlobalVariableValue().

◆ GetTaskConfig()

ILIBTaskConfig* GetTaskConfig ( int  taskId)

获取指定 ID 的对应作业的配置。 若无法找到对应 ID 的灵闪作业,返回 null

参数
[in]taskId灵闪作业的唯一标识 ID
返回值
taskConfig返回作业配置
参见
SetTaskConfig(), GetAlgoConfig().

◆ IsReady()

BOOL IsReady ( )

检查灵闪服务是否就绪。

返回值
val若服务就绪,返回 True,否则返回 False。

◆ LoadAlgoConfig()

int LoadAlgoConfig ( int  taskId,
LString  algoName,
BSTR  filename 
)

从指定路径配置文件加载指定作业ID、算法名称的算法配置。

参数
[in]taskId灵闪作业的唯一标识 ID
[in]algoId灵闪算法的名称
[in]filename指定加载的算法配置文件路径,可为绝对或相对路径,包含文件夹、文件名和扩展名
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
SaveAlgoConfig()

◆ LoadGlobalAction()

int LoadGlobalAction ( LString  filename)

从指定文件加载全局动作模块。全局动作模块建立全局变量,通常用于在不同作业或前后执行实例间传递数据。

参数
[in]filename全局动作模块配置文件路径
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
GetAlgoConfig(), SetTaskConfig().

◆ LoadTask()

int LoadTask ( LString  filename,
int *  taskId 
)

从指定文件加载灵闪作业。

参数
[in]filename作业文件路径,可为绝对或相对路径,包含文件夹、文件名和扩展名
[out]taskId返回灵闪作业的唯一标识 ID
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
UnloadTask()

◆ PrepareTask()

int PrepareTask ( int  taskId)

预热指定的 ID 对应的灵闪作业。

参数
[in]taskId灵闪作业的唯一标识 ID
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
LoadTask()

◆ SaveAlgoConfig()

int SaveAlgoConfig ( int  taskId,
LString  algoName,
BSTR  filename 
)

保存指定作业ID、指定算法名称对应的算法配置到指定文件。

参数
[in]taskId灵闪作业的唯一标识 ID
[in]algoId灵闪算法的名称
[in]filename要保存的算法配置文件路径,可为绝对或相对路径,包含文件夹、文件名和扩展名
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
LoadAlgoConfig()

◆ SaveTask()

int SaveTask ( int  taskId,
BSTR  filename 
)

保存灵闪作业到指定文件。

参数
[in]taskId灵闪作业的唯一标识 ID
[in]filename作业文件路径,可为绝对或相对路径,包含文件夹、文件名和扩展名
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
LoadTask()
自从
2.10.0

◆ SetAlgoConfig()

int SetAlgoConfig ( int  taskId,
LString  algoName,
ILIBAlgoConfig algoConfig 
)

在指定 ID 的对应作业中,应用修改过的配置到指定名称的算法工具。

参数
[in]taskId灵闪作业的唯一标识 ID
[in]algoName算法工具的唯一名称
[in]algoConfig修改过的算法工具配置
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
GetAlgoConfig(), SetTaskConfig().

◆ SetGlobalVariableValue()

int SetGlobalVariableValue ( LString  gvName,
ILIBData val 
)

通过名称给指定全局变量设值。

参数
[in]gvName指定全局变量的名称
[in]val设置给该全局变量的值
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
GetGlobalVariableValue().

◆ SetTaskConfig()

int SetTaskConfig ( int  taskId,
ILIBTaskConfig taskConfig 
)

应用修改过的配置到指定 ID 的对应作业。

参数
[in]taskId灵闪作业的唯一标识 ID
[in]taskConfig修改过的作业配置
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
GetTaskConfig(), SetAlgoConfig().

◆ SetUp()

void SetUp ( LString  ibPath)

启动并连接到灵闪服务。
需在所有 LPV IB 对象的创建和操作前调用。

参数
[in]ibPath灵闪平台程序所在的根目录地址。
参见
TearDown().

◆ TearDown()

void TearDown ( )

关闭灵闪服务。
需在所有 LPV IB 对象的停止使用后调用。
可不手动执行该关闭步骤,在该灵闪服务对象被释放时,将自动关闭已连接的灵闪服务。

参见
SetUp().

◆ UnloadTask()

int UnloadTask ( int  taskId)

卸载指定 ID 对应的灵闪作业。

参数
[in]taskId灵闪作业的唯一标识 ID
返回值
errCode返回错误码(查阅错误码对照表)。若成功,返回 LPVNoError.
参见
LoadTask()