IKapCDotNet2
相关枚举值与IKapC_swig.cs中重复
This method is deprecated. Use instead.
This method may still work, but it will be removed in future versions.
This method is deprecated. Use instead.
This method may still work, but it will be removed in future versions.
This method is deprecated. Use instead.
This method may still work, but it will be removed in future versions.
Convert Bayer Image Parsing Mode From IKap to IKapC
\~chinese
获取事件参数信息
事件信息句柄
事件信息索引
事件信息输出缓冲区
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
推荐使用ItkEventGetInfo获取event信息
\~english
Get event parameter information
Event information handle
Event Information Index
Event information output buffer
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
It is recommended to use ItkEventGetInfo to obtain event information.
\~chinese
获取事件参数信息结构体
事件信息句柄
事件信息结构体
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
\~english
Get event parameter information struct
Event information handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
\~chinese
获取当前连接到PC上采集卡设备的数量
当前连接到PC上的采集卡的数量
- ITKSTATUS_OK
\~english
Get the current number of frame grabber devices connected to PC
The current number of frame grabber connected to PC
- ITKSTATUS_OK
\~chinese
获取采集卡设备信息
采集卡索引
采集卡信息
- ITKSTATUS_OK
在调用本函数前必须先调用 ItkManGetBoardCount 。
\~english
Get frame grabber device information
Frame grabber index
Frame grabber information
- ITKSTATUS_OK
Before calling this function, ItkManGetBoardCount must be called first.
\~chinese
申请配置相机特征需要的资源
相机设备句柄
特征名称
相机特征句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
特征的所有信息都存储在 ITKFEATURE 句柄中，包括特征名称、特征类型、参数范围等。
\~english
Request for resources required to configure camera feature
Camera device handle
Feature name
Camera feature handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
All information about the features is stored in ITKFEATURE handle, including feature name, feature type, parameter range, etc.
\~chinese
释放配置相机特征资源
相机特征句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
释放句柄后，无法再次通过该句柄配置相机参数。
\~english
Release configuration camera feature resources
Camera feature handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
After releasing the handle, camera parameters cannot be configured again through the handle.
\~chinese
申请数据流采集过程中需要的资源
相机设备句柄
数据流索引，有效范围[0, ItkDevGetStreamCount -1]
缓冲区句柄，默认的数据流目标
数据流句柄，控制数据流整个生命周期
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 对于同一个相机，可能存在多个数据流同时采集数据，通过索引来指明希望采集的数据流。
2. 收集数据流资源的过程中必须指定一个数据缓冲区，用来存放采集过程中的图像数据。
Deprecated: 该接口已弃用，请使用 ItkDevAllocStreamEx 代替。
\~english
Request for resources during the process of applying for data stream acquisition
Camera device handle
Data stream index, valid range is [0, ItkDevGetStreamCount -1]
Buffer handle, default data stream destination
Data stream handle, controlling the entire life cycle of data stream
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. For the same camera, there may be multiple data streams grab data simultaneously. Use an index to indicate the desired data stream to grab.
2. During the process of grabbing data stream resources, a data buffer must be specified to store the image data grabbed during acquisition process.
Deprecated: This interface is obsolete, please use ItkDevAllocStreamEx instead.
\~chinese
从串口读取数据
相机设备句柄
存放数据的缓冲区
缓冲区长度
读取超时时间
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
从串口读取的数据将被写入缓冲区，请确保缓冲区大小足够。
\~english
Read data from serial port
Camera device handle
Buffer for storing data
Register address
Read timeout time
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The data read from serial port will be written to the buffer, please ensure that the buffer size is sufficient.
\~chinese
向串口写入数据
相机设备句柄
存放数据的缓冲区
缓冲区长度
读取超时时间
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
从缓冲区读取的数据将被写入串口，请确保缓冲区大小适当。
\~english
Write data to serial port
Camera device handle
Buffer for storing data
Register address
Read timeout time
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The data read from the buffer will be written to serial port, please ensure that the buffer size is sufficient.
\~chinese
获取相机特征访问模式
相机特征句柄
相机特征访问模式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征访问模式可选项如下所示：
| 访问模式 |
|--------------------------------------|
| ITKFEATURE_VAL_ACCESS_MODE_UNDEFINED |
| ITKFEATURE_VAL_ACCESS_MODE_RW |
| ITKFEATURE_VAL_ACCESS_MODE_RO |
| ITKFEATURE_VAL_ACCESS_MODE_WO |
| ITKFEATURE_VAL_ACCESS_MODE_NI |
| ITKFEATURE_VAL_ACCESS_MODE_NA |
Deprecated: 该接口已弃用，请使用 ItkDevGetAccessMode 代替。
\~english
Get camera feature access mode
Camera feature handle
Camera feature access mode
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The available options for feature access mode are as follows:
| Access mode |
|--------------------------------------|
| ITKFEATURE_VAL_ACCESS_MODE_UNDEFINED |
| ITKFEATURE_VAL_ACCESS_MODE_RW |
| ITKFEATURE_VAL_ACCESS_MODE_RO |
| ITKFEATURE_VAL_ACCESS_MODE_WO |
| ITKFEATURE_VAL_ACCESS_MODE_NI |
| ITKFEATURE_VAL_ACCESS_MODE_NA |
Deprecated: This interface is obsolete, please use ItkDevGetAccessMode instead.
\~chinese
获取相机特征类别
相机特征句柄
相机特征所属类别
作为输入指明特征类别的最大长度，作为输出指明特征类别的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature category
Camera feature handle
Category of camera feature
As input, it indicates the maximum length of feature category. As output, it indicates the effective length of feature category
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征类别
相机设备句柄
相机特征名称
相机特征所属类别
作为输入指明特征类别的最大长度，作为输出指明特征类别的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature category
Camera device handle
Camera feature name
Category of camera feature
As input, it indicates the maximum length of feature category. As output, it indicates the effective length of feature category
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征数据类型
相机特征句柄
相机特征数据类型
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征数据类型可选项如下所示：
| 数据类型 |
|-------------------------------|
| ITKFEATURE_VAL_TYPE_UNDEFINED |
| ITKFEATURE_VAL_TYPE_INT32 |
| ITKFEATURE_VAL_TYPE_INT64 |
| ITKFEATURE_VAL_TYPE_FLOAT |
| ITKFEATURE_VAL_TYPE_DOUBLE |
| ITKFEATURE_VAL_TYPE_BOOL |
| ITKFEATURE_VAL_TYPE_ENUM |
| ITKFEATURE_VAL_TYPE_STRING |
| ITKFEATURE_VAL_TYPE_COMMAND |
| ITKFEATURE_VAL_TYPE_CATEGORY |
| ITKFEATURE_VAL_TYPE_REGISTER |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature data type
Camera feature handle
Camera feature data type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The available options for feature data types are as follows:
| Data type |
|-------------------------------|
| ITKFEATURE_VAL_TYPE_UNDEFINED |
| ITKFEATURE_VAL_TYPE_INT32 |
| ITKFEATURE_VAL_TYPE_INT64 |
| ITKFEATURE_VAL_TYPE_FLOAT |
| ITKFEATURE_VAL_TYPE_DOUBLE |
| ITKFEATURE_VAL_TYPE_BOOL |
| ITKFEATURE_VAL_TYPE_ENUM |
| ITKFEATURE_VAL_TYPE_STRING |
| ITKFEATURE_VAL_TYPE_COMMAND |
| ITKFEATURE_VAL_TYPE_CATEGORY |
| ITKFEATURE_VAL_TYPE_REGISTER |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征数据类型
相机设备句柄
相机特征名称
相机特征数据类型
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征数据类型可选项如下所示：
| 数据类型 |
|-------------------------------|
| ITKFEATURE_VAL_TYPE_UNDEFINED |
| ITKFEATURE_VAL_TYPE_INT32 |
| ITKFEATURE_VAL_TYPE_INT64 |
| ITKFEATURE_VAL_TYPE_FLOAT |
| ITKFEATURE_VAL_TYPE_DOUBLE |
| ITKFEATURE_VAL_TYPE_BOOL |
| ITKFEATURE_VAL_TYPE_ENUM |
| ITKFEATURE_VAL_TYPE_STRING |
| ITKFEATURE_VAL_TYPE_COMMAND |
| ITKFEATURE_VAL_TYPE_CATEGORY |
| ITKFEATURE_VAL_TYPE_REGISTER |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature data type
Camera device handle
Camera feature name
Camera feature data type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The available options for feature data types are as follows:
| Data type |
|-------------------------------|
| ITKFEATURE_VAL_TYPE_UNDEFINED |
| ITKFEATURE_VAL_TYPE_INT32 |
| ITKFEATURE_VAL_TYPE_INT64 |
| ITKFEATURE_VAL_TYPE_FLOAT |
| ITKFEATURE_VAL_TYPE_DOUBLE |
| ITKFEATURE_VAL_TYPE_BOOL |
| ITKFEATURE_VAL_TYPE_ENUM |
| ITKFEATURE_VAL_TYPE_STRING |
| ITKFEATURE_VAL_TYPE_COMMAND |
| ITKFEATURE_VAL_TYPE_CATEGORY |
| ITKFEATURE_VAL_TYPE_REGISTER |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征显示名称
相机特征句柄
相机特征显示名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
相机特征显示名称和名称有所不同，前者用于在GUI界面中显示特征，后者则唯一标示了相机特征。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature display name
Camera feature handle
Camera feature display name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The camera feature display name and name are different.
The former is used to display feature in GUI interface, while the latter uniquely identifies camera feature.
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征显示名称
相机设备句柄
相机特征名称
相机特征显示名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
相机特征显示名称和名称有所不同，前者用于在GUI界面中显示特征，后者则唯一标示了相机特征。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature display name
Camera device handle
Camera feature name
Camera feature display name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The camera feature display name and name are different.
The former is used to display feature in GUI interface, while the latter uniquely identifies camera feature.
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征提示信息
相机特征句柄
相机特征提示信息
作为输入指明提示信息的最大长度，作为输出指明提示信息的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征提示信息是一个简要描述节点及其目的的文本字符串，传递给此函数的缓冲区必须足够容纳整个字符串。
如果调用该函数时，将pBuff设置为NULL，则pBufLen指向的变量将设置为所需的缓冲区大小。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature tooltip information
Camera feature handle
Camera feature tooltip information
As input, it indicates the maximum length of tooltip information. As output, it indicates the effective length of tooltip information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The feature tooltip information is a text string that briefly describes the node and its purpose,
and the buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征提示信息
相机设备句柄
相机特征名称
相机特征提示信息
作为输入指明提示信息的最大长度，作为输出指明提示信息的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征提示信息是一个简要描述节点及其目的的文本字符串，传递给此函数的缓冲区必须足够容纳整个字符串。
如果调用该函数时，将pBuff设置为NULL，则pBufLen指向的变量将设置为所需的缓冲区大小。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature tooltip information
Camera device handle
Camera feature name
Camera feature tooltip information
As input, it indicates the maximum length of tooltip information. As output, it indicates the effective length of tooltip information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The feature tooltip information is a text string that briefly describes the node and its purpose,
and the buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征具体描述信息
相机特征句柄
相机特征详细说明信息
作为输入指明详细说明信息的最大长度，作为输出指明详细说明信息的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征具体描述信息是一个描述节点及其目的的文本字符串，比 ItkDevGetTooltip 获取的信息更详细，传递给此函数的缓冲区必须足够容纳整个字符串。
如果调用该函数时，pBuff将设置为NULL，则pBufLen指向的变量将设置为所需的缓冲区大小。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get specific description information of camera feature
Camera feature handle
Detailed description of camera feature
As input, it indicates the maximum length of detailed description information. As output, it indicates the effective length of detailed description information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The specific feature description information is a text string that describes the node and its purpose,
which is more detailed than the information obtained by ItkDevGetTooltip. The buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征具体描述信息
相机设备句柄
相机特征名称
相机特征详细说明信息
作为输入指明详细说明信息的最大长度，作为输出指明详细说明信息的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征具体描述信息是一个描述节点及其目的的文本字符串，比 ItkDevGetTooltip 获取的信息更详细，传递给此函数的缓冲区必须足够容纳整个字符串。
如果调用该函数时，pBuff将设置为NULL，则pBufLen指向的变量将设置为所需的缓冲区大小。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get specific description information of camera feature
Camera device handle
Camera feature name
Detailed description of camera feature
As input, it indicates the maximum length of detailed description information. As output, it indicates the effective length of detailed description information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The specific feature description information is a text string that describes the node and its purpose,
which is more detailed than the information obtained by ItkDevGetTooltip. The buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征命名空间
相机特征句柄
相机特征命名空间
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征命名空间可选项如下所示：
| 命名空间 |
|-------------------------------------|
| ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
| ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
| ITKFEATURE_VAL_NAME_SPACE_STANDARD |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature name space
Camera feature handle
Camera feature name space
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The feature name space options are as follows:
| Name space |
|-------------------------------------|
| ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
| ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
| ITKFEATURE_VAL_NAME_SPACE_STANDARD |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征命名空间
相机设备句柄
相机特征名称
相机特征命名空间
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征命名空间可选项如下所示：
| 命名空间 |
|-------------------------------------|
| ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
| ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
| ITKFEATURE_VAL_NAME_SPACE_STANDARD |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature name space
Camera device handle
Camera feature name
Camera feature name space
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The feature name space options are as follows:
| Name space |
|-------------------------------------|
| ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
| ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
| ITKFEATURE_VAL_NAME_SPACE_STANDARD |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征可视权限
相机特征句柄
相机特征可视性
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征可视权限可选项如下所示：
| 可视权限 |
|-------------------------------------|
| ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
| ITKFEATURE_VAL_VISIBILITY_BEGINNER |
| ITKFEATURE_VAL_VISIBILITY_EXPERT |
| ITKFEATURE_VAL_VISIBILITY_GURU |
| ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature visibility
Camera feature handle
Camera feature visibility
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The options for feature visibility are as follows:
| Visibility |
|-------------------------------------|
| ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
| ITKFEATURE_VAL_VISIBILITY_BEGINNER |
| ITKFEATURE_VAL_VISIBILITY_EXPERT |
| ITKFEATURE_VAL_VISIBILITY_GURU |
| ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征可视权限
相机设备句柄
相机特征名称
相机特征可视性
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征可视权限可选项如下所示：
| 可视权限 |
|-------------------------------------|
| ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
| ITKFEATURE_VAL_VISIBILITY_BEGINNER |
| ITKFEATURE_VAL_VISIBILITY_EXPERT |
| ITKFEATURE_VAL_VISIBILITY_GURU |
| ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature visibility
Camera device handle
Camera feature name
Camera feature visibility
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The options for feature visibility are as follows:
| Visibility |
|-------------------------------------|
| ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
| ITKFEATURE_VAL_VISIBILITY_BEGINNER |
| ITKFEATURE_VAL_VISIBILITY_EXPERT |
| ITKFEATURE_VAL_VISIBILITY_GURU |
| ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征表示方式
相机特征句柄
相机特征表示方式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 该函数只对整数类型特征有效，对于其它类型特征，表示方式取值为 ITKFEATURE_VAL_REPRESENTATION_UNDEFINED 。
2. 特征表示方式可选项如下所示：
| 表示方式 |
|-------------------------------------------|
| ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
| ITKFEATURE_VAL_REPRESENTATION_LINEAR |
| ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
| ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
| ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
| ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
| ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
| ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature representation method
Camera feature handle
Camera feature representation method
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. This function is only valid for integer type features, and for other type features, the representation takes the value ITKFEATURE_VAL_REPRESENTATION_UNDEFINED .
2. The options for feature representation are as follows:
| Representation method |
|-------------------------------------------|
| ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
| ITKFEATURE_VAL_REPRESENTATION_LINEAR |
| ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
| ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
| ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
| ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
| ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
| ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征表示方式
相机设备句柄
相机特征名称
相机特征表示方式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 该函数只对整数类型特征有效，对于其它类型特征，表示方式取值为 ITKFEATURE_VAL_REPRESENTATION_UNDEFINED 。
2. 特征表示方式可选项如下所示：
| 表示方式 |
|-------------------------------------------|
| ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
| ITKFEATURE_VAL_REPRESENTATION_LINEAR |
| ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
| ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
| ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
| ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
| ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
| ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Get camera feature representation method
Camera device handle
Camera feature name
Camera feature representation method
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. This function is only valid for integer type features, and for other type features, the representation takes the value ITKFEATURE_VAL_REPRESENTATION_UNDEFINED .
2. The options for feature representation are as follows:
| Representation method |
|-------------------------------------------|
| ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
| ITKFEATURE_VAL_REPRESENTATION_LINEAR |
| ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
| ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
| ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
| ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
| ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
| ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取32位整数类型特征的最小值
相机特征句柄
32位整数类型的最小值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the minimum value of 32bit integer type feature
Camera feature handle
Minimum value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取32位整数类型特征的最小值
相机设备句柄
相机特征名称
32位整数类型的最小值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the minimum value of 32bit integer type feature
Camera device handle
Camera feature name
Minimum value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取32位整数类型特征的最大值
相机特征句柄
32位整数类型的最大值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the maximum value of 32bit integer type feature
Camera feature handle
Maximum value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取32位整数类型特征的最大值
相机设备句柄
相机特征名称
32位整数类型的最大值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the maximum value of 32bit integer type feature
Camera device handle
Camera feature name
Maximum value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取32位整数类型特征的步长
相机特征句柄
32位整数类型的单位增量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the increment of 32bit integer type feature
Camera feature handle
Increment of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取32位整数类型特征的步长
相机设备句柄
相机特征名称
32位整数类型的单位增量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the increment of 32bit integer type feature
Camera device handle
Camera feature name
Increment of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取32位整数类型特征的值
相机特征句柄
32位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of 32bit integer type feature
Camera feature handle
Value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取32位整数类型特征的值
相机设备句柄
相机特征名称
32位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of 32bit integer type feature
Camera device handle
Camera feature name
Value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
设置32位整数类型特征的值
相机特征句柄
32位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
设定值的取值范围一定是[ ItkFeatureGetInt32Min , ItkFeatureGetInt32Max ]，
取值同时也应满足value = ItkFeatureGetInt32Min + N* ItkFeatureGetInt32Inc ，N=0,1,2,…
\~english
Set the value of 32bit integer type feature
Camera feature handle
Value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The range of values for the set value must be [ ItkFeatureGetInt32Min , ItkFeatureGetInt32Max ],
value should also satisfy the condition of value = ItkFeatureGetInt32Min + N* ItkFeatureGetInt32Inc , N=0,1,2,…
\~chinese
设置32位整数类型特征的值
相机设备句柄
相机特征名称
32位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
设定值的取值范围一定是[ ItkDevGetInt32Min , ItkDevGetInt32Max ]，
取值同时也应满足value = ItkDevGetInt32Min + N* ItkDevGetInt32Inc ，N=0,1,2,…
\~english
Set the value of 32bit integer type feature
Camera device handle
Camera feature name
Value of 32bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The range of values for the set value must be [ ItkDevGetInt32Min , ItkDevGetInt32Max ],
value should also satisfy the condition of value = ItkDevGetInt32Min + N* ItkDevGetInt32Inc , N=0,1,2,…
\~chinese
获取64位整数类型特征的最小值
相机特征句柄
64位整数类型的最小值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetInt64FeatureInfo 代替。
\~english
Get the minimum value of 64bit integer type feature
Camera feature handle
Minimum value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
\~chinese
获取64位整数类型特征的最小值
相机设备句柄
相机特征名称
64位整数类型的最小值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetInt64FeatureInfo 代替。
\~english
Get the minimum value of 64bit integer type feature
Camera device handle
Camera feature name
Minimum value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
\~chinese
获取64位整数类型特征的最大值
相机特征句柄
64位整数类型的最大值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetInt64FeatureInfo 代替。
\~english
Get the maximum value of 64bit integer type feature
Camera feature handle
Maximum value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
\~chinese
获取64位整数类型特征的最大值
相机设备句柄
相机特征名称
64位整数类型的最大值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetInt64FeatureInfo 代替。
\~english
Get the maximum value of 64bit integer type feature
Camera device handle
Camera feature name
Maximum value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
\~chinese
获取64位整数类型特征的步长
相机特征句柄
64位整数类型的单位增量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetInt64FeatureInfo 代替。
\~english
Get the increment of 64bit integer type feature
Camera feature handle
Increment of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
\~chinese
获取64位整数类型特征的步长
相机设备句柄
相机特征名称
64位整数类型的单位增量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetInt64FeatureInfo 代替。
\~english
Get the increment of 64bit integer type feature
Camera device handle
Camera feature name
Increment of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
\~chinese
获取64位整数类型特征的值
相机特征句柄
64位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetInt64 代替。
\~english
Get the value of 64bit integer type feature
Camera feature handle
Value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetInt64 instead.
\~chinese
设置64位整数类型特征的值
相机特征句柄
64位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
设定值的取值范围一定是[ ItkFeatureGetInt64Min , ItkFeatureGetInt64Max ]，
取值同时也应满足value = ItkFeatureGetInt64Min + N* ItkFeatureGetInt64Inc ，N=0,1,2,…
Deprecated: 该接口已弃用，请使用 ItkDevSetInt64 代替。
\~english
Set the value of 64bit integer type feature
Camera feature handle
Value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The range of values for the set value must be [ ItkFeatureGetInt64Min , ItkFeatureGetInt64Max ],
value should also satisfy the condition of value = ItkFeatureGetInt64Min + N* ItkFeatureGetInt64Inc , N=0,1,2,…
Deprecated: This interface is obsolete, please use ItkDevSetInt64 instead.
\~chinese
获取浮点数类型特征的最小值
相机特征句柄
64位浮点数类型的最小值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the minimum value of double type feature
Camera feature handle
Minimum value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
获取浮点数类型特征的最小值
相机设备句柄
相机特征名称
64位浮点数类型的最小值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the minimum value of double type feature
Camera device handle
Camera feature name
Minimum value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
获取浮点数类型特征的最大值
相机特征句柄
64位浮点数类型的最大值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the maximum value of double type feature
Camera feature handle
Maximum value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
获取浮点数类型特征的最大值
相机设备句柄
相机特征名称
64位浮点数类型的最大值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the maximum value of double type feature
Camera device handle
Camera feature name
Maximum value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
获取浮点数类型特征的步长
相机特征句柄
64位浮点数类型的增量值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the increment value of double type feature
Camera feature handle
Increment of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
获取浮点数类型特征的步长
相机设备句柄
相机特征名称
64位浮点数类型的增量值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the increment value of double type feature
Camera device handle
Camera feature name
Increment of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
获取浮点数类型特征的值
相机特征句柄
64位浮点数类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDouble 代替。
\~english
Get value of double type feature
Camera feature handle
Value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDouble instead.
\~chinese
设置浮点数类型特征的值
相机特征句柄
64位浮点数类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
设定值的取值范围一定是[ ItkFeatureGetDoubleMin , ItkFeatureGetDoubleMax ]。
Deprecated: 该接口已弃用，请使用 ItkDevSetDouble 代替。
\~english
Set value of double type feature
Camera feature handle
Value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The range of values for the set value must be [ ItkFeatureGetDoubleMin , ItkFeatureGetDoubleMax ].
Deprecated: This interface is obsolete, please use ItkDevSetDouble instead.
\~chinese
获取浮点数的显示精度
相机特征句柄
浮点数的显示精度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the precision of double type
Camera feature handle
Precision of double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
获取浮点数的显示精度
相机设备句柄
相机特征名称
浮点数的显示精度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetDoubleFeatureInfo 代替。
\~english
Get the precision of double type
Camera device handle
Camera feature name
Precision of double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
\~chinese
设置布尔数据类型特征的值
相机特征句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevSetBool 代替。
\~english
Set the value of boolean type feature
Camera feature handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevSetBool instead.
\~chinese
获取布尔数据类型特征的值
相机特征句柄
布尔类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetBool 代替。
\~english
Get the value of boolean type feature
Camera feature handle
Boolean type value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetBool instead.
\~chinese
获取字符串或枚举类型特征的值
相机特征句柄
字符串或枚举类型的相机特征值
作为输入指明特征值的最大长度，作为输出指明特征值的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
传递给此函数的缓冲区必须足够容纳整个字符串。如果调用该函数时，将pBuff设置为NULL，则pBufLen指向的变量将设置为所需的缓冲区大小。
Deprecated: 该接口已弃用，请使用 ItkDevToString 代替。
\~english
Get the value of string or enumeration type
Camera feature handle
Value of string or enumeration type
As input, it indicates the maximum length of feature value. As output, it indicates the effective length of feature value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The buffer passed to this function must be sufficient to hold the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
Deprecated: This interface is obsolete, please use ItkDevToString instead.
\~chinese
设置字符串或枚举类型特征的值
相机特征句柄
字符串或枚举类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevFromString 代替。
\~english
Set the value of string or enumeration type
Camera feature handle
Value of string or enumeration type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevFromString instead.
\~chinese
获取枚举类型特征的枚举数量
相机特征句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetEnumEntryFeatureInfo 代替。
\~english
Get the number of enumerations with enumeration type feature
Camera feature handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
\~chinese
获取枚举类型特征的枚举数量
相机设备句柄
相机特征名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetEnumEntryFeatureInfo 代替。
\~english
Get the number of enumerations with enumeration type feature
Camera device handle
Camera feature name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
\~chinese
获取枚举类型特征的枚举名
相机特征句柄
枚举项索引，有效范围[0, ItkFeatureGetEnumCount -1]
枚举项名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetEnumEntryFeatureInfo 代替。
\~english
Get the name of enumerations with enumeration type feature
Camera feature handle
Enumeration item index, valid range is [0, ItkFeatureGetEnumCount -1]
Enumeration item name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
\~chinese
获取枚举类型特征的枚举名
相机设备句柄
相机特征名称
枚举项索引，有效范围[0, ItkDevGetEnumCount -1]
枚举项名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetEnumEntryFeatureInfo 代替。
\~english
Get the name of enumerations with enumeration type feature
Camera device handle
Camera feature name
Enumeration item index, valid range is [0, ItkDevGetEnumCount -1]
Enumeration item name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
\~chinese
判断枚举项是否存在
相机特征句柄
枚举项名称
true表示相机支持该枚举项，false表示相机不支持该枚举项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Determine whether the enumeration item exists
Camera feature handle
Enumeration item name
true indicates that the camera supports the enumeration item, while false indicates that the camera does not support the enumeration item
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
判断枚举项是否存在
相机设备句柄
相机特征名称
枚举项名称
true表示相机支持该枚举项，false表示相机不支持该枚举项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Determine whether the enumeration item exists
Camera device handle
Camera feature name
Enumeration item name
true indicates that the camera supports the enumeration item, while false indicates that the camera does not support the enumeration item
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
根据相机特征执行相应命令
相机特征句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevExecuteCommand 代替。
\~english
Execute corresponding commands based on camera feature
Camera feature handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevExecuteCommand instead.
\~chinese
判断命令类型特征是否执行完成
相机特征句柄
是否执行完成
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevCommandIsDone 代替。
\~english
Determine whether the command type feature has been executed successfully
Camera feature handle
Is the execution completed
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevCommandIsDone instead.
\~chinese
判断特征是否为选择器
相机特征句柄
是否为选择器
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
如果相机特征是选择器，在当该特征值改变时应该更新所有被选择特征的值。
\~english
Determine whether the feature is selector
Camera feature handle
Whether it is selector
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
If the camera feature is selector, the values of all selected features should be updated when the feature value changes.
\~chinese
判断特征是否为选择器
相机设备句柄
相机特征名称
是否为选择器
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
如果相机特征是选择器，在当该特征值改变时应该更新所有被选择特征的值。
\~english
Determine whether the feature is selector
Camera device handle
Camera feature name
Whether it is selector
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
If the camera feature is selector, the values of all selected features should be updated when the feature value changes.
\~chinese
获取被选择特征的数量
相机特征句柄
被选择特征的数量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetSelectedFeatureCounts 代替。
\~english
Get the number of selected features
Camera feature handle
The number of selected features
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetSelectedFeatureCounts instead.
\~chinese
获取被选择特征的名称
相机特征句柄
特征索引，有效范围[0, ItkFeatureGetSelectedFeatureCounts -1]
被选择特征的名称
作为输入指明特征名称的最大长度，作为输出指明特征名称的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: 该接口已弃用，请使用 ItkDevGetSelectedFeatureName 代替。
\~english
Get the name of the selected feature
Camera feature handle
Feature index, valid range is [0, ItkFeatureGetSelectedFeatureCounts -1]
The name of the selected feature
As input, it indicates the maximum length of feature name. As output, it indicates the effective length of feature name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
Deprecated: This interface is obsolete, please use ItkDevGetSelectedFeatureName instead.
\~chinese
获取相机特征的轮询周期
相机特征句柄
相机特征查询的轮询时间
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
对于只读型特征例如相机温度，可能需要周期性的更新该特征值来实时监控相机状态，轮询时间指明更新周期的最小值。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Polling period for getting camera features
Camera feature handle
Polling time for camera feature query
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
For read-only features such as camera temperature, it may be necessary to periodically update the feature value to monitor the camera status in real time,
and the polling time indicates the minimum value of the update period.
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取相机特征的轮询周期
相机设备句柄
相机特征名称
相机特征查询的轮询时间
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
对于只读型特征例如相机温度，可能需要周期性的更新该特征值来实时监控相机状态，轮询时间指明更新周期的最小值。
Deprecated: 该接口已弃用，请使用 ItkDevGetFeatureInfo 代替。
\~english
Polling period for getting camera features
Camera device handle
Camera feature name
Polling time for camera feature query
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
For read-only features such as camera temperature, it may be necessary to periodically update the feature value to monitor the camera status in real time,
and the polling time indicates the minimum value of the update period.
Deprecated: This interface is obsolete, please use ItkDevGetFeatureInfo instead.
\~chinese
获取缓冲区参数
缓冲区句柄
参数索引
参数值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
可读的缓冲区参数prm如下所示：
| 可读的缓冲区参数prm |
|----------------------------------------------|
| ITKBUFFER_PRM_FORMAT |
| ITKBUFFER_PRM_WIDTH |
| ITKBUFFER_PRM_HEIGHT |
| ITKBUFFER_PRM_ADDRESS |
| ITKBUFFER_PRM_HOST_COUNTER_STAMP |
| ITKBUFFER_PRM_STATE |
| ITKBUFFER_PRM_SIGNED |
| ITKBUFFER_PRM_SIZE |
| ITKBUFFER_PRM_BLOCK_ID |
| ITKBUFFER_PRM_READY_LINES |
| ITKBUFFER_PRM_ERROR_REASON |
| ITKBUFFER_PRM_RSND_PKT_COUNT |
| ITKBUFFER_PRM_LOST_PKT_COUNT |
| ITKBUFFER_PRM_FIND_LINE_RESULT |
| ITKBUFFER_PRM_BATCH_STATUS_ADDRESS |
| ITKBUFFER_PRM_BURR_DECTION_RESULT |
| ITKBUFFER_PRM_BURR_DECTION_RESULT_COORDINATE |
| ITKBUFFER_PRM_BURR_DECTION_DEBUG |
| ITKBUFFER_PRM_PAYLOAD_TYPE |
| ITKBUFFER_PRM_IMAGE_SIZE |
| ITKBUFFER_PRM_PIXEL_BITS |
| ITKBUFFER_PRM_CHANNEL_BITS |
| ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
Deprecated: 该接口已弃用，请使用 ItkBufferGetInfo 代替。
\~english
Get buffer parameter
Buffer handle
Parameter index
Parameter value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Readable buffer parameters prm are as follows:
| Readable Buffer Parameters prm |
|----------------------------------------------|
| ITKBUFFER_PRM_FORMAT |
| ITKBUFFER_PRM_WIDTH |
| ITKBUFFER_PRM_HEIGHT |
| ITKBUFFER_PRM_ADDRESS |
| ITKBUFFER_PRM_HOST_COUNTER_STAMP |
| ITKBUFFER_PRM_STATE |
| ITKBUFFER_PRM_SIGNED |
| ITKBUFFER_PRM_SIZE |
| ITKBUFFER_PRM_BLOCK_ID |
| ITKBUFFER_PRM_READY_LINES |
| ITKBUFFER_PRM_ERROR_REASON |
| ITKBUFFER_PRM_RSND_PKT_COUNT |
| ITKBUFFER_PRM_LOST_PKT_COUNT |
| ITKBUFFER_PRM_FIND_LINE_RESULT |
| ITKBUFFER_PRM_BATCH_STATUS_ADDRESS |
| ITKBUFFER_PRM_BURR_DECTION_RESULT |
| ITKBUFFER_PRM_BURR_DECTION_RESULT_COORDINATE |
| ITKBUFFER_PRM_BURR_DECTION_DEBUG |
| ITKBUFFER_PRM_PAYLOAD_TYPE |
| ITKBUFFER_PRM_IMAGE_SIZE |
| ITKBUFFER_PRM_PIXEL_BITS |
| ITKBUFFER_PRM_CHANNEL_BITS |
| ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
Deprecated: This interface is obsolete, please use ItkBufferGetInfo instead.
\~chinese
设置缓冲区参数
缓冲区句柄
参数索引
参数值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
可写的缓冲区参数prm如下所示：
| 可写的缓冲区参数prm |
|----------------------------------------------|
| ITKBUFFER_PRM_FORMAT |
| ITKBUFFER_PRM_WIDTH |
| ITKBUFFER_PRM_HEIGHT |
| ITKBUFFER_PRM_ADDRESS |
| ITKBUFFER_PRM_EXCHANGE_WIDTH_HEIGHT |
| ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
\~english
Set buffer parameter
Buffer handle
Parameter index
Parameter value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Writable buffer parameters prm are as follows:
| Writable Buffer Parameters prm |
|----------------------------------------------|
| ITKBUFFER_PRM_FORMAT |
| ITKBUFFER_PRM_WIDTH |
| ITKBUFFER_PRM_HEIGHT |
| ITKBUFFER_PRM_ADDRESS |
| ITKBUFFER_PRM_EXCHANGE_WIDTH_HEIGHT |
| ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
\~chinese
RGB通道重排列
源缓冲区句柄，像素格式必须是彩色格式
目的缓冲区句柄。目的缓冲区图像高度必须是源缓冲区图像高度的3倍，像素格式大小必须是源缓冲区的1/3
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
重排后的像素如下
```
R1R2R3
G1G2G3
B1B2B3
(R1G1B1)(R2G2B2)(R3G3B3) R4R5R6
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) B4B5B6
R7R8R9
G7G8G9
B7B8B9
```
Deprecated: 该接口已弃用，请使用 ItkBufferRGBSplitEx 代替。
\~english
RGB channel rearrangement
Source buffer handle, pixel format must be in color format
Destination buffer handle. The height of the destination buffer image must be three times that of the source buffer image,
and the pixel format size must be one-third that of the source buffer
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Pixel after rearrangement
```
R1R2R3
G1G2G3
B1B2B3
(R1G1B1)(R2G2B2)(R3G3B3) R4R5R6
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) B4B5B6
R7R8R9
G7G8G9
B7B8B9
```
Deprecated: This interface is obsolete, please use ItkBufferRGBSplitEx instead.
\~chinese
初始化IKapC开发环境
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
必须在调用其他IKapC函数之前调用该函数。
\~english
Initialize IKapC development environment
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
This function must be called before calling other IKapC functions.
\~chinese
释放IKapC初始化过程中申请的资源
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
必须在其他IKapC函数调用完成之后调用该函数。
\~english
Release resources requested during initialization process of IKapC
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
This function must be called after other IKapC function calls are completed.
\~chinese
获取当前库版本
当前库版本
- ITKSTATUS_OK
| 0xff000000 | 0x00ff0000 | 0x0000ff00 | 0x000000ff |
|------------|------------|------------|------------|
| 主要版本号 | 次要版本号 | 补丁版本号 | 特定版本号 |
\~english
Get the current library version
Current library version
- ITKSTATUS_OK
| 0xff000000 | 0x00ff0000 | 0x0000ff00 | 0x000000ff |
|--------------|--------------|--------------|----------------|
| Major version| Minor version| Patch version|Specific version|
\~chinese
添加cti库路径，多个路径间以英文;分隔
cti路径
- ITKSTATUS_OK
\~english
Add cti path, use ; to split mulit cti path
cti path
- ITKSTATUS_OK
\~chinese
获取IKapC日志路径
日志路径
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
\~english
Get IKapC log path
log path
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
\~chinese
获取当前连接到PC上相机设备的数量
当前连接到PC上的相机的数量
- ITKSTATUS_OK
\~english
Get the current number of camera devices connected to PC
The current number of camera connected to PC
- ITKSTATUS_OK
\~chinese
获取相机设备信息
相机索引，有效范围[0, ItkManGetDeviceCount -1]
相机描述信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
在调用本函数前必须先调用 ItkManGetDeviceCount 或 ItkManGetDeviceCountEx 。
\~english
Get camera device information
Camera index, valid range is [0, ItkManGetDeviceCount -1]
Camera description information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
Before calling this function, ItkManGetDeviceCount or ItkManGetDeviceCountEx must be called first.
\~chinese
获取网口相机专有设备信息
相机索引，有效范围[0, ItkManGetDeviceCount -1]
网口相机专有设备信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
在调用本函数前必须先调用 ItkManGetDeviceCount 或 ItkManGetDeviceCountEx 。
\~english
Get network camera specific device information
Camera index, valid range is [0, ItkManGetDeviceCount -1]
Network camera specific device information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
Before calling this function, ItkManGetDeviceCount or ItkManGetDeviceCountEx must be called first.
\~chinese
获取Camera Link相机专有信息
相机索引，有效范围[0, ItkManGetDeviceCount -1]
Camera Link相机专有设备信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
在调用本函数前必须先调用 ItkManGetDeviceCount 或 ItkManGetDeviceCountEx 。
\~english
Get Camera Link camera specific information
Camera index, valid range is [0, ItkManGetDeviceCount -1]
Camera Link camera specific device information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
Before calling this function, ItkManGetDeviceCount or ItkManGetDeviceCountEx must be called first.
\~chinese
获取CoaXPress相机专有信息
相机索引，有效范围[0, ItkManGetDeviceCount -1]
CoaXPress相机专有设备信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
在调用本函数前必须先调用 ItkManGetDeviceCount 或 ItkManGetDeviceCountEx 。
\~english
Get CoaXPress camera specific information
Camera index, valid range is [0, ItkManGetDeviceCount -1]
CoaXPress camera specific device information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
Before calling this function, ItkManGetDeviceCount or ItkManGetDeviceCountEx must be called first.
\~chinese
获取USB3.0相机专有信息
相机索引，有效范围[0, ItkManGetDeviceCount -1]
USB3.0相机专有设备信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
在调用本函数前必须先调用 ItkManGetDeviceCount 或 ItkManGetDeviceCountEx 。
\~english
Get USB3.0 camera specific information
Camera index, valid range is [0, ItkManGetDeviceCount -1]
USB3.0 camera specific device information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
Before calling this function, ItkManGetDeviceCount or ItkManGetDeviceCountEx must be called first.
\~chinese
获取GigEVision Board设备专有信息
相机索引，有效范围[0, ItkManGetDeviceCount -1]
GigEVision Board相机专有设备信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
在调用本函数前必须先调用 ItkManGetDeviceCount 或 ItkManGetDeviceCountEx 。
\~english
Get GigEVision Board device specific information
Camera index, valid range is [0, ItkManGetDeviceCount -1]
GigEVision Board camera specific device information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_DEVICE_ID_OUTOF_RANGE
- ITKSTATUS_NOT_IMPLEMENT
Before calling this function, ItkManGetDeviceCount or ItkManGetDeviceCountEx must be called first.
\~chinese
获取状态码信息
状态码
错误类别信息
作为输入指明错误类别信息最大长度，作为输出指明错误类别信息有效长度
错误级别信息
作为输入指明错误级别信息最大长度，作为输出指明错误级别信息有效长度
错误模块信息
作为输入指明错误模块信息最大长度，作为输出指明错误模块信息有效长度
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
- ITKSTATUS_BUFFER_TOO_SMALL
\~english
Get status code information
Status code
Error ID information
As input, it indicates the maximum length of error ID information. As output, it indicates the effective length of error ID information
Error level information
As input, it indicates the maximum length of error level information information. As output, it indicates the effective length of error level information information
Error module information
As input, it indicates the maximum length of error module information information. As output, it indicates the effective length of error module information information
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
- ITKSTATUS_BUFFER_TOO_SMALL
\~chinese
获取全局参数
全局参数索引
参数值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_ARG_OUT_OF_RANGE
可读的全局参数prm如下所示：
| 可读的全局参数prm |
|---------------------------------------------------|
| ITKMANAGER_COAXPRESS_12_SUPPORT |
| ITKMANAGER_COAXPRESS_COMMUNICATION_TAG_SUPPORT |
| ITKMANAGER_COAXPRESS_CONTROL_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_STREAM_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_RW_REGISTER_MAX_TIME |
| ITKMANAGER_ENABLE_MERGE_SAME_SERIAL_NUMBER_CAMERA |
| ITKMANAGER_GV_CONTROL_DISCORY_TIMEOUT |
\~english
Get manager parameter
Manager parameter index
Parameter value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_ARG_OUT_OF_RANGE
Readable global parameters prm are shown as follows:
| Readable global parameters prm |
|---------------------------------------------------|
| ITKMANAGER_COAXPRESS_12_SUPPORT |
| ITKMANAGER_COAXPRESS_COMMUNICATION_TAG_SUPPORT |
| ITKMANAGER_COAXPRESS_CONTROL_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_STREAM_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_RW_REGISTER_MAX_TIME |
| ITKMANAGER_ENABLE_MERGE_SAME_SERIAL_NUMBER_CAMERA |
| ITKMANAGER_GV_CONTROL_DISCORY_TIMEOUT |
\~chinese
设置全局参数
全局参数索引
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
可写的全局参数prm如下所示：
| 可写的全局参数prm |
|---------------------------------------------------|
| ITKMANAGER_COAXPRESS_12_SUPPORT |
| ITKMANAGER_COAXPRESS_COMMUNICATION_TAG_SUPPORT |
| ITKMANAGER_COAXPRESS_CONTROL_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_STREAM_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_RW_REGISTER_MAX_TIME |
| ITKMANAGER_ENABLE_MERGE_SAME_SERIAL_NUMBER_CAMERA |
| ITKMANAGER_GV_CONTROL_DISCORY_TIMEOUT |
\~english
Set manager parameter
Manager parameter index
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Writable global parameters prm are shown as follows:
| Writable global parameters prm |
|---------------------------------------------------|
| ITKMANAGER_COAXPRESS_12_SUPPORT |
| ITKMANAGER_COAXPRESS_COMMUNICATION_TAG_SUPPORT |
| ITKMANAGER_COAXPRESS_CONTROL_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_STREAM_PACKET_MAX_SIZE |
| ITKMANAGER_COAXPRESS_RW_REGISTER_MAX_TIME |
| ITKMANAGER_ENABLE_MERGE_SAME_SERIAL_NUMBER_CAMERA |
| ITKMANAGER_GV_CONTROL_DISCORY_TIMEOUT |
\~chinese
打开相机设备
相机索引，有效范围[0, ItkManGetDeviceCount -1]
相机访问模式
相机设备句柄
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
1. 在对设备进行其他操作之前，必须首先打开设备。
2. 打开相机设备前，必须先枚举当前电脑上可用相机的数量。
3. 相机访问模式可选项如下所示：
| 访问模式 |
|----------------------------------|
| ITKDEV_VAL_ACCESS_MODE_MONITOR |
| ITKDEV_VAL_ACCESS_MODE_CONTROL |
| ITKDEV_VAL_ACCESS_MODE_STREAM |
| ITKDEV_VAL_ACCESS_MODE_EXCLUSIVE |
\~english
Open camera device
Camera index, valid range is [0, ItkManGetDeviceCount -1]
Camera access mode
Camera device handle
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
1. Before performing any other operations on the device, it must be turned on first.
2. Before opening camera device, users must first enumerate the number of available camera on the current computer.
3. Camera access mode options are as follows:
| Access mode |
|----------------------------------|
| ITKDEV_VAL_ACCESS_MODE_MONITOR |
| ITKDEV_VAL_ACCESS_MODE_CONTROL |
| ITKDEV_VAL_ACCESS_MODE_STREAM |
| ITKDEV_VAL_ACCESS_MODE_EXCLUSIVE |
\~chinese
通过指定xml打开相机设备
相机索引，有效范围[0, ItkManGetDeviceCount -1]
相机访问模式，用户可以根据需要使用任意值或者它们的组合（通过“or”标志连接）
相机设备句柄
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
1. 在对设备进行其他操作之前，必须首先打开设备。
2. 打开相机设备前，必须先调用 ItkManGetDeviceCount 枚举当前电脑上可用相机的数量。
3. 相机xml文件地址格式为“ local:[///]filename.extension;address;length[?SchemaVersion=x.x.x] ”的URL表示XML描述文件位于模块的虚拟寄存器映射中。
一个完整的本地URL应该是从设备读取的“ local:itk_dev.zip;F0F00000;3BF?SchemaVersion=1.0.0 ”或
从文件读取的“ file:///C:program%20files/genicam/xml/genapi/tlguru/tlguru_system_rev1.xml?SchemaVersion=1.0.0 ”。
4. 相机访问模式可选项如下所示：
| 访问模式 |
|----------------------------------|
| ITKDEV_VAL_ACCESS_MODE_MONITOR |
| ITKDEV_VAL_ACCESS_MODE_CONTROL |
| ITKDEV_VAL_ACCESS_MODE_STREAM |
| ITKDEV_VAL_ACCESS_MODE_EXCLUSIVE |
\~english
Open camera device by specifying xml
Camera index, valid range is [0, ItkManGetDeviceCount -1]
Camera access mode, users can use any value or combination of them as needed (connected by the "or" flag)
Camera device handle
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
1. Before performing any other operations on the device, it must be turned on first.
2. Before opening camera device, users must first call ItkManGetDeviceCount to enumerate the number of available camera on the current computer.
3. The camera xml file address format is “ local:[///]filename.extension;address;length[?SchemaVersion=x.x.x] ”.
The URL represents that the xml description file is located in the virtual register mapping of the module.
A complete local URL should be read from the device as “ local:itk_dev.zip;F0F00000;3BF?SchemaVersion=1.0.0 ” or
read from file as “ file:///C:program%20files/genicam/xml/genapi/tlguru/tlguru_system_rev1.xml?SchemaVersion=1.0.0 ”.
4. Camera access mode options are as follows:
| Access mode |
|----------------------------------|
| ITKDEV_VAL_ACCESS_MODE_MONITOR |
| ITKDEV_VAL_ACCESS_MODE_CONTROL |
| ITKDEV_VAL_ACCESS_MODE_STREAM |
| ITKDEV_VAL_ACCESS_MODE_EXCLUSIVE |
\~chinese
检测相机是否连接
相机设备句柄
连接状态
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
\~english
Check if the camera is already connected
Camera device handle
connection status
- ITKSTATUS_OK
- ITKSTATUS_ARG_OUT_OF_RANGE
\~chinese
关闭相机设备
相机设备句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
当设备关闭后除非再次打开，否则无法访问。
\~english
Close camera device
Camera device handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
After the device is closed, it cannot be accessed unless it is opened again.
\~chinese
读取相机设备xml
相机设备句柄
读取的相机xml文件
作为输入指明相机xml文件最大长度，作为输出指明相机xml文件有效长度
预留选项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Read camera device xml
Camera device handle
Camera xml file
As input, it indicates the maximum length of camera XML file. As output, it indicates the effective length of camera XML file
Reserved option
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
加载相机设备配置文件
相机设备句柄
相机设备文件名称，以.ccf为后缀
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
本函数必须要指明配置文件的全部路径。
\~english
Load camera device configuration file
Camera device handle
Camera device file name with .ccf suffix
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
This function must indicate the full path of the configuration file.
\~chinese
保存相机设备配置文件
相机设备句柄
相机设备文件名称，以.ccf为后缀
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
本函数必须要指明配置文件的全部路径。
\~english
Save camera device configuration file
Camera device handle
Camera device file name with .ccf suffix
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
This function must indicate the full path of the configuration file.
\~chinese
相机固件升级,函数成功返回后需要等待相机状态灯变为绿色时，断上电以使升级生效
相机设备句柄
本地固件文件
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
本函数必须要指明文件的全部路径
\~english
Upgrade device's firmware. When the function returns successfully, the camera should be repowered when status light turns green
Camera device handle
local firmware file
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
This function must indicate the full path of the file. Applicable to postfix.
\~chinese
获取相机升级进度
相机设备句柄
相机升级进度：0-300。0-100：擦除进度，101-200：写入进度，201-300：升级进度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Get the process of device upgrade
Camera device handle
the process of device upgrade: 0-300. 0-100: Erase progress, 101-200: Write progress，201-300: Upgrade progress
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取相机支持配置特征的数量
相机设备句柄
相机支持的特征数量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Get the number of camera supported configuration features
Camera device handle
The number of features supported by camera
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取相机特征名称
相机设备句柄
特征索引，有效范围[0, ItkDevGetFeatureCount -1]
特征名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_BUFFER_TOO_SMALL
\~english
Get camera feature name
Camera device handle
Feature index, valid range is [0, ItkDevGetFeatureCount -1]
Feature name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_BUFFER_TOO_SMALL
\~chinese
获取相机的寄存器地址数量
相机设备句柄
寄存器地址数量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Get the number of camera register addresses
Camera device handle
The number of camera register addresses
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取相机寄存器信息
相机设备句柄
寄存器索引，有效范围[0, ItkDevGetRegisterCount -1]
寄存器地址
寄存器长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_BUFFER_TOO_SMALL
\~english
Get camera register info
Camera device handle
Register index, valid range is [0, ItkDevGetRegisterCount -1]
Register address
Register length
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_BUFFER_TOO_SMALL
\~chinese
获取相机数据流的数量
相机设备句柄
相机可用数据流的数量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Camera Link相机不存在数据流通道。
\~english
Get the number of camera data streams
Camera feature handle
The number of available data streams for the camera
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Camera Link camera has no data stream channel.
\~chinese
申请数据流采集过程中需要的资源, 同时会为该数据流分配合适属性的缓冲区
相机的句柄
数据流索引，有效范围[0, ItkDevGetStreamCount -1]
当前流分配的缓冲区数量
数据流句柄，控制数据流整个生命周期
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 对于同一个相机，可能存在多个数据流同时采集数据，通过索引来指明希望采集的数据流。
2. 收集数据流资源的过程中必须指定至少一个数据缓冲区，用来存放采集过程中的图像数据。
\~english
Creates an stream object with the specified number of buffers. The width, height, format of buffers are same as stream's
Device handle
Data stream index, valid range is [0, ItkDevGetStreamCount -1]
The Number of buffers created for the phStream
Stream handle, controlling the entire life cycle of data stream
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. For the same camera, there may be multiple data streams grab data simultaneously. Use an index to indicate the desired data stream to grab.
2. During the process of grabbing data stream resources, a data buffer must be specified to store the image data grabbed during acquisition process.
\~chinese
释放数据流采集过程中申请的资源
数据流句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
1. 如果存在正在进行的数据流采集过程，本函数将停止数据采集并释放资源。
2. 本函数不会释放数据传输过程中的缓冲区资源，用户需要调用 ItkBufferFree 释放缓冲区。
\~english
Release the resources requested during data stream acquisition process
Data stream handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
1. If there is an ongoing data stream acquisition process, this function will stop data acquisition and release resources.
2. This function will not release buffer resources during data transmission. Users need to call ItkBufferFree to release buffer.
\~chinese
获取相机支持触发事件的数量
相机设备句柄
相机支持触发事件的数量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get the number of triggering events supported by the camera
Camera device handle
The number of triggering events supported by the camera
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取相机支持触发事件的名称
相机设备句柄
事件索引，有效范围[0, ItkDevGetEventCount -1]
相机触发事件的名称
作为输入指明触发事件名称的最大长度，作为输出指明触发事件名称的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_BUFFER_TOO_SMALL
用户可以为其感兴趣的触发事件注册回调函数进行进一步的处理。
\~english
Get the name of triggering events supported by the camera
Camera device handle
Event index, valid range is [0, ItkDevGetEventCount -1]
The name of triggering events supported by the camera
As input, it indicates the maximum length of event name. As output, it indicates the effective length of event name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_BUFFER_TOO_SMALL
Users can register callback functions for their interested triggering events for further processing.
\~chinese
判断相机是否支持该触发事件
相机设备句柄
相机触发事件的名称
true表示相机支持该触发事件，false表示相机不支持该触发事件
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Determine whether the camera supports the triggering event
Camera device handle
The name of triggering events supported by the camera
true indicates that the camera supports the triggering event, while false indicates that the camera does not support the triggering event
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
为相机触发事件注册回调函数
相机设备句柄
相机触发事件的名称
用户回调函数地址
用户回调函数参数（结构体、缓冲区等），可以为NULL
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 多次为相同事件注册回调函数，仅会调用最近一次注册的回调函数。
2. pEventName输入项如下所示：
| pEventName |
|----------------------|
| DeviceRemove |
| FeatureValueChanged |
| MessageChannel |
\~english
Register callback functions for camera triggering event
Camera device handle
The name of triggering events supported by the camera.
User callback function address
User callback function parameters (structure, buffer, etc.), which can be NULL
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. Multiple registrations of callback functions for the same event will only call the most recently registered callback function.
2. The input items of pEventName are as follows:
| pEventName |
|----------------------|
| DeviceRemove |
| FeatureValueChanged |
| MessageChannel |
\~chinese
清除注册的回调函数
相机设备句柄
相机触发事件的名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
pEventName输入项如下所示：
| pEventName |
|----------------------|
| DeviceRemove |
| FeatureValueChanged |
| MessageChannel |
\~english
Clear the registered callback function
Camera device handle
The name of triggering events supported by the camera
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The input items of pEventName are as follows:
| pEventName |
|----------------------|
| DeviceRemove |
| FeatureValueChanged |
| MessageChannel |
\~chinese
获取相机参数
相机设备句柄
设备参数索引
参数值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
可读的设备参数prm如下所示：
| 可读的设备参数prm |
|-------------------------------------------------|
| ITKDEV_PRM_HEARTBEAT_TIMEOUT |
| ITKDEV_PRM_INTERFACE_TYPE |
| ITKDEV_PRM_DISABLE_HEARTBEAT_THREAD |
| ITKDEV_PRM_DISABLE_CONTROL_CHANNEL_WAITING_ACK |
| ITKDEV_PRM_CONTROL_CHANNEL_TIMEOUT |
\~english
Get camera parameter
Camera device handle
Device parameter index
Parameter value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Readable device parameters prm are shown as follows:
| Readable device parameters |
|-------------------------------------------------|
| ITKDEV_PRM_HEARTBEAT_TIMEOUT |
| ITKDEV_PRM_INTERFACE_TYPE |
| ITKDEV_PRM_DISABLE_HEARTBEAT_THREAD |
| ITKDEV_PRM_DISABLE_CONTROL_CHANNEL_WAITING_ACK |
| ITKDEV_PRM_CONTROL_CHANNEL_TIMEOUT |
\~chinese
获取相机像素格式对应参数值
相机设备句柄
像素格式字符串
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get the parameter values corresponding to the camera pixel format
Camera device handle
Pixel format string
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
设置相机参数
相机设备句柄
设备参数索引
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
可写的设备参数prm如下所示：
| 可写的设备参数prm |
|-------------------------------------------------|
| ITKDEV_PRM_HEARTBEAT_TIMEOUT |
| ITKDEV_PRM_DISABLE_HEARTBEAT_THREAD |
| ITKDEV_PRM_DISABLE_CONTROL_CHANNEL_WAITING_ACK |
| ITKDEV_PRM_CONTROL_CHANNEL_TIMEOUT |
\~english
Set camera parameter
Camera device handle
Device parameter index
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Writable device parameters prm are shown as follows:
| Writable device parameters prm |
|-------------------------------------------------|
| ITKDEV_PRM_HEARTBEAT_TIMEOUT |
| ITKDEV_PRM_DISABLE_HEARTBEAT_THREAD |
| ITKDEV_PRM_DISABLE_CONTROL_CHANNEL_WAITING_ACK |
| ITKDEV_PRM_CONTROL_CHANNEL_TIMEOUT |
\~chinese
从Device端口读取原始数据
相机设备句柄
存放数据的缓冲区
寄存器地址
缓冲区长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
从Device端口读取的原始数据将被写入缓冲区，请确保缓冲区大小足够。
\~english
Read raw data from Device port
Camera device handle
Buffer for storing data
Register address
Buffer length
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The raw data read from Device port will be written to the buffer, please ensure that the buffer size is sufficient.
\~chinese
向Device端口写入原始数据
相机设备句柄
存放数据的缓冲区
寄存器地址
缓冲区长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
从缓冲区读取的原始数据将被写入Device端口，请确保缓冲区大小适当。
\~english
Write raw data to Device port
Camera device handle
Buffer for storing data
Register address
Buffer length
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The raw data read from the buffer will be written to Device port, please ensure that the buffer size is sufficient.
\~chinese
设置千兆网相机临时IP地址
设备MAC地址，例如00-30-53-06-1a-58
待设置IP地址，例如192.168.1.2
待设置子网掩码，例如255.255.255.0
待设置默认网关，例如192.168.1.1
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
调用此函数时，必须关闭相机进行配置。
\~english
Set force IP address for gigabit network camera
Device MAC address, such as 00-30-53-06-1a-58
IP address to be set, such as 192.168.1.2
Subnet mask to be set, such as 255.255.255.0
Default gateway to be set, such as 192.168.1.1
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
When calling this function, the camera must be turned off for configuration.
\~chinese
向GigEDevice端口写入原始UDP payload数据
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
从缓冲区读取的原始数据将被写入Device 的GVCP端口，请确保缓冲区大小适当，确保整个IP包大小不超过MTU(一般为1500)。
\~english
Write the raw UDP payload data to the GigEDevice port
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The raw data read from the buffer will be written to the Device GVCP port,
make sure that the buffer is appropriate in size and that the entire IP package size does not exceed the MTU (generally 1500).
\~chinese
获取千兆网相机静态IP地址
相机设备句柄
设备静态IP地址，例如192.168.1.2
静态IP地址长度
设备静态子网掩码，例如255.255.255.0
静态子网掩码长度
设备默认网关，例如192.168.1.1
默认网关长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get persistent IP address of gigabit network camera
Camera device handle
Device persistent IP address, such as 192.168.1.2
Persistent IP address length
Device persistent subnet mask, such as 255.255.255.0
Persistent subnet mask length
Device default gateway, such as 192.168.1.1
Default gateway length
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
设置千兆网相机静态IP地址
相机设备句柄
设备静态IP地址，例如192.168.1.2
设备静态子网掩码，例如255.255.255.0
设备默认网关，例如192.168.1.1
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Set persistent IP address of gigabit network camera
Camera device handle
Device persistent IP address, such as 192.168.1.2
Device persistent subnet mask, such as 255.255.255.0
Device default gateway, such as 192.168.1.1
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取相机特征访问模式
相机设备句柄
相机特征名称
相机特征访问模式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
特征访问模式可选项如下所示：
| 访问模式 |
|--------------------------------------|
| ITKFEATURE_VAL_ACCESS_MODE_UNDEFINED |
| ITKFEATURE_VAL_ACCESS_MODE_RW |
| ITKFEATURE_VAL_ACCESS_MODE_RO |
| ITKFEATURE_VAL_ACCESS_MODE_WO |
| ITKFEATURE_VAL_ACCESS_MODE_NI |
| ITKFEATURE_VAL_ACCESS_MODE_NA |
\~english
Get camera feature access mode
Camera device handle
Camera feature name
Camera feature access mode
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The available options for feature access mode are as follows:
| Access mode |
|--------------------------------------|
| ITKFEATURE_VAL_ACCESS_MODE_UNDEFINED |
| ITKFEATURE_VAL_ACCESS_MODE_RW |
| ITKFEATURE_VAL_ACCESS_MODE_RO |
| ITKFEATURE_VAL_ACCESS_MODE_WO |
| ITKFEATURE_VAL_ACCESS_MODE_NI |
| ITKFEATURE_VAL_ACCESS_MODE_NA |
\~chinese
获取相机特征基本信息
相机设备句柄
相机特征名称
相机特征基本信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get camera feature basic information
Camera device handle
Camera feature name
Camera feature basic information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
无效化设备所有特征的缓存
相机设备句柄
使用此函数可以刷新设备所有特征值. 调用时会触发所有特征的ITKDEV_VAL_EVENT_TYPE_FEATURE_VALUE_CHANGED事件.
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Invalidate all features cache in the device.
Camera device handle
Use this function to refresh all features' value.
Trigger ITKDEV_VAL_EVENT_TYPE_FEATURE_VALUE_CHANGED event when executing.
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取64位整数类型特征的值
相机设备句柄
相机特征名称
64位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of 64bit integer type feature
Camera device handle
Camera feature name
Value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
设置64位整数类型特征的值
相机设备句柄
相机特征名称
64位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
设定值的取值范围一定是[ Min, Max ]，取值同时也应满足value = Min + N*Inc ，N=0,1,2,…
\~english
Set the value of 64bit integer type feature
Camera device handle
Camera feature name
Value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The range of values for the set value must be [ Min ,Max ],
value should also satisfy the condition of value = Min + N*Inc , N=0,1,2,…
\~chinese
获取64位整数类型特征基本信息
相机设备句柄
相机特征名称
相机特征基本信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get 64bit integer type feature basic information
Camera device handle
Camera feature name
Camera feature basic information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取浮点数类型特征的值
相机设备句柄
相机特征名称
64位浮点数类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get value of double type feature
Camera device handle
Camera feature name
Value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
设置浮点数类型特征的值
相机设备句柄
相机特征名称
64位浮点数类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
设定值的取值范围一定是[ Min ,Max ]。
\~english
Set value of double type feature
Camera device handle
Camera feature name
Value of 64bit double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The range of values for the set value must be [ Min ,Max ].
\~chinese
获取浮点数类型特征基本信息
相机设备句柄
相机特征名称
相机特征基本信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get double type feature basic information
Camera device handle
Camera feature name
Camera feature basic information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取布尔数据类型特征的值
相机设备句柄
相机特征名称
布尔类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of boolean type feature
Camera device handle
Camera feature name
Boolean type value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
设置布尔数据类型特征的值
相机设备句柄
相机特征名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Set the value of boolean type feature
Camera device handle
Camera feature name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取字符串或枚举类型特征的值
相机设备句柄
相机特征名称
字符串或枚举类型的相机特征值
作为输入指明特征值的最大长度，作为输出指明特征值的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
传递给此函数的缓冲区必须足够容纳整个字符串。如果调用该函数时，将pBuff设置为NULL，则pBufLen指向的变量将设置为所需的缓冲区大小。
\~english
Get the value of string or enumeration type
Camera device handle
Camera feature name
Value of string or enumeration type
As input, it indicates the maximum length of feature value. As output, it indicates the effective length of feature value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
The buffer passed to this function must be sufficient to hold the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
\~chinese
设置字符串或枚举类型特征的值
相机设备句柄
相机特征名称
字符串或枚举类型的相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Set the value of string or enumeration type
Camera device handle
Camera feature name
Value of string or enumeration type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取枚举类型特征枚举项基本信息
相机设备句柄
相机特征名称
枚举项索引
枚举项基本信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get basic information of entry of enumeration type feature
Camera device handle
Camera feature name
Entry index
Entry basic information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
根据相机特征执行相应命令
相机设备句柄
相机特征名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Execute corresponding commands based on camera feature
Camera device handle
Camera feature name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
判断命令类型特征是否执行完成
相机设备句柄
相机特征名称
是否执行完成
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Determine whether the command type feature has been executed successfully
Camera device handle
Camera feature name
Is the execution completed
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取被选择特征的数量
相机设备句柄
相机特征名称
被选择特征的数量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the number of selected features
Camera device handle
Camera feature name
The number of selected features
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取被选择特征的名称
相机设备句柄
相机特征名称
特征索引，有效范围[0, ItkDevGetSelectedFeatureCounts -1]
被选择特征的名称
作为输入指明特征名称的最大长度，作为输出指明特征名称的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the name of the selected feature
Camera device handle
Camera feature name
Feature index, valid range is [0, ItkDevGetSelectedFeatureCounts -1]
The name of the selected feature
As input, it indicates the maximum length of feature name. As output, it indicates the effective length of feature name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取U3V的传输包大小
相机设备句柄
传输的包大小指针，单位Byte
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
接口仅U3V协议的USB相机支持。
\~english
Get transfer size of U3V device
Camera device handle
Transfer size, unit is Byte
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
The interface is only supported by the USB camera of the U3V protocol.
\~chinese
设置U3V的传输包大小
相机设备句柄
传输的包大小，单位Byte，默认为0x400000，范围[ 0x400, 0x400000]
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
接口仅U3V协议的USB相机支持。增加传输包大小可以适当降低取流时的CPU占用率。
但不同的PC和不同USB扩展卡存在不同的兼容性，如果该参数设置过大可能会出现取不到图像的风险。
\~english
Set transfer size of U3V device
Camera device handle
Transfer size, unit is Byte，default 0x400000，rang in [ 0x400, 0x400000]
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
The interface is only supported by the USB camera of the U3V protocol.
Increasing the transmission package size can appropriately reduce the CPU occupancy during flow extraction. However, different PC and different USB expansion cards have different compatibility, and if this parameter is set too large, there may be the risk of not taking the image.
\~chinese
异步结束数据流采集
数据流句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
当本函数执行完成后，采集过程将会被终止，但是无法保证最后一帧图像的完整性。
\~english
Asynchronously stop data stream acquisition
Data stream handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
After the execution of this function is completed, the acquisition process will be stopped, but the integrity of the last frame image cannot be guaranteed.
\~chinese
设置CPU亲和性
数据流句柄
是否设置CPU亲和性
CPU核数
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
通常情况下，程序运行时，资源会根据PC策略自动在CPU上进行分配。该函数用于设置程序运行时资源分配所占用的CPU个数。
\~english
Set CPU affinity
Data stream handle
Whether to set CPU affinity
Number of CPU cores
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Normally, during program execution, resources are automatically allocated on CPU according to PC policies.
This function is used to set the number of CPUs occupied by resource allocation during program runtime.
\~chinese
向数据流添加缓冲区
数据流句柄
数据缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 每个数据流都会维护独立的缓冲区链表，采集得到的图像数据将会顺序填入缓冲区中。本函数将会添加一个缓冲区到缓冲区链表的尾部。
2. 数据流不会多次添加同一个数据缓冲区。
\~english
Add buffer to data stream
Data stream handle
Data buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. Each data stream will maintain an independent buffer linked list, and the grabbed image data will be sequentially filled into the buffer.
This function will add buffer to the end of the buffer linked list.
2. The data stream will not add the same data buffer multiple times.
\~chinese
获取Stream中的缓冲区。
数据流句柄
需要获取句柄的序号
获取到的缓冲区句柄
- ITKSTATUS_OK
从数据流缓冲区列表中获取指定索引位置的缓冲区句柄。
\~english
Get buffer handle from stream.
Stream handle
The index of buffer in buffer_list of stream
Buffer handle to get
- ITKSTATUS_OK
Get the buffer handle from stream's buffer list with specific index.
\~chinese
向数据流添加批量缓冲区
数据流句柄
数据缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
该函数接口用于光谱共聚焦传感器。用户在添加常规缓冲区后，还需要添加批量缓冲区。批量缓冲区不能注册帧完成回调，
需要注册批量获取回调。在批量获取回调中，用户可以根据当前批量缓冲区序号批量获取常规缓冲区的指针和常规缓冲区状态的指针，
再根据图像的大小和常规缓冲区状态结构体的大小遍历所有批量获取到的图像。
\~english
Add batch buffers to data stream
Data stream handle
Data buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
This function interface is used for spectral confocal sensor. After adding a regular buffer, users also need to add batch buffer.
Batch buffer cannot register frame completion callback, batch retrieval callback need to be registered.
In batch retrieval callback, users can batch retrieve pointers to regular buffers and regular buffer states based on the current batch buffer sequence number,
and then traverse all batch retrieved images based on the size of the image and the size of the regular buffer state structure.
\~chinese
从数据流移除缓冲区
数据流句柄
数据缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 每个数据流都会维护独立的缓冲区链表，采集得到的图像数据将会顺序填入缓冲区中。本函数将会从数据流缓冲区链表中删除一个指定的缓冲区。
2. 为了确保数据采集过程的正常运行，数据流的缓冲区链表中至少要一个可用缓冲区。
\~english
Remove buffer from data stream
Data stream handle
Data buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. Each data stream will maintain an independent buffer linked list, and the grabbed image data will be sequentially filled into the buffer.
This function will delete a specified buffer from the data stream buffer linked list.
2. To ensure the normal operation of the data acquisition process, there must be at least one available buffer in the buffer linked list of the data stream.
\~chinese
从数据流移除批量缓冲区
数据流句柄
数据缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
该函数接口用于光谱共聚焦传感器。
\~english
Remove batch buffer from data stream
Data stream handle
Data buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
This function interface is used for spectral confocal sensor.
\~chinese
从数据流保存批量缓冲区
数据流句柄
批量缓冲区句柄
保存的文件名
保存配置选项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
该函数接口用于光谱共聚焦传感器，保存配置选项描述如下
| 位数 | 描述 |
|---------|----------------------------------------|
| [0:7] | 图像保存为 ITKBUFFER_VAL_PCD 类型 |
| [8:23] | 仅用于设置Jpeg图像质量系数，范围1~100 |
| [24] | 仅用于pcd图像，0表示ASCII，1表示二进制 |
| [25:31] | 预留 |
\~english
Save batch buffer from data stream
Data stream handle
Batch buffer handle
File name
Configuration options
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
This function interface is used for spectral confocal sensor. The description of saving configuration options is as follows:
| Bit | Description |
|---------|------------------------------------------------------------------------|
| [0:7] | Save the image as ITKBUFFER_VAL_PCD type |
| [8:23] | Only used to set Jpeg image quality coefficient, ranging from 1 to 100 |
| [24] | Only used for pcd images, 0 represents ASCII, 1 represents binary |
| [25:31] | Reserved |
\~chinese
清空数据流缓冲区
数据流句柄
数据缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
清除数据流缓冲区的状态，适用于流自动清空机制禁用的情况。
\~english
Clear data stream buffer
Data stream handle
Data buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Clear the state of data stream buffer, suitable for situations where the automatic stream clearing mechanism is disabled.
\~chinese
获取当前缓冲区列表的buffer个数
数据流句柄
当前缓冲区列表buffer个数
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Gets the buffer number of the current bufferList
Data stream handle
Buffer number of the current bufferList
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取当前缓冲区列表的有效buffer个数
数据流句柄
当前缓冲区有效buffer个数
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
缓冲区有效指缓冲区状态为 ITKBUFFER_VAL_STATE_FULL 、 ITKBUFFER_VAL_STATE_OVERFLOW 、 ITKBUFFER_VAL_STATE_UNCOMPLETED
\~english
Gets the valid buffer number of the current bufferList
Data stream handle
Valid buffer number of the current bufferList
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The buffer is valid means that the buffer status is ITKBUFFER_VAL_STATE_FULL , ITKBUFFER_VAL_STATE_OVERFLOW , ITKBUFFER_VAL_STATE_UNCOMPLETED
\~chinese
获取数据流参数
数据流句柄
参数ID
参数值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
可读的数据流参数prm如下所示：
| 可读的数据流参数prm |
|------------------------------------------------------|
| ITKSTREAM_PRM_STATUS |
| ITKSTREAM_PRM_SUPPORT_EVENT_TYPE |
| ITKSTREAM_PRM_START_MODE |
| ITKSTREAM_PRM_TRANSFER_MODE |
| ITKSTREAM_PRM_AUTO_CLEAR |
| ITKSTREAM_PRM_TIME_OUT |
| ITKSTREAM_PRM_FRAME_RATE |
| ITKSTREAM_PRN_GV_PACKET_MAX_RESEND_COUNT |
| ITKSTREAM_PRM_GV_PACKET_RESEND_TIMEOUT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_RESEND_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_WAIT_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_RESEND_WINODW_SIZE |
| ITKSTREAM_PRM_GV_PACKET_INTER_TIMEOUT |
| ITKSTREAM_PRM_GV_PACKET_POLLING_TIME |
| ITKSTREAM_PRM_GV_KERNEL_BUFFER_COUNT |
| ITKSTREAM_PRM_LINE_RATE |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_RATE |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_PATH |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_BUFFER_COUNT |
| ITKSTREAM_PRM_BATCH_SIZE |
| ITKSTREAM_PRM_SELF_ADAPTION |
| ITKSTREAM_PRM_FRAME_FRAME_START_CORRESPOND_FRAME_END |
| ITKSTREAM_PRM_GRAB_STRATEGY |
\~english
Get data stream parameter
Data stream handle
Parameter ID
Parameter value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Readable data stream parameters prm are shown as follows:
| Readable data stream parameters prm |
|------------------------------------------------------|
| ITKSTREAM_PRM_STATUS |
| ITKSTREAM_PRM_SUPPORT_EVENT_TYPE |
| ITKSTREAM_PRM_START_MODE |
| ITKSTREAM_PRM_TRANSFER_MODE |
| ITKSTREAM_PRM_AUTO_CLEAR |
| ITKSTREAM_PRM_TIME_OUT |
| ITKSTREAM_PRM_FRAME_RATE |
| ITKSTREAM_PRN_GV_PACKET_MAX_RESEND_COUNT |
| ITKSTREAM_PRM_GV_PACKET_RESEND_TIMEOUT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_RESEND_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_WAIT_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_RESEND_WINODW_SIZE |
| ITKSTREAM_PRM_GV_PACKET_INTER_TIMEOUT |
| ITKSTREAM_PRM_GV_PACKET_POLLING_TIME |
| ITKSTREAM_PRM_GV_KERNEL_BUFFER_COUNT |
| ITKSTREAM_PRM_LINE_RATE |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_RATE |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_PATH |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_BUFFER_COUNT |
| ITKSTREAM_PRM_BATCH_SIZE |
| ITKSTREAM_PRM_SELF_ADAPTION |
| ITKSTREAM_PRM_FRAME_FRAME_START_CORRESPOND_FRAME_END |
| ITKSTREAM_PRM_GRAB_STRATEGY |
\~chinese
设置数据流参数
数据流句柄
参数ID
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
可写的数据流参数prm如下所示：
| 可写的数据流参数prm |
|------------------------------------------------------|
| ITKSTREAM_PRM_START_MODE |
| ITKSTREAM_PRM_TRANSFER_MODE |
| ITKSTREAM_PRM_AUTO_CLEAR |
| ITKSTREAM_PRM_TIME_OUT |
| ITKSTREAM_PRN_GV_PACKET_MAX_RESEND_COUNT |
| ITKSTREAM_PRM_GV_PACKET_RESEND_TIMEOUT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_RESEND_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_WAIT_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_RESEND_WINODW_SIZE |
| ITKSTREAM_PRM_GV_PACKET_INTER_TIMEOUT |
| ITKSTREAM_PRM_GV_PACKET_POLLING_TIME |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_PATH |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_BUFFER_COUNT |
| ITKSTREAM_PRM_BATCH_SIZE |
| ITKSTREAM_PRM_SELF_ADAPTION |
| ITKSTREAM_PRM_FRAME_FRAME_START_CORRESPOND_FRAME_END |
| ITKSTREAM_PRM_GRAB_STRATEGY |
| ITKSTREAM_PRM_GRAB_THREAD_AFFINITY |
\~english
Set data stream parameter
Data stream handle
Parameter ID
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Writable data stream parameters prm are shown as follows:
| Writable data stream parameters prm |
|------------------------------------------------------|
| ITKSTREAM_PRM_START_MODE |
| ITKSTREAM_PRM_TRANSFER_MODE |
| ITKSTREAM_PRM_AUTO_CLEAR |
| ITKSTREAM_PRM_TIME_OUT |
| ITKSTREAM_PRN_GV_PACKET_MAX_RESEND_COUNT |
| ITKSTREAM_PRM_GV_PACKET_RESEND_TIMEOUT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_RESEND_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_MAX_WAIT_PACKET_COUNT |
| ITKSTREAM_PRM_GV_BLOCK_RESEND_WINODW_SIZE |
| ITKSTREAM_PRM_GV_PACKET_INTER_TIMEOUT |
| ITKSTREAM_PRM_GV_PACKET_POLLING_TIME |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_PATH |
| ITKSTREAM_PRM_BURR_DECTION_IMAGE_SAVE_BUFFER_COUNT |
| ITKSTREAM_PRM_BATCH_SIZE |
| ITKSTREAM_PRM_SELF_ADAPTION |
| ITKSTREAM_PRM_FRAME_FRAME_START_CORRESPOND_FRAME_END |
| ITKSTREAM_PRM_GRAB_STRATEGY |
| ITKSTREAM_PRM_GRAB_THREAD_AFFINITY |
\~chinese
获取当前帧完成回调中指向当前完成帧的缓冲区句柄
数据流句柄
当前完成帧的缓冲区句柄
获取当前帧完成回调中指向当前完成帧的缓冲区句柄, 需要注意该函数只有在帧完成回调中使用时才可以获取到正确的值。
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get buffer that indacate current frame in end-of-frame callback.
Data stream handle
Buffer that indacate current frame
Get buffer that indacate current frame in end-of-frame callback. Use this function to get correct value only in end-of-frame callback.
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
开始数据流采集工作
数据流句柄
采集图像数量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 采集图像数量对应关系如下所示：
| 数值 | 图像帧数 |
|----------------------|----------|
| 0 | 连续采集 |
| ITKSTREAM_CONTINUOUS | 连续采集 |
| 1 | 单帧采集 |
| 2~UINT32_MAX-1 | 多帧采集 |
2. 如果数据流正在进行采集，则本函数不会执行并返回 ITKSTATUS_STREAM_IN_PROCESS 。
3. 如果参数 ITKSTREAM_PRM_START_MODE 被设置为 ITKSTREAM_VAL_START_MODE_NON_BLOCK ，则本函数不等待采集过程结束而直接返回。
4. 如果参数 ITKSTREAM_PRM_START_MODE 被设置为 ITKSTREAM_VAL_START_MODE_BLOCK ，则本函数会等待所有图像数据采集完毕或者采集图像超时才会返回。
5. 每个采集数据流维护独立的缓冲区链表，数据采集流将会顺序写入缓冲区链表中。假设缓冲区链表长度为4，则采集得到的图像将按照如下顺序排列：
* 单帧采集时(count=1)：1→1→1→1→…
* 多帧采集时(count=2)：(1→2)→(1→2)→…
* 多帧采集时(count=6)：(1→2→3→4→1→2)→(1→2→3→4→1→2)→…
* 连续采集时(count= ITKSTREAM_CONTINUOUS )：(1→2→3→4)→(1→2→3→4)→…
\~english
Start data stream acquisition
Data stream handle
Number of grabbed images
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. The corresponding relationship between the number of acquisition images is as follows:
| Value | Image Count |
|----------------------|--------------------------|
| 0 | Continuous acquisition |
| ITKSTREAM_CONTINUOUS | Continuous acquisition |
| 1 | Single frame acquisition |
| 2~UINT32_MAX-1 | Multi frame acquisition |
2. If the data stream is in process of acquisition, this function will not execute and return ITKSTATUS_STREAM_IN_PROCESS .
3. If the parameter ITKSTREAM_PRM_START_MODE is set to ITKSTREAM_VAL_START_MODE_NON_BLOCK ,
this function returns directly without waiting for acquisition process to end.
4. If the parameter ITKSTREAM_PRM_START_MODE is set to ITKSTREAM_VAL_START_MODE_BLOCK ,
this function will wait for all image data to be grabbed or for the grabbed images to timeout before returning.
5. Each acquisition data stream maintains an independent buffer linked list,
and data streams will be sequentially written into buffer linked list. Assuming the length of the buffer linked list is 4,
the grabbed images will be arranged in the following order:
* During single frame acquisition(count=1)：1→1→1→1→…
* During multi frame acquisition(count=2)：(1→2)→(1→2)→…
* During multi frame acquisition(count=6)：(1→2→3→4→1→2)→(1→2→3→4→1→2)→…
* During continuous acquisition(count= ITKSTREAM_CONTINUOUS )：(1→2→3→4)→(1→2→3→4)→…
\~chinese
同步结束数据流采集工作
数据流句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
当本函数执行后，直到当前正在采集的图像采集完毕才会结束采集过程，因此可以保证最后一帧图像的完整性。
\~english
Synchronously stop data stream acquisition
Data stream handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
After the execution of this function, acquisition process will not end until the current image being grabbed is completed, thus ensuring the integrity of the last frame of image.
\~chinese
等待数据流采集结束
数据流句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
当采集单帧或者多帧图像数据时，可以调用该函数等待图像采集操作完成。在连续采集时将直接返回ITKSTATUS_OK。
\~english
Waiting for the end of data stream acquisition
Data stream handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
When grabbing single or multiple frames of image data, this function can be called to wait for the image acquisition operation completion.
In continuous acquisition, it will return ITKSTATUS_OK immediately.
\~chinese
等待一帧图像完成并获取这帧图像的句柄
数据流句柄
图像句柄
超时时间(ms)，如果输入值为小于0，则表示超时时间为无限
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG hBuffer为空
- ITKSTATUS_INVALID_HANDLE hStream句柄无效
- ITKSTATUS_STREAM_PENDING 采集尚未开始
- ITKSTATUS_STREAM_TIMEOUT 采集超时
- ITKSTATUS_STREAM_ABORTED 采集被终止
1. 在获取图像并处理完成后，需要调用 ItkStreamClearBuffer 将缓冲区释放。
2. 当内部缓冲区中已经有已完成的图像时，该接口会立即返回。
3. 默认情况下该接口会优先返回最早到来的图像，直到内部缓冲区没有已经完成的图像。
4. 如果客户处理图像并释放缓冲区速度慢于采图速度，会发生缓冲区溢出现象进而造成丢帧。
\~english
Wait one frame ready and get the handle of it
Data stream handle
Image buffer handle
timeout(ms). If it is less than 0, timeout is infinite
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG hBuffer is NULL
- ITKSTATUS_INVALID_HANDLE hStream is invalid
- ITKSTATUS_STREAM_PENDING grab is not started
- ITKSTATUS_STREAM_TIMEOUT wait one frame timeout
- ITKSTATUS_STREAM_ABORTED wait abort because grab is stop
1. After ItkStreamWaitOneFrameReady and processing image, need use ItkStreamClearBuffer to release buffer.
2. This api return instantly if there are one or more ready frames in internal buffers.
3. This api return the earliest ready frame on default mode.
4. If the image process and the buffer release slower than the acquisition speed, the buffer overflow will cause frame loss.
\~chinese
注册数据流回调函数
数据流句柄
回调事件类型，事件触发后回调函数会被执行。
用户回调函数
用户上下文指针，在回调函数调用时传入
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 如果在回调函数中进行过于费时的操作或事件触发频率过快，可能会导致触发事件丢失。
2. 为相同事件注册多次回调函数，仅保证最近一次注册的回调函数会被调用。
3. 当为 ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE 注册回调函数时，必须指明监听的行数n，
其回调事件类型为 ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE +n。该类型仅适用于线扫描相机。
4. 回调事件类型eventType可选项如下所示。不同型号的相机支持的回调事件类型不同，具体请以实际情况为准：
| 回调事件类型eventType |
|------------------------------------------------|
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_TIME_OUT |
| ITKSTREAM_VAL_EVENT_TYPE_FRAME_LOST |
| ITKSTREAM_VAL_EVENT_TYPE_IMAGE_DATA_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_DEVICE_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_BATCH |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVERED |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVER_FAILED |
\~english
Register data stream callback function
Data stream handle
Callback event type, the callback function will be executed after the event is triggered.
User callback function
User context pointer, passed in when calling callback function
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. If time-consuming operations or event triggering frequency are too fast in callback function, it may result in the loss of triggering events.
2. Register multiple callback functions for the same event, only the most recently registered callback function will be called.
3. When registering a callback function for ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE , it is necessary to specify the number of listening lines n,
and the callback event type is ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE +n. This type is only applicable to line scan camera.
4. The callback event types eventType are as follows. Different camera models support different callback event types. Please refer to the actual situation for details:
| Callback event types eventType |
|------------------------------------------------|
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_TIME_OUT |
| ITKSTREAM_VAL_EVENT_TYPE_FRAME_LOST |
| ITKSTREAM_VAL_EVENT_TYPE_IMAGE_DATA_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_DEVICE_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_BATCH |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVERED |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVER_FAILED |
\~chinese
清空数据流回调函数
数据流句柄
回调事件类型，具体参见 ITKSTREAM_PRM_SUPPORT_EVENT_TYPE
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
回调事件类型eventType可选项如下所示。不同型号的相机支持的回调事件类型不同，具体请以实际情况为准：
| 回调事件类型eventType |
|------------------------------------------------|
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_TIME_OUT |
| ITKSTREAM_VAL_EVENT_TYPE_FRAME_LOST |
| ITKSTREAM_VAL_EVENT_TYPE_IMAGE_DATA_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_DEVICE_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_BATCH |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVERED |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVER_FAILED |
\~english
Clear data stream callback function
Data stream handle
Callback event type, see ITKSTREAM_PRM_SUPPORT_EVENT_TYPE
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The callback event types eventType are as follows. Different camera models support different callback event types. Please refer to the actual situation for details:
| Callback event types eventType |
|------------------------------------------------|
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_TIME_OUT |
| ITKSTREAM_VAL_EVENT_TYPE_FRAME_LOST |
| ITKSTREAM_VAL_EVENT_TYPE_IMAGE_DATA_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_DEVICE_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_BATCH |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVERED |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVER_FAILED |
\~chinese
开始录像
数据流句柄
录像参数结构体
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 图像像素支持通道深度为8位的黑白图像和通道深度为8位的彩色图像。
2. 视频录制功能需链接ffmpeg动态库。
\~english
Start record
Stream handle
Record param structure
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. The image pixelformat data only supports monochrome images with channel depth of 8 bits and color images with channel depth of 8 bits.
2. The video record functions need link ffmpeg dll.
\~chinese
输入一帧录像数据
数据流句柄
数据地址
数据长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
输入图像数据支持通道深度为8位的灰白图像和通道深度为8位的彩色图像。
\~english
Input one frame of RAW data
Stream handle
The Address of data
The Length of data
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The input image data supports gray images with channel depth of 8 bits and color images with channel depth of 8 bits.
\~chinese
结束录像
数据流句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Stop record
Stream handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
新建缓冲区
缓冲区宽度，单位像素
缓冲区高度，单位像素
缓冲区像素格式，参见 ITKBUFFER_FORMAT
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Create new buffer
Buffer width, unit pixel
Buffer height, unit pixel
Buffer pixel format, see ITKBUFFER_FORMAT
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
新建缓冲区，适用于缓冲区不仅包含图像数据，还包含Chunk数据
缓冲区大小
缓冲区宽度，单位像素
缓冲区高度，单位像素
缓冲区像素格式，参见 ITKBUFFER_FORMAT
Chunk数据类型，参见 PAYLOAD_TYPE
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Create new buffer，applicable to buffers that contain Chunk data as well as image data
Buffer size
Buffer width, unit pixel
Buffer height, unit pixel
Buffer pixel format, see ITKBUFFER_FORMAT
Chunk data type, see PAYLOAD_TYPE
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
使用SDK外部内存新建缓冲区
缓冲区宽度，单位像素
缓冲区高度，单位像素
缓冲区像素格式，参见 ITKBUFFER_FORMAT
缓冲区地址，由用户申请
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Create a new buffer using the SDK external memory
Buffer width, unit pixel
Buffer height, unit pixel
Buffer pixel format, see ITKBUFFER_FORMAT
Buffer address, requested by users
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
使用SDK外部内存新建缓冲区,适用于缓冲区不仅包含图像数据，还包含Chunk数据
缓冲区大小
缓冲区宽度，单位像素
缓冲区高度，单位像素
缓冲区像素格式，参见 ITKBUFFER_FORMAT
Chunk数据类型，参见 PAYLOAD_TYPE
缓冲区地址，由用户申请
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Create a new buffer using the SDK external memory, applicable to buffers that contain Chunk data as well as image data
Buffer size
Buffer width, unit pixel
Buffer height, unit pixel
Buffer pixel format, see ITKBUFFER_FORMAT
Chunk data type, see PAYLOAD_TYPE
Buffer address, requested by users
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
判断缓冲区内存是否为用户创建
缓冲区句柄
标记内存是否为用户创建
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Determine whether the buffer memory is created by the user
Buffer handle
Mark whether the memory is created by the user
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
销毁缓冲区
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Destroy buffer
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取缓冲区信息
缓冲区句柄
缓冲区描述信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get buffer info
Buffer handle
Info of buffer
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
获取缓冲区PART信息, 仅在缓冲区负载为 MULTI_PART_PAYLOAD_TYPE 时使用
缓冲区句柄
缓冲区part序号, 应小于缓冲区的PartNumber.
缓冲区Part描述信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Get buffer part info, only used when the buffer payload type is MULTI_PART_PAYLOAD_TYPE.
Buffer handle
Buffer part index
Part info of buffer
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
设置缓冲区地址
缓冲区句柄
指向待设置的缓冲区的地址
待设置的缓冲区大小
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Set buffer address
Buffer handle
Pointer to buffer memory to set
Size of the buffer in bytes
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
从缓冲区中读取数据
缓冲区句柄
缓冲区偏移量，单位字节
用户缓冲区
作为输入指明用户缓冲区最大长度，作为输出指明用户缓冲区有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
缓冲区偏移量和用户缓冲区大小之和不能超过数据缓冲区的大小。
\~english
Read data from buffer
Buffer handle
Buffer offset in bytes
User buffer
As input, it indicates the maximum length of user buffer. As output, it indicates the effective length of user buffer
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
The sum of buffer offset and user buffer size cannot exceed the size of data buffer.
\~chinese
读取缓冲区中的一个像素值
缓冲区句柄
像素水平位置
像素垂直位置
像素值
读取数据的大小，单位字节
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~english
Read single pixel value from buffer
Buffer handle
Pixel horizontal position
Pixel vertical position
Pixel value
Read the size of data in bytes
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~chinese
读取缓冲区中直线上的像素值
缓冲区句柄
缓冲区起点的水平位置
缓冲区起点的垂直位置
缓冲区终点的水平位置
缓冲区终点的垂直位置
读取像素的个数
数组的大小，单位字节
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
使用Bresenham算法确定(startX, startY)和（endX, endY）两点间的理论直线。
\~english
Read pixel values of a line in buffer
Buffer handle
The horizontal position of the starting point of buffer
The vertical position of the starting point of buffer
The horizontal position of the end point of buffer
The vertical position of the end point of buffer
The number of read pixels
The size of array, unit bytes
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
Use the Bresenham algorithm to determine the theoretical straight line between two points (startX, startY) and (endX, endY).
\~chinese
读取缓冲区中矩形区域的像素值
缓冲区句柄
缓冲区的水平起始位置
缓冲区的垂直起始位置
缓冲区矩形区域的宽度
缓冲区矩形区域的高度
存放读取数据的数组
数组的大小，单位字节
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~english
Read pixel values of the rectangular area in buffer
Buffer handle
Horizontal offset of the rectangular area of buffer
Vertical offset of the rectangular area of buffer
Width of the rectangular area of buffer
Height of the rectangular area of buffer
An array for storing read data
The size of array, unit bytes
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~chinese
向缓冲区写入数据
缓冲区句柄
数据缓冲区的偏移量，单位字节
用户缓冲区的大小，单位字节
作为输入指明用户缓冲区最大长度，作为输出指明用户缓冲区有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
缓冲区偏移量和用户缓冲区大小之和不能超过数据缓冲区的大小。
\~english
Write data to buffer
Buffer handle
Offset of data buffer, in bytes
The size of user buffer, in bytes
As input, it indicates the maximum length of user buffer. As output, it indicates the effective length of user buffer
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
The sum of buffer offset and user buffer size cannot exceed the size of data buffer.
\~chinese
向缓冲区写入单个像素数据
缓冲区句柄
像素的水平位置
像素的垂直位置
像素值
数据大小，单位字节
-ITKSTATUS_OK
-ITKSTATUS_INVALD_ARG
-ITKSTATUS_IVNALID_HANDLE
-ITKSTATUS_ARG_OUT_OF_RANGE
\~english
Write single pixel data to buffer
Buffer handle
Pixel horizontal position
Pixel vertical position
Pixel value
The size of data in bytes
-ITKSTATUS_OK
-ITKSTATUS_INVALD_ARG
-ITKSTATUS_IVNALID_HANDLE
-ITKSTATUS_ARG_OUT_OF_RANGE
\~chinese
向缓冲区写入一行像素数据
缓冲区句柄
缓冲区起点的水平位置
缓冲区起点的垂直位置
缓冲区终点的水平位置
缓冲区终点的垂直位置
写入像素的个数
写入像素数组的大小，单位字节
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
使用Bresenham算法确定(startX, startY)和（endX, endY）两点间的理论直线。
\~english
Write a line of pixel data to the buffer
Buffer handle
The horizontal position of the starting point of buffer
The vertical position of the starting point of buffer
The horizontal position of the end point of buffer
The vertical position of the end point of buffer
Number of written pixels
The size of written pixel array in bytes
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
Use the Bresenham algorithm to determine the theoretical straight line between two points (startX, startY) and (endX, endY).
\~chinese
向缓冲区的矩形区域写入数据
缓冲区句柄
缓冲区的水平起始位置
缓冲区的垂直起始位置
缓冲区矩形区域的宽度
缓冲区矩形区域的高度
包含写入像素值的数组
写入的数据的大小，单位字节
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~english
Write data to rectangular area of buffer
Buffer handle
Horizontal offset of the rectangular area of buffer
Vertical offset of the rectangular area of buffer
Width of the rectangular area of buffer
Height of the rectangular area of buffer
An array containing written pixel values
The size of the written data, in bytes
- ITKSTATUS_OK
- ITKSTATUS_INVALD_ARG
- ITKSTATUS_IVNALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~chinese
将Bayer图像转换成彩色图像
Bayer编码的源图像
转换后的彩色图像
Bayer图像的编码方式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 在Bayer格式的图像中，每个像素的灰度值都对应了彩色图像的某个像素通道值，通过最邻近差值方法可以从Bayer图像中重构出彩色图像。
2. 源图像和转换后的图像必须具有相同的宽度、高度和通道深度，否则无法进行Bayer转换。
3. Bayer编码的源图像数据格式必须是以下取值之一：
| 源图像数据格式 |
|---------------------------------|
| ITKBUFFER_VAL_FORMAT_MONO8 |
| ITKBUFFER_VAL_FORMAT_MONO10 |
| …… |
| ITKBUFFER_VAL_FORMAT_BAYER_RG8 |
| ITKBUFFER_VAL_FORMAT_BAYER_RG10 |
| …… |
4. 转换后的彩色图像数据格式必须是以下取值之一：
| 转换图像数据格式 |
|--------------------------------|
| ITKBUFFER_VAL_FORMAT_RGB888 |
| ITKBUFFER_VAL_FORMAT_RGB101010 |
| ITKBUFFER_VAL_FORMAT_RGB121212 |
| ITKBUFFER_VAL_FORMAT_RGB141414 |
| ITKBUFFER_VAL_FORMAT_RGB161616 |
| ITKBUFFER_VAL_FORMAT_BGR888 |
| ITKBUFFER_VAL_FORMAT_BGR101010 |
| ITKBUFFER_VAL_FORMAT_BGR121212 |
| ITKBUFFER_VAL_FORMAT_BGR141414 |
| ITKBUFFER_VAL_FORMAT_BGR161616 |
5. Bayer图像的编码方式必须是以下取值之一：
| Bayer图像编码方式 |
|---------------------------|
| ITKBUFFER_VAL_BAYER_BGGR |
| ITKBUFFER_VAL_BAYER_RGGB |
| ITKBUFFER_VAL_BAYER_GBRG |
| ITKBUFFER_VAL_BAYER_GRBG |
6. Bayer图像的转换方法必须是以下取值之一：
| Bayer图像转换方法 |
|-------------------------------------|
| ITKBUFFER_VAL_BAYER_METHOD_DEFAULT |
| ITKBUFFER_VAL_BAYER_METHOD_BILINEAR |
| ITKBUFFER_VAL_BAYER_METHOD_VNG |
| ITKBUFFER_VAL_BAYER_METHOD_ITEK_V4 |
| ITKBUFFER_VAL_BAYER_METHOD_ITEK_OLD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD2 |
7. 编码方式和转换方法通过或(|)连接传入options. 注意当使用16bit的图像时, 只能使用 ITKBUFFER_VAL_BAYER_METHOD_BILINEAR 方法。
\~english
Convert Bayer image to color image
Bayer encoded source image
Converted color image
The encoding method of Bayer image
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. In Bayer format images, the grayscale value of each pixel corresponds to a certain pixel channel value of the color image,
and the color image can be reconstructed from the Bayer image using the nearest neighbor difference method.
2. The source image and the converted image must have the same width, height, and channel depth, otherwise Bayer conversion cannot be performed.
3. The source image data format encoded by Bayer must take one of the following values:
| Source image data format |
|---------------------------------|
| ITKBUFFER_VAL_FORMAT_MONO8 |
| ITKBUFFER_VAL_FORMAT_MONO10 |
| …… |
| ITKBUFFER_VAL_FORMAT_BAYER_RG8 |
| ITKBUFFER_VAL_FORMAT_BAYER_RG10 |
| …… |
4. The converted color image data format must be one of the following values:
| Converted image data format |
|--------------------------------|
| ITKBUFFER_VAL_FORMAT_RGB888 |
| ITKBUFFER_VAL_FORMAT_RGB101010 |
| ITKBUFFER_VAL_FORMAT_RGB121212 |
| ITKBUFFER_VAL_FORMAT_RGB141414 |
| ITKBUFFER_VAL_FORMAT_RGB161616 |
| ITKBUFFER_VAL_FORMAT_BGR888 |
| ITKBUFFER_VAL_FORMAT_BGR101010 |
| ITKBUFFER_VAL_FORMAT_BGR121212 |
| ITKBUFFER_VAL_FORMAT_BGR141414 |
| ITKBUFFER_VAL_FORMAT_BGR161616 |
5. The encoding method of Bayer image must be one of the following values:
| Bayer image encoding method |
|-----------------------------|
| ITKBUFFER_VAL_BAYER_BGGR |
| ITKBUFFER_VAL_BAYER_RGGB |
| ITKBUFFER_VAL_BAYER_GBRG |
| ITKBUFFER_VAL_BAYER_GRBG |
6. The bayer convert method of Bayer image must be one of the following values:
| Bayer image convert method |
|-------------------------------------|
| ITKBUFFER_VAL_BAYER_METHOD_DEFAULT |
| ITKBUFFER_VAL_BAYER_METHOD_BILINEAR |
| ITKBUFFER_VAL_BAYER_METHOD_VNG |
| ITKBUFFER_VAL_BAYER_METHOD_ITEK_V4 |
| ITKBUFFER_VAL_BAYER_METHOD_ITEK_OLD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD2 |
7. Encoding methods and conversion methods passed to the incoming options through or(|) connection.
Note that when working with 16-bit images, only the ITKBUFFER_VAL_BAYER_METHOD_BILINEAR method can be used.
\~chinese
RGB通道重排列
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
ITKBUFFER_VAL_RGB_SPLIT_INTO_BLOCK 选项对应的重排如下
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~english
RGB channel rearrangement
: Source buffer handle, pixel format must be in color format
: Destination buffer handle. The height of the destination buffer image must be three times that of the source buffer image,
and the pixel format size must be one-third that of the source buffer
: option to rearrange:{ITKBUFFER_VAL_RGB_SPLIT_INTO_ROW,ITKBUFFER_VAL_RGB_SPLIT_INTO_BLOCK}
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Pixel after rearrangement with ITKBUFFER_VAL_RGB_SPLIT_INTO_BLOCK
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~chinese
3D像素通道重排列
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
ITKBUFFER_VAL_3D_SPLIT_INTO_BLOCK 选项,对应的重排如下
```
A1A2A3
A4A5A6
A7A8A9
(A1C1R1)(A2C2R2)(A3C3R3) C1C2C3
(A4C4R4)(A5C5R5)(A6C6R6) -> C4C5C6
(A7C7R7)(A8C8R8)(A9C9R9) C7C8C9
R1R2R3
R4R5R6
R7R8R9
```
ITKBUFFER_VAL_3D_SPLIT_INTO_BLOCK_AND_STRATIFIED 选项,对应的重排如下
```
batchCount:2:
A11A12A13
A14A15A16
A21A22A23
(A11C11R11)(A12C12R12)(A13C13R13) A24A25A26
(A21C21R11)(A22C22R22)(A23C23R23) -> C11C12C13
(A14C14R14)(A15C15R15)(A16C16R16) C14C15C16
(A24C24R24)(A25C25R25)(A26C26R26) C21C22C23
C24C25C26
R11R12R13
R14R15R16
R21R22R23
R24R25R26
```
\~english
3D channel rearrangement
: Source buffer handle, pixel format must be in 3D format
: Destination buffer handle. For C16、AC16 and ACR16 the target buffer image height must be N times the source buffer image height, the output pixel size must be the single channel size of the input, and N is the number of channels in the source buffer. For C32 and AC32 the target buffer image height must be same as the source buffer image height, the output pixel size must be (the pixel channel count of the input multiple 16bit) plus 8 bit
: option to rearrange
: batchCount is indicated when option1 is ITKBUFFER_VAL_3D_SPLIT_INTO_BLOCK_AND_STRATIFIED, otherwise which is not enabled
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
Pixel after rearrangement with ITKBUFFER_VAL_3D_SPLIT_INTO_BLOCK:
```
A1A2A3
A4A5A6
A7A8A9
(A1C1R1)(A2C2R2)(A3C3R3) C1C2C3
(A4C4R4)(A5C5R5)(A6C6R6) -> C4C5C6
(A7C7R7)(A8C8R8)(A9C9R9) C7C8C9
R1R2R3
R4R5R6
R7R8R9
```
Pixel after rearrangement with ITKBUFFER_VAL_3D_SPLIT_INTO_BLOCK_AND_STRATIFIED:
```
batchCount:2:
A11A12A13
A14A15A16
A21A22A23
(A11C11R11)(A12C12R12)(A13C13R13) A24A25A26
(A21C21R11)(A22C22R22)(A23C23R23) -> C11C12C13
(A14C14R14)(A15C15R15)(A16C16R16) C14C15C16
(A24C24R24)(A25C25R25)(A26C26R26) C21C22C23
C24C25C26
R11R12R13
R14R15R16
R21R22R23
R24R25R26
```
\~chinese
图像缩放
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 缓冲区数据格式仅支持非packed的Mono和RGB/BGR。
2. 缩放方法可选项如下所示：
| 缩放方法 |
|------------------------------|
| ITKBUFFER_VAL_RESIZE_NEAREST |
| ITKBUFFER_VAL_RESIZE_LINEAR |
| ITKBUFFER_VAL_RESIZE_CUBIC |
| ITKBUFFER_VAL_RESIZE_AREA |
\~english
resize image
: Source buffer handle
: Destination buffer handle. All the target image parameters should be consistent except that
the width and height are inconsistent with the original image
: option to resize
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. Buffer data format only supports non-packed Mono and RGB/BGR.
2. Resize methods can be selected as follows:
| Resize method |
|------------------------------|
| ITKBUFFER_VAL_RESIZE_NEAREST |
| ITKBUFFER_VAL_RESIZE_LINEAR |
| ITKBUFFER_VAL_RESIZE_CUBIC |
| ITKBUFFER_VAL_RESIZE_AREA |
\~chinese
将3D图像转换成pcd图像
数据流句柄
源图像数据格式
转换后的图像数据格式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. 源图像数据格式必须是以下取值之一：
| 源图像数据格式 |
|-----------------------------------------------|
| ITKBUFFER_VAL_FORMAT_COORD3D_C16 |
| ITKBUFFER_VAL_FORMAT_COORD3D_AC16 |
| ITKBUFFER_VAL_FORMAT_COORD3D_ACR16 |
| ITKBUFFER_VAL_FORMAT_CALIBRATED_COORD3D_AC32 |
| ITKBUFFER_VAL_FORMAT_CALIBRATED_COORD3D_C32 |
2. 转换后的图像数据格式必须是以下取值之一：
| 转换图像数据格式 |
|--------------------------|
| ITKBUFFER_VAL_FORMAT_PCD |
\~english
Convert 3D images to pcd images
Data stream handle
Source image data format
Converted image data format
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
1. The format of the source image data must be one of the following values:
| Source image data format |
|----------------------------------------------|
| ITKBUFFER_VAL_FORMAT_COORD3D_C16 |
| ITKBUFFER_VAL_FORMAT_COORD3D_AC16 |
| ITKBUFFER_VAL_FORMAT_COORD3D_ACR16 |
| ITKBUFFER_VAL_FORMAT_CALIBRATED_COORD3D_AC32 |
| ITKBUFFER_VAL_FORMAT_CALIBRATED_COORD3D_C32 |
2. The converted image data format must be one of the following values:
| Convert image data format |
|---------------------------|
| ITKBUFFER_VAL_FORMAT_PCD |
\~chinese
清除缓冲区中的数据
缓冲区句柄
缓冲区中像素的设定值
单个缓冲区元素的数据位
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~english
Clear data from buffer
Buffer handle
The set value of pixels in buffer
The data bits of a single buffer element
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
\~chinese
将缓冲区中所有像素设为黑色
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Set all pixels in the buffer to black
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
拷贝源缓冲区中的数据到目的缓冲区中
源缓冲区句柄
目的缓冲区水平位置
目的缓冲区垂直位置
目的缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
1. 若源缓冲区大于目的缓冲区，则只有在目的缓冲区有效范围内的数据才被拷贝。
2. 若源缓冲区为三通道图像数据，目的缓冲区为单通道图像数据，则拷贝第一个通道的数据到目的缓冲区中，例如RGB图像拷贝R通道数值。
3. 若源缓冲区为单通道图像数据，目的缓冲区为三通道图像数据，则将数据拷贝到第一个通道中。
4. 若源缓冲区图像数据深度大于目的缓冲区，图像的高位信息将会丢失。
\~english
Copy data from the source buffer to the destination buffer
Source buffer handle
Horizontal position of the destination buffer
Vertical position of the destination buffer
Destination buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
1. If the source buffer is larger than the destination buffer, only data within the valid range of the destination buffer will be copied.
2. If the source buffer is three channel image data and the destination buffer is single channel image data,
then copy the data of the first channel to the destination buffer, such as copying the R channel values for RGB images.
3. If the source buffer is single channel image data and the destination buffer is three channel image data, then copy the data to the first channel.
4. If the depth of the source buffer image data is greater than that of the destination buffer, the high-order information of the image will be lost.
\~chinese
拷贝源缓冲区矩形区域的数据到目的缓冲区中
源缓冲区句柄
源缓冲区矩形区域水平起始位置
源缓冲区矩形区域垂直起始位置
源缓冲区矩形区域的宽度
源缓冲区矩形区域的高度
目的缓冲区句柄
目的缓冲区水平起始位置
目的缓冲区垂直起始位置
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~english
Copy the data from the rectangular area of the source buffer to the destination buffer
Source buffer handle
Horizontal starting position of rectangular area in the source buffer
Vertical starting position of rectangular area in the source buffer
Width of the rectangular area of the source buffer
Height of the rectangular area of the source buffer
Destination buffer handle
Horizontal starting position of rectangular area in the destination buffer
Vertical starting position of rectangular area in the destination buffer
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_ARG_OUT_OF_RANGE
\~chinese
缓冲区图像原地顺时针旋转
源缓冲区句柄
旋转角度，可设置为90°、180°或270°
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. 若degree是90或270，图像的宽高属性会调换，再次使用该buffer时请注意这一点。
2. 缓冲区数据格式仅支持非packed的Mono和RGB/BGR。
\~english
Buffer image rotate clockwise in situ
Source buffer handle
Rotation angle, can be set to 90°, 180° or 270°
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. If the degree is 90 or 270, the width and height of the image are change, so note when using the buffer again.
2. Buffer data format only supports non-packed Mono and RGB/BGR.
\~chinese
缓冲区图像翻转
源缓冲区句柄
目的缓冲区句柄
翻转方式标识，0表示沿X轴翻转，正值（例如1）表示沿Y轴翻转，负值（例如-1）表示沿X、Y轴翻转
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. 支持原地翻转。
2. 缓冲区数据格式仅支持非packed的Mono和RGB/BGR。
\~english
Buffer image flip
Source buffer handle
Destination buffer handle
a flag to specify how to flip the buffer; 0 means flipping around the x-axis and positive value (for example, 1) means
flipping around y-axis. Negative value (for example, -1) means flipping around both axes
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. hDst can be same with hSrc.
2. Buffer data format only supports non-packed Mono and RGB/BGR.
\~chinese
将缓冲区中的数据保存到文件
缓冲区句柄
保存的文件名
保存的图像格式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
保存的图像格式可选项如下所示：
| 保存的图像格式 |
|--------------------|
| ITKBUFFER_VAL_BMP |
| ITKBUFFER_VAL_TIFF |
| ITKBUFFER_VAL_RAW |
| ITKBUFFER_VAL_JPEG |
| ITKBUFFER_VAL_PNG |
| ITKBUFFER_VAL_PCD |
\~english
Save the data in the buffer to a file
Buffer handle
Saved file name
Saved image format
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
The image formats available for saving are optional as follows:
| Image formats available for saving |
|------------------------------------|
| ITKBUFFER_VAL_BMP |
| ITKBUFFER_VAL_TIFF |
| ITKBUFFER_VAL_RAW |
| ITKBUFFER_VAL_JPEG |
| ITKBUFFER_VAL_PNG |
| ITKBUFFER_VAL_PCD |
\~chinese
从文件中载入数据到缓冲区
缓冲区句柄
载入的文件名
载入的图像格式
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. 缓冲区的数据位数和文件的数据位数必须一致。
2. 加载的图像格式可选项如下所示：
| 加载的图像格式 |
|--------------------|
| ITKBUFFER_VAL_BMP |
| ITKBUFFER_VAL_TIFF |
| ITKBUFFER_VAL_RAW |
| ITKBUFFER_VAL_JPEG |
| ITKBUFFER_VAL_PNG |
| ITKBUFFER_VAL_PCD |
\~english
Load data from a file to buffer
Buffer handle
Loaded file name
Loaded image format
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. The number of data bits in the buffer must be consistent with the number of data bits in the file.
2. The image formats available for loading are optional as follows:
| Image formats available for loading |
|-------------------------------------|
| ITKBUFFER_VAL_BMP |
| ITKBUFFER_VAL_TIFF |
| ITKBUFFER_VAL_RAW |
| ITKBUFFER_VAL_JPEG |
| ITKBUFFER_VAL_PNG |
| ITKBUFFER_VAL_PCD |
\~chinese
缓冲区图像格式转换
源缓冲区句柄
目的缓冲区句柄
目的缓冲区图像格式
转换选项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. 转换后的目的缓冲区大小需要符合实际情况。
2. 转换方法可选项如下所示：
| 转换方法 |
|------------------------------------------|
| ITKBUFFER_VAL_CONVERT_OPTION_SHRINK |
| ITKBUFFER_VAL_CONVERT_OPTION_STRETCH |
| ITKBUFFER_VAL_CONVERT_OPTION_AUTO_FORMAT |
| ITKBUFFER_VAL_CONVERT_OPTION_PLANNAR |
\~english
Buffer image format conversion
Source buffer handle
Destination buffer handle
Destination buffer image format
Convert option
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
1. The size of the destination buffer after conversion needs to match the actual situation.
2. The conversion methods are optional as shown below:
| Conversion method |
|------------------------------------------|
| ITKBUFFER_VAL_CONVERT_OPTION_SHRINK |
| ITKBUFFER_VAL_CONVERT_OPTION_STRETCH |
| ITKBUFFER_VAL_CONVERT_OPTION_AUTO_FORMAT |
| ITKBUFFER_VAL_CONVERT_OPTION_PLANNAR |
\~chinese
指示buffer的当前格式是否需要使用自动转换
源缓冲区句柄
返回buf的格式是否需要使用自动转换
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
如果buffer的格式是可以通过 ITKBUFFER_VAL_CONVERT_OPTION_AUTO_FORMAT 自动转换的, 则会返回true。
\~english
Indicate buffer format if need auto convert
Source buffer handle
Indicate buffer format if need auto convert
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
If buffer can be converted by ITKBUFFER_VAL_CONVERT_OPTION_AUTO_FORMAT, return true.
\~chinese
获取64位整数类型区块数据特征的值
缓冲区句柄
相机特征名称
64位整数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of chunk data feature of 64bit integer type
Buffer handle
Camera feature name
Value of 64bit integer type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取布尔类型区块数据特征的值
缓冲区句柄
相机特征名称
布尔类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of chunk data feature of boolean type
Buffer handle
Camera feature name
Value of boolean type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取浮点数类型区块数据特征的值
缓冲区句柄
相机特征名称
浮点数类型相机特征值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of chunk data feature of double type
Buffer handle
Camera feature name
Value of double type
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
获取字符串或枚举类型区块数据特征的值
缓冲区句柄
相机特征名称
字符串或枚举类型相机特征值
作为输入指明特征值的最大长度，作为输出指明特征值的有效长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~english
Get the value of chunk data feature of string or enumeration type
Buffer handle
Camera feature name
String or enumeration type camera feature value
As input, it indicates the maximum length of feature value. As output, it indicates the effective length of feature value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_ARG
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_NOT_IMPLEMENT
- ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
\~chinese
自适应高斯降噪算法
高斯sigma值,推荐范围 0~10；
平坦阈值 范围[0,INT_MAX) 推荐15~25
预留选项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
缓冲区数据格式仅支持Mono8、Mono10、Mono12和Bayer8、Bayer10、Bayer12。
\~english
Adaptive Gaussian filtering
Gaussian sigma value
Flat area threshold [0,INT_MAX),15~25 is recommended when hSrc is 8 bit image
Leave a reservation
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
Buffer data format only supports Mono8、Mono10、Mono12,and Bayer8、Bayer10、Bayer12.
\~chinese
图像降噪算法
源缓冲区句柄
目的缓冲区句柄，可与源缓冲区句柄相同
阈值1~64
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
缓冲区数据格式仅支持非packed的Mono和RGB/BGR。
\~english
Denoise a image by GIMP algothrim
Source buffer to denoise
Destination buffer, dst could be the same as src
a valid threshold from 1 to 64
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
Buffer data format only supports non-packed Mono and RGB/BGR.
\~chinese
图像双阈值中值滤波算法
窗口大小，取值：{3,5}，视情况而定
阈值（低）[0,INT_MAX - 8)，视情况而定，一般推荐10~35
源图像为Bayer图像时为真
预留选项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
缓冲区数据格式仅支持Mono8、Mono10、Mono12;Bayer8、Bayer10、Bayer12。
\~english
double threshold median blur
Window size，must be 3 or 5
A low threshold , value threshold [0,INT_MAX - 8),10~35 is recommended when hSrc is 8bit image
It is true when the source image is a Bayer image
Leave a reservation
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
Buffer data format only supports Mono8、Mono10、Mono12,and Bayer8、Bayer10、Bayer12.
\~chinese
缓冲区锐化
源缓冲区句柄
目的缓冲区句柄
锐化系数，参数范围0~100
预留选项
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
缓冲区数据格式仅支持非packed的Mono和RGB/BGR。
\~english
Buffer sharpening
Source buffer handle
Destination buffer handle
Sharpening coefficient, parameter range 0~100
Reserved
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
Buffer data format only supports non-packed Mono and RGB/BGR.
\~chinese
合成像素位移图像
输入的像素位移图像数组
像素位移图像数量, 必须是4、9或16
输出的高分辨率图像
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
将4/9/16个像素位移图像合成一张更高分辨率的图像, 输入图像的格式必须是Mono或者BayerRG。支持细节如下：
1. 输入4张像素位移图像情况下，输入格式支持Mono、BayerRG格式。
如果输入格式为Mono，输出格式为Mono，输出宽、高分别为输入的两倍。
如果输入格式为BayerRG，输出格式为BGR，输出宽、高和输入同样。
2. 输入9张像素位移图像情况下，输入格式只支持Mono格式，输出宽、高分别为输入的三倍。
3. 输入16张像素位移图像情况下，输入格式只支持BayerRG格式，输出格式为BGR，输出宽、高分别为输入的两倍。
4. 在生成BGR图像的情况下, 图像的第一行和第一列由于原始图像没有对应数据, 所以是缺失的, 为正常现象.
\~english
Combine pixel shift images to a higer resolution image
pixel shift images array
pixel shift images array, it must be 4，9 or 16
the image combined by input images
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALID_ARG
Combine four pixel-shifted images from 4/9/16 to create a higher resolution image. The input image format must be Mono or BayerRG. Details supported are as follows:
1. When inputting four pixel-shifted images, the input format supports Mono and BayerRG formats.
If the input format is Mono, the output format is also Mono, with the output width and height being twice that of the input.
If the input format is BayerRG, the output format is BGR, with the same width and height as the input.
2. When inputting nine pixel-shifted images, the input format only supports Mono, with the output width and height being three times that of the input.
3. When inputting sixteen pixel-shifted images, the input format only supports BayerRG, with the output format being BGR, and the output width and height being twice that of the input.
4. When generating a BGR image, the first row and the first column are missing due to the lack of corresponding data in the original image, which is normal and not a problem.
\~chinese
新建视图窗口
缓冲区句柄
父窗口句柄
视图窗口句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
hParentWnd指向父窗口句柄，当父窗口句柄不为空时，新建窗口共享父窗口消息循环队列；当父窗口句柄为空时，新建窗口会新建消息循环队列。
\~english
Create view window
Buffer handle
Parent window handle
View window handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
hParentWnd points to the handle of the parent window. When the handle of the parent window is not empty,
a new window shares the message loop queue of the parent window. When the handle of the parent window is empty, creating a new window will create a new message loop queue.
\~chinese
释放视图窗口
视图窗口句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
当用户点击关闭按钮关闭视图窗口后，仍然需要调用本函数释放在建立图像窗口中申请的资源。
\~english
Release view window
View window handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
When users click the close button to close the view window, calling this function to release the resources requested in the image window creation.
\~chinese
视图窗口添加缓冲区
视图窗口句柄
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
1. 添加的缓冲区宽高和图像格式必须和视图窗口宽高和图像格式保持一致。
2. 每个视图窗口中都会维护独立的缓冲区链表，每次调用 ItkViewShow 或 ItkViewShowNext 时，视图窗口都会从缓冲区链表取出一个或者多个缓冲区进行显示。
3. 视图窗口不会多次添加同一个数据缓冲区。
\~english
Add buffer to view window
View window handle
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
1. The width, height, and image format of the added buffer must be consistent with the width, height, and image format of the view window.
2. Each view window maintains an independent buffer list, and each time ItkViewShow or ItkViewShowNext is called,
the view window retrieves one or more buffers from the buffer list for display.
3. The view window will not add the same data buffer multiple times.
\~chinese
视图窗口移除缓冲区
视图窗口句柄
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
视图窗口应该至少保留一个缓冲区，否则无法显示任何图像数据。
\~english
Remove buffer from view window
View window handle
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
The view window should reserve at least one buffer, otherwise no image data can be displayed.
\~chinese
视图窗口移除所有缓冲区
视图窗口句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
视图窗口应该至少保留一个缓冲区，否则无法显示任何图像数据。
\~english
Remove all buffers from view window
View window handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
The view window should reserve at least one buffer, otherwise no image data can be displayed.
\~chinese
设置视图窗口参数
视图窗口句柄
参数ID
参数值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
可写的视图窗口参数prm如下所示：
| 可写的视图窗口参数prm |
|-------------------------------|
| ITKVIEW_PRM_FILP_X |
| ITKVIEW_PRM_FILP_Y |
| ITKVIEW_PRM_LSB |
| ITKVIEW_PRM_MSB |
| ITKVIEW_PRM_BUFFER_ROI_HEIGHT |
| ITKVIEW_PRM_BUFFER_ROI_WIDTH |
| ITKVIEW_PRM_BUFFER_ROI_LEFT |
| ITKVIEW_PRM_BUFFER_ROI_TOP |
| ITKVIEW_PRM_ZOOM_METHOD |
| ITKVIEW_PRM_HWND_TITLE |
| ITKVIEW_PRM_BAYER_MODE |
\~english
Set view window parameter
View window handle
Parameter ID
Parameter value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
Writable view window parameters prm are as follows:
| Writable view window parameters prm |
|-------------------------------------|
| ITKVIEW_PRM_FILP_X |
| ITKVIEW_PRM_FILP_Y |
| ITKVIEW_PRM_LSB |
| ITKVIEW_PRM_MSB |
| ITKVIEW_PRM_BUFFER_ROI_HEIGHT |
| ITKVIEW_PRM_BUFFER_ROI_WIDTH |
| ITKVIEW_PRM_BUFFER_ROI_LEFT |
| ITKVIEW_PRM_BUFFER_ROI_TOP |
| ITKVIEW_PRM_ZOOM_METHOD |
| ITKVIEW_PRM_HWND_TITLE |
| ITKVIEW_PRM_BAYER_MODE |
\~chinese
获取视图窗口参数
视图窗口句柄
参数ID
参数值
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
可读的视图窗口参数prm如下所示：
| 可读的视图窗口参数prm |
|----------------------------------|
| ITKVIEW_PRM_FILP_X |
| ITKVIEW_PRM_FILP_Y |
| ITKVIEW_PRM_LSB |
| ITKVIEW_PRM_MSB |
| ITKVIEW_PRM_BUFFER_ROI_HEIGHT |
| ITKVIEW_PRM_BUFFER_ROI_WIDTH |
| ITKVIEW_PRM_BUFFER_ROI_LEFT |
| ITKVIEW_PRM_BUFFER_ROI_TOP |
| ITKVIEW_PRM_ZOOM_METHOD |
| ITKVIEW_PRM_ZOOM_MAX_RATIO |
| ITKVIEW_PRM_ZOOM_MIN_RATIO |
| ITKVIEW_PRM_HWND |
| ITKVIEW_PRM_HWND_TITLE |
| ITKVIEW_PRM_BAYER_MODE |
| ITKVIEW_PRM_BUFFER_CURRENT_INDEX |
\~english
Get view window parameter
View window handle
Parameter ID
Parameter value
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
Readable view window parameters prm are as follows:
| Readable view window parameters prm |
|-------------------------------------|
| ITKVIEW_PRM_FILP_X |
| ITKVIEW_PRM_FILP_Y |
| ITKVIEW_PRM_LSB |
| ITKVIEW_PRM_MSB |
| ITKVIEW_PRM_BUFFER_ROI_HEIGHT |
| ITKVIEW_PRM_BUFFER_ROI_WIDTH |
| ITKVIEW_PRM_BUFFER_ROI_LEFT |
| ITKVIEW_PRM_BUFFER_ROI_TOP |
| ITKVIEW_PRM_ZOOM_METHOD |
| ITKVIEW_PRM_ZOOM_MAX_RATIO |
| ITKVIEW_PRM_ZOOM_MIN_RATIO |
| ITKVIEW_PRM_HWND |
| ITKVIEW_PRM_HWND_TITLE |
| ITKVIEW_PRM_BAYER_MODE |
| ITKVIEW_PRM_BUFFER_CURRENT_INDEX |
\~chinese
隐藏视图窗口
视图窗口句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Hide view window
View window handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
显示所有采集完毕的缓冲区数据
视图窗口句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
1. 本函数在不影响图像数据传输的情况下显示尽可能多的图像数据，如果显示图像的操作过于耗时，可能会跳过部分数据图像的显示过程。
2. 当缓冲区为满时才会显示数据。
\~english
Display all grabbed buffer data
View window handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
1. This function displays as much image data as possible without affecting the transmission of image data.
If the operation of displaying images is too time-consuming, it may skip the display process of some data images.
2. Data will only be displayed when the buffer is full.
\~chinese
显示下一帧缓冲区数据
视图窗口句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Display the next frame of buffer data
View window handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
显示某个缓冲区数据
视图窗口句柄
缓冲区句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Display the image data of some buffer
View window handle
Buffer handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
打开相机中的文件
相机设备句柄
打开或创建的文件名
设备文件打开模式
文件句柄
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
1. 打开的文件应该在操作结束后使用 ItkFileClose 关闭。
2. 如果在断电前对文件进行了更改而没有关闭，则可以删除或重新安装文件。
3. 禁止重复打开具有任何写模式标志的文件。
4. 文件打开模式可选项如下所示：
| 文件打开模式 |
|------------------------------|
| ITKFILE_VAL_FA_READ |
| ITKFILE_VAL_FA_WRITE |
| ITKFILE_VAL_FA_OPEN_EXISTING |
| ITKFILE_VAL_FA_CREATE_NEW |
| ITKFILE_VAL_FA_CREATE_ALWAYS |
| ITKFILE_VAL_FA_OPEN_ALWAYS |
| ITKFILE_VAL_FA_OPEN_APPEND |
\~english
Open files in the camera
Camera device handle
File name opened or created
Device file opening mode
File handle
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
1. The opened file should be closed using ItkFileClose after the operation is completed.
2. If changes are made to the file before the power outage and it is not closed, the file can be deleted or reinstalled.
3. Do not repeatedly open files with any write mode flags.
4. The file open mode options are as follows:
| File open mode |
|------------------------------|
| ITKFILE_VAL_FA_READ |
| ITKFILE_VAL_FA_WRITE |
| ITKFILE_VAL_FA_OPEN_EXISTING |
| ITKFILE_VAL_FA_CREATE_NEW |
| ITKFILE_VAL_FA_CREATE_ALWAYS |
| ITKFILE_VAL_FA_OPEN_ALWAYS |
| ITKFILE_VAL_FA_OPEN_APPEND |
\~chinese
关闭相机中的文件
文件句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
如果文件已更改，则将文件的缓存信息写回。
\~english
Close files in the camera
File handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
If the file has been changed, write back the cached information of the file.
\~chinese
读取设备文件数据
文件句柄
存储读取数据的用户缓冲区
缓冲区长度
实际读取的字节数
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. 本函数从相机文件指针位置读取数据到用户缓冲区。读取成功后，文件指针会向前移动*br字节。
2. 每次打开文件后，文件指针都会复位到0。
3. 每次读取完成后，都应检测*br参数以验证是否到达文件末尾。若*br < btr，则表示当前文件指针已经到达文件末尾。
\~english
Read device file data
File handle
User buffer for storing read data
Buffer length
Actual number of bytes read
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. This function reads data from the camera file pointer position to the user buffer. After successful reading, the file pointer will move forward by *br bytes.
2. After each file is opened, the file pointer is reset to 0.
3. After each reading is completed, the *br parameter should be checked to verify if it has reached the end of the file.
If *br<btr, it means that the current file pointer has reached the end of the file.
\~chinese
写入设备文件数据
文件句柄
存储写入数据的用户缓冲区
缓冲区长度
实际写入的字节数
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. 本函数向相机文件指针位置写入用户缓冲区数据。写入成功后，文件指针会向前移动*bw字节。
2. 每次打开文件后，文件指针都会复位到0。
3. 每次写入完成后，都应检测*bw参数以验证文件是否已经耗尽所有剩余存储空间。若*bw < btw，则表示当前文件系统已无更多空间来存储数据。
\~english
Write device file data
File handle
User buffer for storing written data
Buffer length
Actual number of bytes written
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. This function writes user buffer data to the camera file pointer position. After successful writing, the file pointer will move forward by *bw bytes.
2. After each file is opened, the file pointer is reset to 0.
3. After each write is completed, the *bw parameter should be checked to verify if the file has exhausted all remaining storage space.
If *bw<btw, it means that the current file system has no more space to store data.
\~chinese
获取文件存取的进度
文件句柄
已完成的长度
总长度
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~english
Get the progress value of file read/write operation
File handle
Completed Length
Total Length
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~chinese
设置设备文件偏移量
文件句柄
偏移量
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
文件指针位置会作为写入文件和读取文件的起始地址，每次成功读取或写入文件都会移动指针。使用 ItkFileLSeek 可以移动指针位置。
\~english
Set device file offset
File handle
Offset
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
The file pointer position will serve as the starting address for writing and reading files,
and the pointer will be moved every time a file is successfully read or written. ItkFileLSeek allows you to move the pointer position.
\~chinese
获取设备文件大小
文件句柄
文件尺寸
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~english
Get device file size
File handle
File size
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~chinese
刷新写入设备文件的缓冲信息
文件句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
当需要长时间打开文件并进行写入操作时，建议周期性调用本函数来刷新文件缓存信息，避免由于突然断电导致数据丢失。
\~english
Refresh the cache information for writing device files
File handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
When it is necessary to open a file for a long time and perform write operations,
it is recommended to periodically call this function to refresh the file cache information to avoid data loss due to sudden power outages.
\~chinese
获取设备文件位置相对于文件首的偏移字节数
文件句柄
偏移字节数
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~english
Get the offset byte count of the device file location relative to the file header
File handle
Offset byte count
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~chinese
检测设备文件结束符
文件句柄
结束符
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
若当前文件指针已经到达末尾，则ofs值为1，否则ofs值为0。
\~english
Detecting device file terminator
File handle
End symbol
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
If the current file pointer has reached the end, the ofs value is 1, otherwise the ofs value is 0.
\~chinese
打开设备文件夹
相机设备句柄
文件夹名称
指向文件夹对象的句柄
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
用户可以在文件夹中存储文件以形成树形文件结构。
\~english
Open device folder
Camera device handle
Folder name
Handle to folder object
- ITKSTATUS_OK
- ITKSTATUS_INSUFFICIENT_RESOURCES
Users can store files in folders to form a tree like file structure.
\~chinese
关闭设备文件夹
文件夹句柄
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
当文件夹句柄关闭后，后续所有使用该句柄的API都不再有效。
\~english
Close the device folder
Folder handle
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
After the folder handle is closed, all subsequent API that use the handle are no longer valid.
\~chinese
读取设备文件夹中的项
文件夹句柄
指向文件信息结构的指针，用于存储有关已读项的信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. 点条目（“”和“..”)在子目录中会被过滤掉，不会出现在读取项中。
2. 当所有文件都已被读取后，将存储一个空字符串到fno->fname[]中。
\~english
Read items from the device folder
Folder handle
Pointer to the file information structure, used to store information about read items
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. Point entries ("" and "..") will be filtered out in subdirectories and will not appear in read entries.
2. After all files have been read, an empty string will be stored in fno->fname[].
\~chinese
检测文件或目录是否存在
相机设备句柄
文件名称
指向文件信息结构的指针，存储文件信息
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. 如果文件不存在，则返回 FR_NO_FILE 。
2. 如果文件存在，则返回FR_OK和存储到文件信息结构中的文件信息。
\~english
Check if the file or directory exists
Camera device handle
File name
Pointer to the file information structure, storing file information
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. If the file does not exist, return FR_NO_FILE .
2. If the file exists, return the FR_OK and the file information stored in the file information structure.
\~chinese
删除文件或目录
相机设备句柄
文件名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. 如果文件或目录的访问模式为只读模式，则无法被删除。
2. 子目录必须为空，且不能是当前目录。
3. 文件或目录必须未被打开。
\~english
Delete files or directories
Camera device handle
File name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
1. If the access mode of a file or directory is read-only, it cannot be deleted.
2. The subdirectories must be empty and cannot be the current directory.
3. The file or directory must not be opened.
\~chinese
文件或子目录重命名
相机设备句柄
文件或目录原名称
文件或目录重命名名称
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
要重命名的文件或目录必须未被打开。
\~english
Rename files or subdirectories
Camera device handle
Original name of file or directory
Rename file or directory name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
The file or directory to be renamed must not be opened.
\~chinese
创建新目录
相机设备句柄
创建目录名
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~english
Create a new directory
Camera device handle
Created directory name
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
- ITKSTATUS_INVALD_ARG
\~chinese
获取设备的空余空间
相机设备句柄
空余空间，单位字节
设备总空间，单位字节
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~english
Get free space on the device
Camera device handle
Free space, unit byte
Total device space, in bytes
- ITKSTATUS_OK
- ITKSTATUS_INVALID_HANDLE
\~chinese
IKapC库函数返回值
\~english
IKapC library function return value
\~chinese
函数返回值定义
函数返回值是一个32bit数据，数据各位描述如下所示：
| 位数 | 描述 |
|---------|------------|
| [0:15] | 错误码ID |
| [16:19] | 错误类别ID |
| [20:23] | 模块ID |
| [24:31] | 预留 |
\~english
Function return value definition
The return value of function is a 32bit data, which is described as follows:
| Bit | Description |
|----------|---------------|
| [0:15] | Error code ID |
| [16:19] | Error type ID |
| [20:23] | Module ID |
| [24:31] | Reversed |
\~chinese 模块ID偏移位置 \~english Module ID offset
\~chinese 错误类别ID偏移位置 \~english Error type ID offset
\~chinese 错误码ID偏移位置 \~english Error code ID offset
\~chinese 模块ID切块 \~english Module ID mask
\~chinese 错误类别ID切块 \~english Error type ID mask
\~chinese 错误码ID切块 \~english Error code ID mask
\~chinese
\~english
\~chinese 未指明的错误 \~english Unknown error
\~chinese 设备模块 \~english Device module
\~chinese 缓冲区模块 \~english Buffer module
\~chinese 日志模块 \~english Log module
\~chinese 全局模块 \~english Management module
\~chinese 数据流模块 \~english Data stream module
\~chinese 参数模块 \~english Parameter module
\~chinese 串口模块 \~english Serial port module
\~chinese 事件信息模块 \~english Event information module
\~chinese 特征模块 \~english Feature module
\~chinese 视图模块 \~english View module
\~chinese 采集卡模块 \~english Frame grabber module
\~chinese 文件模块 \~english File module
\~chinese
\~english
\~chinese 致命错误 \~english Fatal error
\~chinese 普通错误 \~english Ordinary error
\~chinese 警告 \~english Warning
\~chinese 信息 \~english Information
\~chinese
\~english
\~chinese 成功 \~english Successful
\~chinese 无效的句柄 \~english Invalid handle
\~chinese 资源不足 \~english Insufficient resources
\~chinese 输入缓冲区太小 \~english Input buffer is too small
\~chinese 资源缺失 \~english Resources missing
\~chinese IKapC没有初始化运行环境 \~english IKapC has no initialized runtime environment
\~chinese 设备索引越界 \~english Device index is out of range
\~chinese 设备串口不可用 \~english Serial port is unavailable
\~chinese 设备XML描述文件丢失 \~english Device XML description file is lost
\~chinese 设备无法访问 \~english Device is inaccessible
\~chinese 设备访问被拒绝 \~english Device access is denied
\~chinese 注册表丢失 \~english Registry missing
\~chinese XML文件无法解析 \~english XML file cannot be parsed
\~chinese 无效的输入参数 \~english Invalid input parameter
\~chinese 无效的特征名称 \~english Invalid feature name
\~chinese 特征类型不匹配函数类型 \~english Feature type does not match function type
\~chinese 操作超时 \~english Operation timed out
\~chinese 相机命令冲突 \~english Camera command conflict
\~chinese 相机参数越界 \~english Camera parameter is out of range
\~chinese 当前状态下不允许执行该命令 \~english Command cannot be executed in the current state
\~chinese 相机命令无法解析 \~english Camera command cannot be parsed
\~chinese 执行命令被挂起 \~english Execution command is suspended
\~chinese 输入参数越界 \~english Input parameter is out of bounds
\~chinese 未实现 \~english Not realized
\~chinese 内存不足 \~english Out of memory
\~chinese 参数不匹配 \~english Parameter mismatch
\~chinese 数据流正在传输 \~english Data stream has being transferred
\~chinese 参数只读 \~english Parameters are read-only
\~chinese 数据流已经被打开 \~english Data stream has been opened
\~chinese 系统函数调用错误 \~english System function call error
\~chinese 无效的地址 \~english Invalid address
\~chinese 参数边界不适配 \~english Parameter boundaries do not match
\~chinese 设备正忙，无法响应命令 \~english Device is busy and cannot respond to commands
\~chinese 设备已经被移除 \~english Device has been removed
\~chinese 未找到设备 \~english Device not found
\~chinese 设备已经打开，不允许重复打开相同的设备 \~english Device has been enabled. Do not enable the same device repeatedly
\~chinese 设备未打开 \~english Device is not opened
\~chinese 参数只支持写操作 \~english Parameter supports only write operations
\~chinese 采集卡和相机连接断开 \~english Frame grabber is disconnected from camera
\~chinese 程序运行时错误 \~english Program runtime error
\~chinese IO错误 \~english IO error
\~chinese 缓冲区溢出 \~english Buffer overflow
\~chinese 通信异常 \~english Abnormal communication
\~chinese CXP相机CRC错误 \~english CXP camera CRC error
\~chinese gvcp的ack回复中acknowledge字段不正确或ack_id与cmd_id不匹配 \~english Acknowledge field in gvcp's ack reply is error or ack_id does not match cmd_id
\~chinese 命令头部无效 \~english Command header is invalid
\~chinese 设备流接口端点已停止 \~english Endpoint of device stream interface has stopped
\~chinese 设备事件接口端点已停止 \~english Device event interface endpoint has stopped
\~chinese 当前块发生数据丢弃 \~english Data loss occurred in the current chunk
\~chinese 设备无法发送所有数据 \~english Device is unable to send all data
\~chinese 数据流被中止 \~english Data stream has been aborted
\~chinese 驱动版本不匹配 \~english Driver version mismatch
\~chinese USB接口非3.0版本 \~english USB interface not version 3.0
\~chinese 设备故障 \~english Device error
\~chinese CXP拓扑连接错误 \~english CXP topology connection error
\~chinese 数据流还未开始 \~english Data stream has not been started
\~chinese 数据流超时 \~english Data stream has been timed out
\~chinese 数据流终止 \~english Data stream has been abort
\~chinese 无效的缓冲区句柄 \~english Invalid buffer handle
\~chinese
IKapC库相关定义
\~english
IKapC library related definition
\~chinese
\~english
\~chinese
\~english
\~chinese
是否使用CXP12协议【RW】
本参数表示是否使用CXP12协议。
1. 本参数默认支持CXP12协议。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
3. 参数取值及描述如下所示：
| 参数取值 | 描述 |
|----------|-----------------|
| 0 | 不使用CXP12协议 |
| 1 | 使用CXP12协议 |
\~english
Whether to use CXP12 protocol [RW]
This parameter indicates whether to use CXP12 protocol.
1. This parameter supports CXP12 protocol by default.
2. The corresponding pValue/value of this parameter is uint32_t type data.
3. The parameter values and descriptions are as follows:
| Parameter value | Description |
|------------------|--------------------------|
| 0 | Not using CXP12 protocol |
| 1 | Using CXP12 protocol |
\~chinese
是否支持CXP指令Tag【RW】
本参数表示是否支持CXP指令Tag。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 参数取值及描述如下所示：
| 参数取值 | 描述 |
|----------|------------------|
| 0 | 不支持CXP指令Tag |
| 1 | 支持CXP指令Tag |
\~english
Whether to support CXP instruction Tag [RW]
This parameter indicates whether CXP instruction Tag is supported.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The parameter values and descriptions are as follows:
| Parameter value | Description |
|-----------------|----------------------------------|
| 0 | Does not support CXP command Tag |
| 1 | Support CXP command Tag |
\~chinese
CXP控制包最大尺寸【RW】
本参数表示CXP控制包最大尺寸。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
CXP control packet maximum size [RW]
This parameter indicates the maximum size of CXP control packet.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
CXP流包最大尺寸【RW】
本参数表示CXP流包最大尺寸。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
CXP stream packet maximum size [RW]
This parameter indicates the maximum size of CXP stream packet.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
CXP读写寄存器最大次数【RW】
本参数表示CXP读写寄存器最大次数。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
CXP maximum number of read and write register operations [RW]
This parameter indicates the maximum number of CXP read and write register operations.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
使能合并相同序列号相机【RW】
本参数表示是否使能合并相同序列号相机功能，仅XGV采集卡具有合并相同序列号相机功能。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Enable to merge the same serial number camera [RW]
This parameter indicates if enable to merge the same serial number camera, only XGVB can merge the same serial number camera.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
设置GV相机探测时的超时时间【RW】
GV相机探测时的超时时间。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Set the timeout time for GV camera detection [RW]
The timeout time for GV camera detection.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
\~english
\~chinese
设备心跳包超时时间【RW】
本参数表示设备心跳包超时时间，单位ms。
1. 当调试千兆网相机设备时，可以增大该参数，保证相机不会因为未及时接受心跳包而停止工作。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Device heartbeat timeout [RW]
This parameter indicates device heartbeat timeout, measured in milliseconds.
1. When debugging a gigabit network camera device, users can increase this parameter to ensure that the camera
does not stop working due to not receiving heartbeat in a timely manner.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
设备接口类型【RO】
本参数表示设备接口类型。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 参数取值及描述如下所示：
| 参数取值 | 描述 |
|----------|----------------------|
| 0 | GigEVision |
| 1 | Camera Link |
| 2 | Camera Link Standard |
| 3 | CoaXPress |
| 4 | USB3Vision |
| 5 | PCIe |
| 6 | GigEVisionBoard |
| 7 | Multi Port |
| 8 | GenTL |
| 9 | Virtual |
\~english
Device interface type [RO]
This parameter indicates device interface type.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The parameter values and descriptions are as follows:
| Parameter value | Description |
|-----------------|----------------------|
| 0 | GigEVision |
| 1 | Camera Link |
| 2 | Camera Link Standard |
| 3 | CoaXPress |
| 4 | USB3Vision |
| 5 | PCIe |
| 6 | GigEVisionBoard |
| 7 | Multi Port |
| 8 | GenTL |
| 9 | Virtual |
\~chinese
禁用心跳线程【RW】
本参数表示禁用设备心跳线程，需要同时开启设备的DisableHeartBeat特征，否则设备会拒绝访问。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 参数取值及描述如下所示：
| 参数取值 | 描述 |
|----------|----------------|
| 0 | 禁用心跳线程 |
| 1 | 使能心跳线程 |
\~english
Disable heartbeat thread [RW]
This parameter indicates that to disable the device heartbeat thread,
and needs to simultaneously activate the DisableHeartBeat features of the device, otherwise the device will deny access.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The parameter values and descriptions are as follows:
| Parameter value | Description |
|------------------|---------------------------|
| 0 | Disable heartbeat thread |
| 1 | Enable heartbeat thread |
\~chinese
禁用控制通道等待ACK【RW】
本参数表示禁用控制通道等待ACK。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 参数取值及描述如下所示：
| 参数取值 | 描述 |
|----------|-----------------------|
| 0 | 禁用控制通道等待ACK |
| 1 | 使能控制通道等待ACK |
\~english
Disable control channel waiting for ACK [RW]
This parameter indicates that to disable control channel waiting for ACK.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The parameter values and descriptions are as follows:
| Parameter value | Description |
|------------------|------------------------------------------|
| 0 | Disable control channel waiting for ACK |
| 1 | Enable control channel waiting for ACK |
\~chinese
相机控制通道操作超时时间【RW】
本参数表示相机控制通道操作超时时间，单位ms。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Camera control channel operation timeout time [RW]
This parameter indicates camera control channel operation timeout time and the unit is millisecond.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
设备只读访问模式
本标志不能与其他参数组合，它通常用于网口相机的多播/广播应用。
\~english
Device read-only access mode
This flag cannot be combined with other parameters and is typically used for multicast/broadcast applications on Ethernet cameras.
\~chinese
设备参数读写访问模式
允许对相机参数进行读写来配置相机。
\~english
Device parameter read/write access mode
Allow reading and writing of camera parameters to configure camera.
\~chinese
设备数据流只读访问模式
允许从相机的数据流中读取图像数据。
\~english
Read only access mode for device data stream
Allow reading image data from camera's data stream.
\~chinese
设备独占式访问模式
指定本标志时，其他应用程序不能访问相机。
\~english
Exclusive access mode for device
When this flag is specified, other applications cannot access the camera.
\~chinese
设备掉线回调事件
本事件在设备掉线时触发,通过"DeviceRemove"注册。
\~english
Device offline callback event
This event is triggered when the device is offline, registered by "DeviceRemove".
\~chinese
设备参数变化回调事件
本事件在设备参数变化时触发,通过"FeatureValueChanged"注册。
\~english
Device parameter changed callback event
This event is triggered when the device parameter is changed, registered by "FeatureValueChanged".
\~chinese
消息通道回调事件
本事件在设备通过消息通道发送event时触发，通过"MessageChannel"注册。
\~english
Message channel callback event
This event is triggered during device send events by message channel, registered by "MessageChannel".
\~chinese 数据符号位未定义 \~english Data symbol bit undefined
\~chinese有符号类型数据 \~english Signed type data
\~chinese 无符号类型数据 \~english Unsigned type data
\~chinese
\~english
\~chinese
缓冲区数据格式【RW】
本参数表示缓冲区数据格式。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Buffer data format [RW]
This parameter indicates buffer data format.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
缓冲区宽度【RW】
本参数表示缓冲区宽度。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Buffer width [RW]
This parameter indicates buffer width.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
缓冲区高度【RW】
本参数表示缓冲区高度。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Buffer height [RW]
This parameter indicates buffer height.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
缓冲区地址【RW】
本参数表示缓冲区地址。
1. 本参数表示缓冲区首地址，可以通过该地址直接访问缓冲区数据。
2. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Buffer address [RW]
This parameter indicates buffer address.
1. This parameter indicates the first address of buffer, which allows direct access to buffer data.
2. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
缓冲区状态为满时的时间戳【RO】
本参数表示缓冲区状态为满时的时间戳，该值受系统CPU时钟频率影响。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Timestamp when buffer status is full [RO]
This parameter indicates timestamp when buffer state is full, which is affected by system CPU clock frequency.
2. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
缓冲区状态【RO】
本参数表示缓冲区状态。
1. 缓冲区状态定义了缓冲区为空或者满。当缓冲区为空时，数据流采集得到的图像数据可以存入该缓冲区中；
当缓冲区为满时，如果数据流继续采集数据并放入缓冲区中，会导致缓冲区被覆盖。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
3. 缓冲区状态选项如下所示：
| 缓冲区状态 |
|---------------------------------|
| ITKBUFFER_VAL_STATE_EMPTY |
| ITKBUFFER_VAL_STATE_FULL |
| ITKBUFFER_VAL_STATE_OVERFLOW |
| ITKBUFFER_VAL_STATE_UNCOMPLETED |
\~english
Buffer status [RO]
This parameter indicates buffer status.
1. The buffer state defines whether the buffer is empty or full. When buffer is empty, image data grabbed by
data stream can be stored in it. When buffer is full, if data stream continues to collect data and put it into the buffer, it
will cause buffer overwritten.
2. The corresponding pValue/value of this parameter is uint32_t type data.
3. The options for buffer status are as follows:
| Buffer Status |
|---------------------------------|
| ITKBUFFER_VAL_STATE_EMPTY |
| ITKBUFFER_VAL_STATE_FULL |
| ITKBUFFER_VAL_STATE_OVERFLOW |
| ITKBUFFER_VAL_STATE_UNCOMPLETED |
\~chinese
缓冲区像素值有无符号【RO】
本参数表示缓冲区像素值有无符号。
1. 本参数无法设置，数值由缓冲区像素格式 ITKBUFFER_PRM_FORMAT 决定。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Whether pixel value in buffer is signed or not [RO]
This parameter indicates whether pixel value in buffer is signed or not.
1. This parameter cannot be set, the value is determined by buffer pixel format ITKBUFFER_PRM_FORMAT .
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
缓冲区大小【RO】
本参数表示缓冲区大小。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Buffer size [RO]
This parameter indicates buffer size.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
缓冲区索引【RO】
本参数表示缓冲区索引。
1. 对于网口相机，参数有效范围是[1,65535]，并且随着采集帧数的增加而顺序递增。
2. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Buffer Index [RO]
This parameter indicates buffer index.
1. For Ethernet camera, the effective range of parameters is [1,65535], and it increases sequentially with the
increase of the number of grabbed frames.
2.The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
缓冲区当前采集完成的行数【RO】
本参数表示缓冲区当前采集完成的行数。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
The current number of lines grabbed in buffer [RO]
This parameter indicates the current number of lines grabbed in buffer.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
缓冲区错误原因【RO】
本参数表示缓冲区错误原因。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Reason for buffer error [RO]
This parameter indicates the reason for buffer error.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
当前帧图像重包数【RO】
本参数表示当前帧图像重包数。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Number of image resend packet in the current frame [RO]
This parameter indicates the number of image resend packet in the current frame.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
当前帧图像丢包数【RO】
本参数表示当前帧图像丢包数。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Current frame image packet loss count [RO]
This parameter indicates the current frame image packet loss count.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
获取寻边算法结果【RO】
本参数表示获取寻边算法结果。
1. 本参数对应的pValue/value为 uint64_t[33*2] 类型数据。
\~english
Obtain the results of the edge search algorithm [RO]
This parameter indicates obtaining the results of the edge finding algorithm.
1. The corresponding pValue/value of this parameter is uint64_t[33*2] type data.
\~chinese
交换缓冲区宽高【WO】
本参数表示交换缓冲区宽高。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Exchange buffer width and height [WO]
This parameter indicates exchanging buffer width and height.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
批量缓冲区状态地址【RO】
本参数表示批量缓冲区状态地址。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Batch buffer status address [RO]
This parameter indicates the batch buffer status address.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
毛刺检测结果【RO】
本参数表示毛刺检测结果。
1. 本参数对应的pValue/value为 uint8_t 类型数据。
\~english
Burr detection result [RO]
This parameter indicates the burr detection result.
1. The corresponding pValue/value of this parameter is uint8_t type data.
\~chinese
毛刺检测结果坐标【RO】
本参数表示毛刺检测结果坐标。
1. 本参数对应的pValue/value为 uint16_t[6] 类型数据。
\~english
Burr detection result coordinates [RO]
This parameter indicates the burr detection result coordinates.
1. The corresponding pValue/value of this parameter is uint16_t[6] type data.
\~chinese
毛刺检测调试【RO】
本参数表示毛刺检测调试。
1. 本参数对应的pValue/value为 uint16_t[4] 类型数据。
\~english
Burr detection debug [RO]
This parameter indicates burr detection debug.
1. The corresponding pValue/value of this parameter is uint16_t[4] type data.
\~chinese
缓冲区负载格式【RO】
缓冲区负载格式。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Buffer payload type [RO]
This parameter indicates buffer payload type.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
缓冲区图像数据大小【RO】
缓冲区图像数据大小。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Buffer image size [RO]
This parameter indicates buffer image size.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
缓冲区像素总深度【RO】
本参数表示缓冲区像素总深度。
1. 本参数无法设置，数值由缓冲区像素格式 ITKBUFFER_PRM_FORMAT 决定。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Buffer pixel total depth [RO]
This parameter indicates buffer pixel total depth.
1. This parameter cannot be set, the value is determined by buffer pixel format ITKBUFFER_PRM_FORMAT .
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
缓冲区通道深度【RO】
本参数表示缓冲区通道深度。
1. 本参数无法设置，数值由缓冲区像素格式 ITKBUFFER_PRM_FORMAT 决定。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Buffer channel depth [RO]
This parameter indicates buffer channel depth.
1. This parameter cannot be set, the value is determined by buffer pixel format ITKBUFFER_PRM_FORMAT .
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
Bayer转换算法【RW】
本参数在ItkBufferConvert接口中生效。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. Bayer转换算法可选项如下所示：
| Bayer转换算法 |
|-------------------------------------|
| ITKBUFFER_VAL_BAYER_METHOD_DEFAULT |
| ITKBUFFER_VAL_BAYER_METHOD_BILINEAR |
| ITKBUFFER_VAL_BAYER_METHOD_VNG |
| ITKBUFFER_VAL_BAYER_METHOD_DFSD |
| ITKBUFFER_VAL_BAYER_METHOD_ITEK_OLD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD2 |
\~english
Bayer Convert method [RW]
This parameter takes effect in ItkBufferConvert interface.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. Bayer convert algorithm can be selected as follows:
| Bayer Convert Algorithm |
|-------------------------------------|
| ITKBUFFER_VAL_BAYER_METHOD_DEFAULT |
| ITKBUFFER_VAL_BAYER_METHOD_BILINEAR |
| ITKBUFFER_VAL_BAYER_METHOD_VNG |
| ITKBUFFER_VAL_BAYER_METHOD_DFSD |
| ITKBUFFER_VAL_BAYER_METHOD_ITEK_OLD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD |
| ITKBUFFER_VAL_BAYER_METHOD_DFCD2 |
\~chinese
缓冲区数据格式定义
缓冲区数据格式是一个32bit数据，数据各位描述如下所示：
| 位数 | 描述 |
|---------|------------------------------|
| [0:7] | 由内部实现，用作函数表的索引 |
| [8:15] | 像素深度 |
| [16:23] | 有效通道深度 |
| [24] | 图像类型 |
| [25] | 像素格式有无符号 |
| [26:31] | 预留 |
\~english
Buffer data format definition
The buffer data format is 32bit data, and each bit is described as follows:
| Bit | Description |
|---------|-----------------------------------------------------------------|
| [0:7] | Implemented internally and used as an index for function tables |
| [8:15] | Pixel depth |
| [16:23] | Valid channel depth |
| [24] | Image type |
| [25] | Pixel format with or without sign |
| [26:31] | Reserved |
\~chinese
黑白类型图像
\~english
Monochrome type image
\~chinese
彩色类型图像
\~english
Color type image
\~chinese
无符号类型像素格式
\~english
Unsigned type pixel format
\~chinese
有符号类型像素格式
\~english
Signed type pixel format
\~chinese
黑白8bit
灰度8bit图像数据，每个像素占据1个字节。
\~english
Monochrome 8bit
Grayscale 8bit image data, with each pixel occupying 1 byte.
\~chinese
黑白10bit
灰度10bit图像数据，每个像素占据2个字节。
\~english
Monochrome 10bit
Grayscale 10bit image data, with each pixel occupying 2 byte.
\~chinese
黑白压缩10bit
灰度10bit压缩图像数据。
\~english
Monochrome packed 10bit
Grayscale 10bit packed image data.
\~chinese
黑白12bit
灰度12bit图像数据，每个像素占据2个字节。
\~english
Monochrome 12bit
Grayscale 12bit image data, with each pixel occupying 2 byte.
\~chinese
黑白压缩12bit
灰度12bit压缩图像数据。
\~english
Monochrome packed 12bit
Grayscale 12bit packed image data.
\~chinese
黑白14bit
灰度14bit图像数据，每个像素占据2个字节。
\~english
Monochrome 14bit
Grayscale 14bit image data, with each pixel occupying 2 byte.
\~chinese
黑白16bit
灰度16bit图像数据，每个像素占据2个字节。
\~english
Monochrome 16bit
Grayscale 16bit image data, with each pixel occupying 2 byte.
\~chinese
RGB彩色8bit
彩色8bit图像，像素值按照RGB顺序在内存中排列，每个像素占据3个字节。
\~english
RGB color 8bit
Color 8bit image, pixel values are arranged in memory in RGB order, with each pixel occupying 3 bytes.
\~chinese
RGB彩色10bit
彩色10bit图像，像素值按照RGB顺序在内存中排列，每个像素占据6个字节。
\~english
RGB color 10bit
Color 10bit image, pixel values are arranged in memory in RGB order, with each pixel occupying 6 bytes.
\~chinese
RGB彩色12bit
彩色12bit图像，像素值按照RGB顺序在内存中排列，每个像素占据6个字节。
\~english
RGB color 12bit
Color 12bit image, pixel values are arranged in memory in RGB order, with each pixel occupying 6 bytes.
\~chinese
RGB彩色14bit
彩色14bit图像，像素值按照RGB顺序在内存中排列，每个像素占据6个字节。
\~english
RGB color 14bit
Color 14bit image, pixel values are arranged in memory in RGB order, with each pixel occupying 6 bytes.
\~chinese
RGB彩色16bit
彩色16bit图像，像素值按照RGB顺序在内存中排列，每个像素占据6个字节。
\~english
RGB color 16bit
Color 16bit image, pixel values are arranged in memory in RGB order, with each pixel occupying 6 bytes.
\~chinese
BGR彩色8bit
彩色8bit图像，像素值按照BGR顺序在内存中排列，每个像素占据3个字节。
\~english
BGR color 8bit
Color 8bit image, pixel values are arranged in memory in BGR order, with each pixel occupying 3 bytes.
\~chinese
BGR彩色10bit
彩色10bit图像，像素值按照BGR顺序在内存中排列，每个像素占据6个字节。
\~english
BGR color 10bit
Color 10bit image, pixel values are arranged in memory in BGR order, with each pixel occupying 6 bytes.
\~chinese
BGR彩色12bit
彩色12bit图像，像素值按照BGR顺序在内存中排列，每个像素占据6个字节。
\~english
BGR color 12bit
Color 12bit image, pixel values are arranged in memory in BGR order, with each pixel occupying 6 bytes.
\~chinese
BGR彩色14bit
彩色14bit图像，像素值按照BGR顺序在内存中排列，每个像素占据6个字节。
\~english
BGR color 14bit
Color 14bit image, pixel values are arranged in memory in BGR order, with each pixel occupying 6 bytes.
\~chinese
BGR彩色16bit
彩色16bit图像，像素值按照BGR顺序在内存中排列，每个像素占据6个字节。
\~english
BGR color 16bit
Color 16bit image, pixel values are arranged in memory in BGR order, with each pixel occupying 6 bytes.
\~chinese
Bayer图像GRBG排列8bit
Bayer格式8bit图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG 8bit
Bayer 8bit image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列8bit
Bayer格式8bit图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB 8bit
Bayer 8bit image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列8bit
Bayer格式8bit图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG 8bit
Bayer 8bit image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列8bit
Bayer格式8bit图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR 8bit
Bayer 8bit image, pixel values are arranged in memory in BGGR order.
\~chinese
Bayer图像GRBG排列10bit
Bayer格式10bit图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG 10bit
Bayer 10bit image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列10bit
Bayer格式10bit图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB 10bit
Bayer 10bit image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列10bit
Bayer格式10bit图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG 10bit
Bayer 10bit image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列10bit
Bayer格式10bit图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR 10bit
Bayer 10bit image, pixel values are arranged in memory in BGGR order.
\~chinese
Bayer图像GRBG排列压缩10bit
Bayer格式10bit压缩图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG packed 10bit
Bayer 10bit packed image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列压缩10bit
Bayer格式10bit压缩图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB packed 10bit
Bayer 10bit packed image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列压缩10bit
Bayer格式10bit压缩图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG packed 10bit
Bayer 10bit packed image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列压缩10bit
Bayer格式10bit压缩图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR packed 10bit
Bayer 10bit packed image, pixel values are arranged in memory in BGGR order.
\~chinese
Bayer图像GRBG排列12bit
Bayer格式12bit图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列12bit
Bayer格式12bit图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列12bit
Bayer格式12bit图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列12bit
Bayer格式12bit图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in BGGR order.
\~chinese
YUV图像
YUV图像（YUYV）。
\~english
YUV image
YUV image（YUYV）.
\~chinese
YUV图像
YUV图像（UYUV）。
\~english
YUV image
YUV image（UYUV）.
\~chinese
3D图像
3D图像（C16）Z坐标数据16bit。
\~english
3D image
3D image（C16）Z-coordinate data for 16bit.
\~chinese
3D图像
3D图像（AC16）X坐标数据16bit Z坐标数据16bit。
\~english
3D image
3D image（AC16）X-coordinate data for 16bit and Z-coordinate data for 16bit.
\~chinese
3D图像
3D图像（ACR16）X坐标数据16bit Z坐标数据16bit 亮度数据16bit。
\~english
3D image
3D image（ACR16）X-coordinate data for 16bit and Z-coordinate data for 16bit Brightness data for the 16bit.
\~chinese
YUV图像
YUV图像（UYVY）。
\~english
YUV image
YUV image（UYVY）.
\~chinese
PCD图像
PCD图像。
\~english
PCD image
PCD image.
\~chinese
Bayer图像GRBG排列压缩12bit
Bayer格式12bit压缩图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列压缩12bit
Bayer格式12bit压缩图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列压缩12bit
Bayer格式12bit压缩图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列压缩12bit
Bayer格式12bit压缩图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR packed 12bit
Bayer 12bit packed image, pixel values are arranged in memory in BGGR order.
\~chinese
黑白压缩10bit（USB相机专用）
灰度10bit压缩图像数据。
\~english
Monochrome packed 10bit (USB camera specific)
Grayscale 10bit compressed image data
\~chinese
Bayer图像GRBG排列压缩10bit（USB相机专用）
Bayer格式10bit压缩图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG packed 10bit (USB camera specific)
Bayer 10bit packed image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列压缩10bit（USB相机专用）
Bayer格式10bit压缩图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB packed 10bit (USB camera specific)
Bayer 10bit packed image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列压缩10bit（USB相机专用）
Bayer格式10bit压缩图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG packed 10bit (USB camera specific)
Bayer 10bit packed image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列压缩10bit（USB相机专用）
Bayer格式10bit压缩图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR packed 10bit (USB camera specific)
Bayer 10bit packed image, pixel values are arranged in memory in BGGR order.
\~chinese
Bayer图像GRBG排列14bit
Bayer格式14bit图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG 14bit
Bayer 14bit image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列14bit
Bayer格式14bit图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB 14bit
Bayer 14bit image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列14bit
Bayer格式14bit图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG 14bit
Bayer 14bit image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列14bit
Bayer格式14bit图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR 14bit
Bayer 14bit image, pixel values are arranged in memory in BGGR order.
\~chinese
Bayer图像GRBG排列16bit
Bayer格式16bit图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG 16bit
Bayer 16bit image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列16bit
Bayer格式16bit图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB 16bit
Bayer 16bit image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列16bit
Bayer格式16bit图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG 16bit
Bayer 16bit image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列16bit
Bayer格式16bit图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR 16bit
Bayer 16bit image, pixel values are arranged in memory in BGGR order.
\~chinese
黑白压缩12bit（USB相机专用）
灰度12bit压缩图像数据。
\~english
Monochrome packed 12bit (USB camera specific)
Grayscale 12bit compressed image data
\~chinese
Bayer图像GRBG排列压缩12bit（USB相机专用）
Bayer格式12bit压缩图像，像素值按照GRBG顺序在内存中排列。
\~english
Bayer GRBG packed 12bit (USB camera specific)
Bayer 12bit packed image, pixel values are arranged in memory in GRBG order.
\~chinese
Bayer图像RGGB排列压缩12bit（USB相机专用）
Bayer格式12bit压缩图像，像素值按照RGGB顺序在内存中排列。
\~english
Bayer RGGB packed 12bit (USB camera specific)
Bayer 12bit packed image, pixel values are arranged in memory in RGGB order.
\~chinese
Bayer图像GBRG排列压缩12bit（USB相机专用）
Bayer格式12bit压缩图像，像素值按照GBRG顺序在内存中排列。
\~english
Bayer GBRG packed 12bit (USB camera specific)
Bayer 12bit packed image, pixel values are arranged in memory in GBRG order.
\~chinese
Bayer图像BGGR排列压缩12bit（USB相机专用）
Bayer格式12bit压缩图像，像素值按照BGGR顺序在内存中排列。
\~english
Bayer BGGR packed 12bit (USB camera specific)
Bayer 12bit packed image, pixel values are arranged in memory in BGGR order.
\~chinese
3D图像
3D图像（Coord3D_CR32）。从高有效位开始，前8bit为亮度数据，后24bit为未标定的线中心数据。
\~english
3D image
3D image（Coord3D_CR32）. Starting from the high effective bit, the first 8 bits are brightness data and the last 24 bits are uncalibrated line center data.
\~chinese
3D图像
3D图像（Calibrated_Coord3D_AC32）。4个连续的X坐标32bit，4个连续的32bit，其中从高有效位开始，高8bit是亮度信息，后24bit是Z坐标。
\~english
3D image
3D image（Calibrated_Coord3D_AC32）. Four consecutive X coordinates 32 bits, four consecutive 32 bits, where starting from the most significant bit, the high 8 bits are the brightness information, and the last 24 bits are the Z coordinates.
\~chinese
3D图像
3D图像（Calibrated_Coord3D_C32）。32bit数据，其中从高有效位开始，高8bit是亮度信息，后24bit是Z坐标。
\~english
3D image
3D image（Calibrated_Coord3D_C32）. 32bit data, where the first 8 bits from the high most significant bit are the brightness information and the last 24 bits are the Z coordinates.
\~chinese
32bit 无符号数。
\~english
Data 32-bit unsigned.
\~chinese
16bit 无符号数。
\~english
Data 16-bit unsigned.
\~chinese
32bit 有符号数。
\~english
Data 32-bit signed.
\~chinese
16bit 有符号数。
\~english
Data 16-bit signed.
\~chinese
16bit 无符号数和8bit无符号数。
\~english
Data 16-bit unsigned with 8bit unsigned.
\~chinese
32bit 无符号数和8bit无符号数。
\~english
Data 32-bit unsigned with 8bit unsigned.
\~chinese
函数表索引
\~english
Function table index
\~chinese
单个像素深度
\~english
Single pixel size
\~chinese
单个通道深度
\~english
Single channel size
\~chinese
获取图像通道数
\~english
Get the number of image channels
\~chinese
像素格式是否为彩色
\~english
Whether the pixel format is color
\~chinese
像素格式有无符号
\~english
Pixel format with or without sign
\~chinese
缓冲区状态为空
\~english
Buffer status is empty
\~chinese
缓冲区状态为满
\~english
Buffer status is full
\~chinese
缓冲区被覆盖
\~english
Buffer is overwritten
\~chinese
缓冲区未完成
\~english
Buffer is uncompleted
\~chinese
Bayer排列BGGR方式
\~english
Bayer BGGR method
\~chinese
Bayer排列RGGB方式
\~english
Bayer RGGB method
\~chinese
Bayer排列GBRG方式
\~english
Bayer GBRG method
\~chinese
Bayer排列GRBG方式
\~english
Bayer GRBG method
\~chinese
Bayer转换成BGR_Plannar格式标志
本参数为 ItkBufferBayerConvert 接口的可选option，用于将Bayer格式图像转换为BGR格式图像后，再按通道重新排列成三个区块。
1. 源缓冲区像素格式为Bayer8~16。
2. 目的缓冲区像素格式为Mono8~16。
3. 目的缓冲区的图像宽度与源缓冲区一致，图像高度为源缓冲区的3倍。
4. 该参数只在 ITKBUFFER_VAL_BAYER_METHOD_BILINEAR 插值方法下有效，通过(|)与其他option组合使用。
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~english
a flag convert Bayer to BGR_Plannar
This parameter is an option for ItkBufferBayerConvert interface, which converts Bayer format images to BGR format and then rearranges them into three blocks by channel.
1. The source buffer pixel format is Bayer8~16.
2. The destination buffer pixel format is Mono8~16。
3. The destination buffer has the same width as the source buffer, and three times the height of the source buffer.
4. This parameter is valid only with ITKBUFFER_VAL_BAYER_METHOD_BILINEAR interpolation method and must be combined other options with(|).
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~chinese Bayer转换默认方法, 当前是DFCD方法 \~english Bayer conversion default method, that is DFCD method
\~chinese Bayer转换bilinear方法 \~english Bayer conversion bilinear method
\~chinese Bayer转换vng方法 \~english Bayer conversion vng method
\~chinese Bayer转换DFSD方法 \~english Bayer conversion DFSD method
\~chinese Bayer转换ITEK_OLD方法 \~english Bayer conversion ITEK_OLD method
\~chinese Bayer转换DFCD方法 \~english Bayer conversion DFCD method
\~chinese Bayer转换DFCD2方法 \~english Bayer conversion DFCD2 method
\~chinese
YUV422转换成BGR_Plannar格式标志
本参数为 ItkBufferConvert 接口的可选option，用于将YUV422格式图像转换为BGR格式图像后，再按通道重新排列成三个区块。
1. 源缓冲区像素格式为YUV422。
2. 目的缓冲区像素格式为Mono8。
3. 目的缓冲区的图像宽度与源缓冲区一致，图像高度为源缓冲区的3倍。
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~english
a flag convert YUV422 to BGR_Plannar
This parameter is an option for ItkBufferConvert interface, which converts Bayer format images to YUV422 format and then rearranges them into three blocks by channel.
1. The source buffer pixel format is YUV422.
2. The destination buffer pixel format is Mono8。
3. The destination buffer has the same width as the source buffer, and three times the height of the source buffer.
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~chinese
数据格式缩小至至8bit，不能与拉伸参数同时使用
\~english
Data format shrink to 8bit，can't use with ITKBUFFER_VAL_CONVERT_OPTION_STRETCH at same time
\~chinese
数据格式拉伸至16bit，不能与缩小参数同时使用
\~english
Data format stretches to 16bit, can't use with ITKBUFFER_VAL_CONVERT_OPTION_SHRINK at same time
\~chinese
数据格式自动
主要会做转换:
1. bayer格式转换为bgr
2. yuv格式转换为bgr
3. packed模式转换为unpacked
4. rgb模式转化为bgr
\~english
Automatic data format
automatic convert:
1. bayer to bgr
2. yuv to bgr
3. packed to unpacked
4. rgb to bgr
\~chinese
将RGB格式的图像按行重新交替排列三个通道
```
R1R2R3
G1G2G3
B1B2B3
(R1G1B1)(R2G2B2)(R3G3B3) R4R5R6
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) B4B5B6
R7R8R9
G7G8G9
B7B8B9
```
\~english
The images in RGB format alternate the three channels in rows
```
R1R2R3
G1G2G3
B1B2B3
(R1G1B1)(R2G2B2)(R3G3B3) R4R5R6
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) B4B5B6
R7R8R9
G7G8G9
B7B8B9
```
\~chinese
将RGB格式的图像按通道重新排列成三个区块
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~english
Images in RGB format were rearranged into three blocks by channel
```
R1R2R3
R4R5R6
R7R8R9
(R1G1B1)(R2G2B2)(R3G3B3) G1G2G3
(R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
(R7G7B7)(R8G8B8)(R9G9B9) G7G8G9
B1B2B3
B4B5B6
B7B8B9
```
\~chinese
将3D格式的图像按通道重新排列成N个区块
```
A1A2A3
A4A5A6
A7A8A9
(A1C1R1)(A2C2R2)(A3C3R3) C1C2C3
(A4C4R4)(A5C5R5)(A6C6R6) -> C4C5C6
(A7C7R7)(A8C8R8)(A9C9R9) C7C8C9
R1R2R3
R4R5R6
R7R8R9
```
\~english
Images in 3D format were rearranged into N blocks by channel
```
A1A2A3
A4A5A6
A7A8A9
(A1C1R1)(A2C2R2)(A3C3R3) C1C2C3
(A4C4R4)(A5C5R5)(A6C6R6) -> C4C5C6
(A7C7R7)(A8C8R8)(A9C9R9) C7C8C9
R1R2R3
R4R5R6
R7R8R9
```
\~chinese
将3D格式的图像按通道重新排列成N个区块并按照batchCount分层
```
batchCount:2:
A11A12A13
A14A15A16
A21A22A23
(A11C11R11)(A12C12R12)(A13C13R13) A24A25A26
(A21C21R11)(A22C22R22)(A23C23R23) -> C11C12C13
(A14C14R14)(A15C15R15)(A16C16R16) C14C15C16
(A24C24R24)(A25C25R25)(A26C26R26) C21C22C23
C24C25C26
R11R12R13
R14R15R16
R21R22R23
R24R25R26
```
\~english
Images in 3D format were rearranged into N blocks by channel and were stratified according to the batchCount
```
batchCount:2:
A11A12A13
A14A15A16
A21A22A23
(A11C11R11)(A12C12R12)(A13C13R13) A24A25A26
(A21C21R11)(A22C22R22)(A23C23R23) -> C11C12C13
(A14C14R14)(A15C15R15)(A16C16R16) C14C15C16
(A24C24R24)(A25C25R25)(A26C26R26) C21C22C23
C24C25C26
R11R12R13
R14R15R16
R21R22R23
R24R25R26
```
\~chinese
图像缩放的最邻近方法
\~english
nearest neighbor interpolation
\~chinese
图像缩放的线性插值方法
\~english
bilinear interpolation
\~chinese
图像缩放的双三次插值方法
\~english
bicubic interpolation
\~chinese
图像缩放的区域重采样方法
\~english
resampling using pixel area relation
\~chinese
Bmp图像格式
\~english
Bmp image format
\~chinese
Tiff图像格式
\~english
Tiff image format
\~chinese
原始图像格式
\~english
Raw image format
\~chinese
Jpeg图像格式
\~english
Jpeg image format
\~chinese
Png图像格式
\~english
Png image format
\~chinese
pcd图像格式
\~english
pcd image format
\~chinese
数据格式拉伸至16bit
\~english
Data format stretches to 16bit
\~chinese
\~english
\~chinese
数据流传输状态【RO】
本参数表示数据流传输状态。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 数据流传输状态选项如下所示：
| 数据流传输状态 |
|------------------------------|
| ITKSTREAM_VAL_STATUS_STOPPED |
| ITKSTREAM_VAL_STATUS_ACTIVE |
| ITKSTREAM_VAL_STATUS_PENDING |
| ITKSTREAM_VAL_STATUS_ABORTED |
| ITKSTREAM_VAL_STATUS_TIMEOUT |
\~english
Data stream transmission status [RO]
This parameter indicates data stream transmission status.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for data stream transmission status are as follows:
| Data stream transmission status |
|---------------------------------|
| ITKSTREAM_VAL_STATUS_STOPPED |
| ITKSTREAM_VAL_STATUS_ACTIVE |
| ITKSTREAM_VAL_STATUS_PENDING |
| ITKSTREAM_VAL_STATUS_ABORTED |
| ITKSTREAM_VAL_STATUS_TIMEOUT |
\~chinese
数据流支持的回调事件类型【RO】
本参数表示数据流支持的回调事件类型。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 数据流支持的回调事件类型如下所示：
| 数据流支持的回调事件类型 |
|------------------------------------------------|
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_TIME_OUT |
| ITKSTREAM_VAL_EVENT_TYPE_FRAME_LOST |
| ITKSTREAM_VAL_EVENT_TYPE_IMAGE_DATA_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_DEVICE_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_BATCH |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVERED |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVER_FAILED |
\~english
The callback event types supported by data stream [RO]
This parameter indicates the callback event types supported by data stream.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. Callback event types supported by data stream are as follows:
| Callback event types supported by data stream |
|------------------------------------------------|
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_STREAM |
| ITKSTREAM_VAL_EVENT_TYPE_START_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_FRAME |
| ITKSTREAM_VAL_EVENT_TYPE_TIME_OUT |
| ITKSTREAM_VAL_EVENT_TYPE_FRAME_LOST |
| ITKSTREAM_VAL_EVENT_TYPE_IMAGE_DATA_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_DEVICE_ERROR |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_LINE |
| ITKSTREAM_VAL_EVENT_TYPE_END_OF_BATCH |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVERED |
| ITKSTREAM_VAL_EVENT_TYPE_STREAM_RECOVER_FAILED |
\~chinese
数据流采集启动模式【RW】
本参数表示数据流采集启动模式。
1. 本参数不会影响连续采集执行，连续采集过程始终采用非阻塞式启动方式。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
3. 数据流采集启动模式可选项如下所示：
| 数据流采集启动模式 |
|-------------------------------------|
| ITKSTREAM_VAL_START_MODE_NON_BLOCK |
| ITKSTREAM_VAL_START_MODE_BLOCK |
\~english
Data stream acquisition start mode [RW]
This parameter indicates data stream acquisition start mode.
1. This parameter will not affect continuous acquisition, and continuous acquisition process will always use a
non blocking start mode.
2. The corresponding pValue/value of this parameter is uint32_t type data.
3. The options for data stream acquisition start mode are as follows:
| Data stream acquisition start mode |
|-------------------------------------|
| ITKSTREAM_VAL_START_MODE_NON_BLOCK |
| ITKSTREAM_VAL_START_MODE_BLOCK |
\~chinese
数据流传输模式【RW】
本参数表示数据流传输模式，决定了数据传输过程中下一块传输缓冲区的索引。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 数据流传输模式可选项如下所示：
| 数据流传输模式 |
|------------------------------------------------------|
| ITKSTREAM_VAL_TRANSFER_MODE_ASYNCHRONOUS |
| ITKSTREAM_VAL_TRANSFER_MODE_SYNCHRONOUS |
| ITKSTREAM_VAL_TRANSFER_MODE_SYNCHRONOUS_WITH_PROTECT |
\~english
Data stream transmission mode [RW]
This parameter indicates data stream transmission mode and determines the index of the next transmission buffer
during data transmission process.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for data stream transmission mode are as follows:
| Data stream transmission mode |
|------------------------------------------------------|
| ITKSTREAM_VAL_TRANSFER_MODE_ASYNCHRONOUS |
| ITKSTREAM_VAL_TRANSFER_MODE_SYNCHRONOUS |
| ITKSTREAM_VAL_TRANSFER_MODE_SYNCHRONOUS_WITH_PROTECT |
\~chinese
数据流自动清空标志【RW】
本参数表示数据流自动清空标志。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 数据流自动清空标志可选项如下所示：
| 数据流自动清空标志 |
|------------------------------------|
| ITKSTREAM_VAL_AUTO_CLEAR_DISABLE |
| ITKSTREAM_VAL_AUTO_CLEAR_ENABLE |
\~english
Data stream automatic clearing flag [RW]
This parameter indicates data stream automatic clearing flag.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for data stream automatic clearing flag are as follows:
| Data stream automatic clearing flag |
|-------------------------------------|
| ITKSTREAM_VAL_AUTO_CLEAR_DISABLE |
| ITKSTREAM_VAL_AUTO_CLEAR_ENABLE |
\~chinese
数据流采集超时时间【RW】
本参数表示数据流采集超时时间。
1. 数据采集过程中，当连续两帧的时间间隔超过设定值，则会终止数据采集。
2. 对于尺寸较大的图像，可能需要较长时间完成采集，增加超时时间可以确保图像正常采集。
3. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Data stream acquisition timeout time [RW]
This parameter indicates data stream acquisition timeout time.
1. During data acquisition process, if the time interval between two consecutive frames exceeds the set value,
data acquisition will be terminated.
2. For large images, it may take a longer time to complete acquisition, and increasing the timeout time can
ensure normal image acquisition.
3. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
数据流实时采集帧率【RO】
本参数表示数据流实时采集帧率。
1. 本参数对应的pValue/value为 float 类型数据。
\~english
Real time data stream acquisition frame rate [RO]
This parameter indicates real time data stream acquisition frame rate.
1. The corresponding pValue/value of this parameter is float type data.
\~chinese
千兆网单个数据包最大重发次数【RW】
本参数表示千兆网单个数据包最大重发次数。
1. 本参数仅对千兆网相机有效，当PC端丢失千兆网数据包后会重新请求丢失的数据包，
单个数据包的最大请求次数不超过本参数。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Maximum retransmissions number for single packet [RW]
This parameter indicates maximum retransmissions number for single packet.
1. This parameter is only valid for gigabit network cameras. When PC loses a gigabit network packet, it will
request the lost packet again. The maximum number of requests for a single packet does not exceed this parameter.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
千兆网单个数据包重传超时时间【RW】
本参数表示千兆网单个数据包重传超时时间。
1. 本参数仅对千兆网相机有效，当PC端丢失千兆网数据包后会重新请求丢失的数据包，
单个数据包请求的超时时间不超过本参数。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Gigabit network single packet resend timeout time [RW]
This parameter indicates gigabit network single packet resend timeout time.
1. This parameter is only valid for gigabit network cameras. When PC loses a gigabit network packet, it will
request the lost packet again. The timeout time for a single packet request does not exceed this parameter.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
千兆网数据块最大重传包数【RW】
本参数表示千兆网数据块最大重传包数。
1. 本参数表示一帧图像允许的重传包数最大值。
如果某帧图像统计发送重传包太多而超过此值，则不会再发送重传命令，而是直接判定残帧。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Maximum number of retransmitted packets for GigEVision data block [RW]
This parameter indicates maximum number of retransmitted packets for GigEVision data block.
1. This parameter indicates the maximum number of retransmission packets allowed for one frame of image. If a
certain frame of image statistics sends too many retransmission packets and exceeds this value, no retransmission command
will be sent again, but residual frames will be directly determined.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
千兆网数据块最大等待包数【RW】
本参数表示千兆网数据块最大等待包数。
1. 如果某帧图像还没接收完，但是下一帧图像已经到来，
若下一帧图像接收了N个包，上一帧还没接收完，则强制结束上一帧，将其判断为残帧。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Maximum number of GigEVision data block to wait [RW]
This parameter indicates maximum number of GigEVision data block to wait.
1. If a certain frame of image has not been received yet, but the next frame of image has arrived, if the next
frame of image has received N packets and the previous frame has not been received yet, the previous frame will be forcibly
ended and judged as a residual frame.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
千兆网数据块重传窗口大小【RW】
本参数表示千兆网数据块重传窗口大小。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Gigabit network data block retransmission window size [RW]
This parameter indicates gigabit network data block retransmission window size.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
千兆网单个数据包行间超时时间【RW】
本参数表示千兆网单个数据包行间超时时间。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Gigabit network single packet inter timeout time [RW]
This parameter indicates gigabit network single packet inter timeout time.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
千兆网单个数据包轮询时间【RW】
本参数表示千兆网单个数据包轮询时间。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Polling time of GigEVision single data packet [RW]
This parameter indicates polling time of GigEVision single data packet.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
千兆网内核缓冲区个数【RO】
本参数表示千兆网内核缓冲区个数。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Count of GigEVision kernel buffer [RO]
This parameter indicates count of GigEVision kernel buffer.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
数据流采集行频【RO】
本参数表示数据流采集行频。
1. 本参数对应的pValue/value为 float 类型数据。
\~english
Data stream line rate [RO]
This parameter indicates data stream line rate.
1. The corresponding pValue/value of this parameter is float type data.
\~chinese
毛刺检测保存速率【RO】
本参数表示毛刺检测保存速率。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Burr detection save rate [RO]
This parameter indicates burr detection save rate.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
毛刺检测保存路径【RW】
本参数表示毛刺检测保存路径。
1. 本参数对应的pValue/value为 string 类型数据。
\~english
Burr detection save path [RW]
This parameter indicates burr detection save path.
1. The corresponding pValue/value of this parameter is string type data.
\~chinese
毛刺检测保存缓冲区个数【RW】
本参数表示毛刺检测保存缓冲区个数。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Number of buffer for burr detection [RW]
This parameter indicates number of buffer for burr detection.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
数据流批量缓冲区大小【RW】
本参数表示数据流批量缓冲区大小。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Batch buffer size for data stream [RW]
This parameter indicates batch buffer size for data stream.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
数据流参数是否自适应【RW】
本参数表示数据流参数是否自适应。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 参数取值及描述如下所示：
| 参数取值 | 描述 |
|----------|-----------------------|
| 0 | 禁用数据流参数自适应 |
| 1 | 使能数据流参数自适应 |
\~english
Whether data stream parameter adaptive [RW]
This parameter indicates whether data stream parameter adaptive.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The parameter values and descriptions are as follows:
| Parameter value | Description |
|------------------|------------------------------------------|
| 0 | Disable data stream parameter adaptive |
| 1 | Enable data stream parameter adaptive |
\~chinese
是否使帧开始对应帧结束【RW】
本参数表示是否使帧开始对应帧结束。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 参数取值及描述如下所示：
| 参数取值 | 描述 |
|----------|-----------------------|
| 0 | 禁用帧开始对应帧结束 |
| 1 | 使能帧开始对应帧结束 |
\~english
Whether let the frame start correspond to the frame end [RW]
This parameter indicates whether let the frame start correspond to the frame end.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The parameter values and descriptions are as follows:
| Parameter value | Description |
|------------------|---------------------------------------------|
| 0 | Disable frame start correspond to frame end |
| 1 | Enable frame start correspond to frame end |
\~chinese
取图策略【RW】
本参数表示数据流取图策略。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 取图策略可选项如下所示：
| 取图策略 |
|----------------------------------------|
| ITKSTREAM_VAL_GRAB_STRATEGY_ONE_BY_ONE |
| ITKSTREAM_VAL_GRAB_STRATEGY_LAST_ONE |
\~english
Image acquisition strategy [RW]
This parameter indicates data stream acquisition strategy.
1.The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for acquisition strategy are as follows:
| Acquisition Strategy |
|----------------------------------------|
| ITKSTREAM_VAL_GRAB_STRATEGY_ONE_BY_ONE |
| ITKSTREAM_VAL_GRAB_STRATEGY_LAST_ONE |
\~chinese
采图线程的CPU亲和性【WO】
本参数表示采图线程的CPU亲和性。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Grab Thread CPU Affinity [WO]
This parameter indicates grab thread CPU affinity.
1.The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
数据流同步停止采集状态
\~english
Data stream synchronous stopped acquisition status
\~chinese
数据流采集状态
\~english
Data stream acquisition status
\~chinese
数据流等待状态
\~english
Data stream waiting status
\~chinese
数据流异步停止采集状态
\~english
Data stream asynchronous stopped acquisition status
\~chinese
数据流超时状态
\~english
Data stream timeout status
\~chinese
数据流采集开始回调事件
本事件在数据流采集开始时触发。
\~english
Data stream acquisition start callback event
This event is triggered at the beginning of data stream acquisition.
\~chinese
数据流采集停止回调事件
本事件在数据流采集停止时触发。
\~english
Data stream acquisition stop callback event
This event is triggered when data stream acquisition stops.
\~chinese
帧采集开始回调事件
本事件在帧采集开始时触发。
\~english
Frame acquisition start callback event
This event is triggered at the beginning of frame acquisition.
\~chinese
帧采集完成回调事件
本事件在帧采集完成时触发。
\~english
Frame acquisition completed callback event
This event is triggered when frame acquisition completed.
\~chinese
采集超时回调事件
本事件在采集超时时触发。
\~english
Acquisition timeout callback event
This event is triggered when acquisition timeout occurred.
\~chinese
采集丢帧回调事件
本事件在采集丢帧时触发。
\~english
Acquisition frame loss callback event
This event is triggered when acquisition frame loss occurred.
\~chinese
图像数据错误回调事件
本事件在图像数据错误时触发。
\~english
Image data error callback event
This event is triggered when there is an image data error.
\~chinese
设备异常，取流被中止
本事件在设备异常(如静电放电)情况下,取流异常时触发。
\~english
Device Error, stream is aborted
This event is triggered when device error(eg.Electro-Static discharge).
\~chinese
n行数据采集完成回调事件
本事件在n行数据采集完成时触发。
\~english
n lines of data acquisition completed callback event
This event is triggered when the data acquisition of n lines is completed.
\~chinese
批量采集完成回调事件
本事件在批量采集完成时触发。
\~english
Batch acquisition completed callback event
This event is triggered when batch acquisition completed.
\~chinese
被中止的流成功恢复
\~english
The aborted stream was recovered successfully
\~chinese
被中止的流恢复失败
\~english
The aborted stream was recovered failed
\~chinese
非阻塞式采集模式
ItkStreamStart将会立刻返回。
\~english
Non blocking acquisition mode
ItkStreamStart will return immediately.
\~chinese
阻塞式采集模式
ItkStreamStart将会等待所有图像传输完毕再返回。
\~english
Blocking acquisition mode
ItkStreamStart will wait for all images to be transferred before returning.
\~chinese
异步传输模式
无论下一块缓冲区是否为满，始终传输数据到下一块缓冲区中。
\~english
Asynchronous transmission mode
Regardless of whether the next buffer is full or not, always transfer data to the next buffer.
\~chinese
同步传输模式
如果下一块缓冲区为空则传输到下一块缓冲区中，否则覆盖当前缓冲区。
\~english
Synchronous transmission mode
If the next buffer is empty, transfer to the next buffer; otherwise overwrite the current buffer.
\~chinese
同步保护模式
如果下一块缓冲区为空则传输到下一块缓冲区中，否则丢弃图像数据。
\~english
Synchronous protection mode
If the next buffer is empty, transfer it to the next buffer, otherwise discard the image data.
\~chinese
禁用数据流自动清空机制
\~english
Disable data stream automatic clearing mechanism
\~chinese
使能数据流自动清空机制
\~english
Enable data stream automatic clearing mechanism
\~chinese
取图策略:从旧到新一帧一帧的从输出缓存列表中获取图像，打开设备后默认为该策略
\~english
Image acquisition strategy: Obtain images from the output cache list frame by frame from old to new. This strategy is the default after opening the device.
\~chinese
取图策略:获取图像缓冲区列表中最后到达的一帧，同时清空缓冲区列表
该取图策略必须搭配主动取图接口ItkStreamWaitOneFrameReady使用
\~english
Image acquisition strategy: Obtain the last arriving frame in the image buffer list and clear the buffer list at the same time.
This image acquisition strategy must be used with the active image acquisition interface: ItkStreamWaitOneFrameReady
\~chinese
连续采集标志
\~english
Continuous acquisition flag
\~chinese
\~english
\~chinese
视图图像水平方向翻转【RW】
本参数表示视图图像水平方向翻转。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 视图图像水平方向翻转可选项如下所示：
| 视图图像水平方向翻转 |
|------------------------------|
| ITKVIEW_VAL_FLIP_X_DISABLE |
| ITKVIEW_VAL_FLIP_X_ENABLE |
\~english
Flip view image horizontally [RW]
This parameter indicates the horizontal flipping of view image.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for flip view image horizontally are as follows:
| Flip view image horizontally |
|------------------------------|
| ITKVIEW_VAL_FLIP_X_DISABLE |
| ITKVIEW_VAL_FLIP_X_ENABLE |
\~chinese
视图图像垂直方向翻转【RW】
本参数表示视图图像垂直方向翻转。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 视图图像垂直方向翻转可选项如下所示：
| 视图图像垂直方向翻转 |
|------------------------------|
| ITKVIEW_VAL_FLIP_Y_DISABLE |
| ITKVIEW_VAL_FLIP_Y_ENABLE |
\~english
Flip view image vertically [RW]
This parameter indicates the vertical flipping of view image.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for flip view image vertically are as follows:
| Flip view image vertically |
|------------------------------|
| ITKVIEW_VAL_FLIP_Y_DISABLE |
| ITKVIEW_VAL_FLIP_Y_ENABLE |
\~chinese
视图图像最低bit位【RW】
本参数表示视图图像最低bit位。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
View image lowest bit [RW]
This parameter indicates the lowest bit of view image.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
视图图像最高bit位【RW】
本参数表示视图图像最高bit位。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
View image highest bit [RW]
This parameter indicates the highest bit of view image.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
视图图像感兴区域高度【RW】
本参数表示视图图像感兴区域高度。
1. 在创建视图窗口的感兴趣区域时，应先设置高度和宽度，再设置上边缘坐标和左边缘坐标。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
View image ROI height [RW]
This parameter indicates view image ROI height.
1. When creating ROI of view window, the height and width should be set first, followed by the upper and left
edge coordinates.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
视图图像感兴区域宽度【RW】
本参数表示视图图像感兴区域宽度。
1. 在创建视图窗口的感兴趣区域时，应先设置高度和宽度，再设置上边缘坐标和左边缘坐标。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
View image ROI width [RW]
This parameter indicates view image ROI width.
1. When creating ROI of view window, the height and width should be set first, followed by the upper and left
edge coordinates.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
视图图像感兴区域左边缘坐标【RW】
本参数表示视图图像感兴区域左边缘坐标。
1. 在创建视图窗口的感兴趣区域时，应先设置高度和宽度，再设置上边缘坐标和左边缘坐标。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
View image ROI left edge coordinates [RW]
This parameter indicates view image ROI left edge coordinates.
1. When creating ROI of view window, the height and width should be set first, followed by the upper and left
edge coordinates.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
视图图像感兴区域上边缘坐标【RW】
本参数表示视图图像感兴区域上边缘坐标。
1. 在创建视图窗口的感兴趣区域时，应先设置高度和宽度，再设置上边缘坐标和左边缘坐标。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
View image ROI upper edge coordinates [RW]
This parameter indicates view image ROI upper edge coordinates.
1. When creating ROI of view window, the height and width should be set first, followed by the upper and left
edge coordinates.
2. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
视图图像放缩方法【RW】
本参数表示视图图像放缩方法。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 视图图像放缩方法可选项如下所示：
| 视图图像放缩方法 |
|---------------------------|
| ITKVIEW_VAL_ZOOM_NN |
| ITKVIEW_VAL_ZOOM_LINEAR |
| ITKVIEW_VAL_ZOOM_CUBIC |
| ITKVIEW_VAL_ZOOM_AREA |
\~english
View image scaling method [RW]
This parameter indicates view image scaling method.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for view image scaling method are as follows:
| View image scaling method |
|---------------------------|
| ITKVIEW_VAL_ZOOM_NN |
| ITKVIEW_VAL_ZOOM_LINEAR |
| ITKVIEW_VAL_ZOOM_CUBIC |
| ITKVIEW_VAL_ZOOM_AREA |
\~chinese
视图图像最大放大倍数【RO】
本参数表示视图图像最大放大倍数。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Maximum magnification of view image [RO]
This parameter indicates the maximum magnification of view image.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
视图图像最小缩小倍数【RO】
本参数表示视图图像最小缩小倍数。
1. 本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Minimum magnification of view image [RO]
This parameter indicates the minimum magnification of view image.
1. The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
视图窗口句柄【RO】
本参数表示视图窗口句柄。
1. 本参数对应的pValue/value为 ITKVIEW 类型数据。
\~english
View window handle [RO]
This parameter indicates view window handle.
1. The corresponding pValue/value of this parameter is ITKVIEW type data.
\~chinese
视图窗口标题【RW】
本参数表示视图窗口标题。
1. 本参数对应的pValue/value为 char[128] 类型数据。
\~english
View window title [RW]
This parameter indicates view window title.
1. The corresponding pValue/value of this parameter is char[128] type data.
\~chinese
视图图像Bayer格式【RW】
本参数表示视图图像Bayer格式。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
2. 视图图像Bayer格式可选项如下所示：
| 视图图像Bayer格式 |
|-----------------------------|
| ITKVIEW_VAL_BAYER_MODE_NI |
| ITKVIEW_VAL_BAYER_MODE_BGGR |
| ITKVIEW_VAL_BAYER_MODE_RGGB |
| ITKVIEW_VAL_BAYER_MODE_GRBG |
| ITKVIEW_VAL_BAYER_MODE_GBRG |
\~english
View image Bayer format [RW]
This parameter indicates view image Bayer format.
1. The corresponding pValue/value of this parameter is uint32_t type data.
2. The options for view image Bayer format are as follows:
| View image Bayer format |
|-----------------------------|
| ITKVIEW_VAL_BAYER_MODE_NI |
| ITKVIEW_VAL_BAYER_MODE_BGGR |
| ITKVIEW_VAL_BAYER_MODE_RGGB |
| ITKVIEW_VAL_BAYER_MODE_GRBG |
| ITKVIEW_VAL_BAYER_MODE_GBRG |
\~chinese
当前视图缓冲区索引【RO】
本参数表示当前视图缓冲区索引。
1. 本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Current view buffer index [RO]
This parameter indicates the current view buffer index.
1. The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
不使能视图图像水平翻转
\~english
Disable horizontal flipping of view image
\~chinese
使能视图图像水平翻转
\~english
Enable horizontal flipping of view image
\~chinese
不使能视图图像垂直翻转
\~english
Disable vertical flipping of view image
\~chinese
使能视图图像垂直翻转
\~english
Enable vertical flipping of view image
\~chinese
最邻近插值算法
\~english
Nearest neighbor interpolation algorithm
\~chinese
线性插值算法
\~english
Linear interpolation algorithm
\~chinese
立方插值算法
\~english
Cube interpolation algorithm
\~chinese
像素关系重采样算法
\~english
Pixel relation resampling algorithm
\~chinese
无Bayer排列
\~english
No Bayer arrangement
\~chinese
Bayer格式BGGR排列
\~english
Bayer format BGGR arrangement
\~chinese
Bayer格式RGGB排列
\~english
Bayer format RGGB arrangement
\~chinese
Bayer格式GBRG排列
\~english
Bayer格式GBRG排列
\~chinese
Bayer格式GRBG排列
\~english
Bayer格式GRBG排列
\~chinese
\~english
\~chinese
以只读方式打开文件
\~english
Open files in read only mode
\~chinese
以只写方式打开文件
\~english
Open files in write only mode
\~chinese
打开存在的文件
\~english
Open existing files
\~chinese
创建新文件
\~english
Create new file
\~chinese
创建新文件，若当前文件已存在则打开当前文件
\~english
Create a new file, and if the current file already exists, open it
\~chinese
打开文件，若当前文件不存在则创建新文件
\~english
Open the file and create a new file if the current file does not exist
\~chinese
追加打开件
\~english
Addend open files
\~chinese 目录中的只读文件 \~english Read only files in the directory
\~chinese目录中的隐藏文件 \~english Hidden files in the directory
\~chinese 目录中的系统文件 \~english System files in the directory
\~chinese 目录中的目录文件 \~english Directory files in the directory
\~chinese 目录中的实现文件 \~english Achievement files in the directory
\~chinese
\~english
\~chinese 最大支持的设备个数 \~english The maximum number of supported devices
\~chinese ITKDEV_INFO结构体中字段固定长度64字节 \~english Fixed length of fields in ITKDEV_INFO structure is 64 bytes
\~chinese ITKGIGEDEV_INFO结构体中字段长度32字节 \~english Fixed length of fields in ITKGIGEDEV_INFO structure is 32 bytes
\~chinese ITKGIGEDEV_INFO结构体中字段长度64字节 \~english Fixed length of fields in ITKGIGEDEV_INFO structure is 64 bytes
\~chinese ITKGIGEDEV_INFO结构体中字段长度128字节 \~english Fixed length of fields in ITKGIGEDEV_INFO structure is 128 bytes
\~chinese ITKGIGEDEV_INFO结构体中字段长度256字节 \~english Fixed length of fields in ITKGIGEDEV_INFO structure is 256 bytes
\~chinese 结构体中字段长度512字节 \~english Fixed length of fields in structure is 512 bytes
\~chinese
IKapC库头文件(已抛弃接口)
\~english
IKapC library header(Deprecated API)
\~chinese
缓冲区图像深度【RO】
1. 本参数无法设置，数值由缓冲区像素格式 ITKBUFFER_PRM_FORMAT 决定。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
Deprecated: 可能在后续版本中移除，请使用 ITKBUFFER_PRM_PIXEL_BITS 代替。
\~english
Buffer image depth [RO]
1. This parameter cannot be set, the value is determined by buffer pixel format ITKBUFFER_PRM_FORMAT .
2. The corresponding pValue/value of this parameter is uint32_t type data.
Deprecated: May be removed in future versions, please use ITKBUFFER_PRM_IMAGE_BITS instead.
\~chinese
缓冲区通道深度【RO】
1. 本参数无法设置，数值由缓冲区像素格式 ITKBUFFER_PRM_FORMAT 决定。
2. 本参数对应的pValue/value为 uint32_t 类型数据。
Deprecated: 可能在后续版本中移除，请使用 ITKBUFFER_PRM_CHANNEL_BITS 代替。
\~english
Buffer channel depth [RO]
1. This parameter cannot be set, the value is determined by buffer pixel format ITKBUFFER_PRM_FORMAT .
2. The corresponding pValue/value of this parameter is uint32_t type data.
Deprecated: May be removed in future versions, please use ITKBUFFER_PRM_CHANNEL_BITS instead.
\~chinese
单个像素深度
Deprecated: 可能在后续版本中移除，请使用 ITKBUFFER_FORMAT_PIXEL_BITS 代替
\~english
Single pixel size
Deprecated: May be removed in future versions, please use ITKBUFFER_FORMAT_PIXEL_BITS instead.
\~chinese
单个通道深度
Deprecated: 可能在后续版本中移除，请使用 ITKBUFFER_FORMAT_CHANNEL_BITS 代替
\~english
Single channel size
Deprecated: May be removed in future versions, please use ITKBUFFER_FORMAT_CHANNEL_BITS instead.
\~chinese
当前缓冲区句柄【RO】
本参数表示当前缓冲区句柄。
1. 本参数对应的pValue/value为 ITKBUFFER 类型数据。
Deprecated: 该参数已弃用，请使用 ItkStreamGetCurrentBuffer 代替。
\~english
Handle of current buffer [RO]
This parameter indicates handle of current buffer.
1. The corresponding pValue/value of this parameter is ITKBUFFER type data.
Deprecated: This parameter is obsolete, please use ItkStreamGetCurrentBuffer instead.
\~chinese
黑白压缩8bit
灰度8bit压缩图像数据。
\~english
Monochrome packed 8bit
Grayscale 8bit packed image data.
\~chinese
RGB彩色压缩8bit
彩色8bit压缩图像，像素值按照RGB顺序在内存中排列。
\~english
RGB color packed 8bit
Color 8bit packed image data, pixel values are arranged in memory in RGB order.
\~chinese
BGR彩色压缩8bit
彩色8bit压缩图像，像素值按照BGR顺序在内存中排列。
\~english
BGR color packed 8bit
Color 8bit packed image data, pixel values are arranged in memory in BGR order.
\~chinese Bayer转换itek_v4方法 \~english Bayer conversion itek_v4 method
\~chinese
帧触发信号忽略回调事件
本事件在帧触发信号忽略时触发,通过"FrameTriggerIgnored"注册。
\~english
Frame trigger signal ignores callback event
This event is triggered when the frame trigger signal is ignored, registered by "FrameTriggerIgnored".
\~chinese
行触发信号忽略回调事件
本事件在行触发信号忽略时触发,通过"LineTriggerIgnored"注册。
\~english
Line trigger signal ignores callback event
This event is triggered when the line trigger signal is ignored, registered by "LineTriggerIgnored".
\~chinese
帧触发采集回调事件
本事件在帧触发采集时触发,通过"FrameTrigger"注册。
\~english
Frame trigger acquisition callback event
This event is triggered during frame trigger acquisition, registered by "FrameTrigger".
\~chinese
\~english
\~chinese
事件类型【RO】
本参数对应的pValue/value为 uint32_t 类型数据。
\~english
Event type [RO]
The corresponding pValue/value of this parameter is uint32_t type data.
\~chinese
特征名称【RO】
本参数对应的pValue/value为 char[128] 类型数据。
\~english
Feature Name [RO]
The corresponding pValue/value of this parameter is char[128] type data.
\~chinese
主机时间戳【RO】
本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Host timestamp [RO]
The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
块索引【RO】
本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Block ID [RO]
The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
时间戳【RO】
本参数对应的pValue/value为 uint64_t 类型数据。
\~english
Timestamp [RO]
The corresponding pValue/value of this parameter is uint64_t type data.
\~chinese
事件数据【RO】
本参数对应的pValue/value为 char[256] 类型数据。
\~english
Data of event info [RO]
The corresponding pValue/value of this parameter is char[256] type data.
\~chinese
负载类型
\~english
paylaod type
\~chinese 相机图像模式 \~english Camera image mode
\~chinese U3V相机Chunk模式1 \~english U3V camera chunk mode
\~chinese U3V相机Chunk模式2 \~english GV camera chunk mode
\~chinese GV相机Chunk模式 \~english GV camera chunk mode
This method is deprecated. Use instead.
This method may still work, but it will be removed in future versions.
This method is deprecated. Use instead.
This method may still work, but it will be removed in future versions.
This method is deprecated. Use instead.
This method may still work, but it will be removed in future versions.
Convert Bayer Image Parsing Mode From IKap to IKapC
Get parameter from an event info.
\~chinese
接口模块列表
\~english
Manager module list
\~chinese CL设备 \~english CL device
\~chinese GV设备 \~english GV device
\~chinese CXP设备 \~english CXP device
\~chinese USB设备 \~english USB device
\~chinese XGV设备 \~english XGV device
\~chinese PCIe设备 \~english PCIe device
\~chinese GenTL设备 \~english GenTL device
\~chinese VIRTUAL设备 \~english VIRTUAL device
\~chinese
\~english
\~chinese
\~english
\~chinese
数据类型未定义
\~english
Data type undefined
\~chinese
32位整数类型
\~english
32bit integer type
\~chinese
64位整数类型
\~english
64bit integer type
\~chinese
32位浮点数类型
\~english
32bit floating type
\~chinese
64位浮点数类型
\~english
64bit floating type
\~chinese
布尔数据类型
\~english
Boolean data type
\~chinese
枚举数据类型
\~english
Enumeration data type
\~chinese
字符串数据类型
\~english
String data type
\~chinese
命令数据类型
\~english
Command data type
\~chinese
类别类型
\~english
Category type
\~chinese
寄存器类型
\~english
Register type
\~chinese
\~english
\~chinese
访问模式未定义
\~english
Access mode undefined
\~chinese
读写访问模式
\~english
Read write access mode
\~chinese
只读访问模式
\~english
Read only access mode
\~chinese
只写访问模式
\~english
Write only access mode
\~chinese
该特征未实现，无法访问
\~english
This feature is not implemented and cannot be accessed
\~chinese
该特征当前状态下不可用，无法访问
\~english
This feature is currently unavailable and cannot be accessed
\~chinese
\~english
\~chinese
命名空间未定义
\~english
Namespace undefined
\~chinese
自定义命名空间
\~english
Custom namespace
\~chinese
标准命名空间
\~english
Standard namespace
\~chinese
\~english
\~chinese
方式未定义
\~english
Representation undefined
\~chinese
线性
\~english
Linear
\~chinese
对数
\~english
Logarithm
\~chinese
布尔型
\~english
Boolean type
\~chinese
十进制数
\~english
Decimal number
\~chinese
十六进制数
\~english
Hexadecimal number
\~chinese
IPV4地址
\~english
IPV4 address
\~chinese
物理地址
\~english
Physical address
\~chinese
\~english
\~chinese
可视性未定义
\~english
Visibility undefined
\~chinese
初学者级别
\~english
Beginner level
\~chinese
专家级别
\~english
Expert level
\~chinese
大师级别
\~english
Master level
\~chinese
特征不可见
\~english
Feature invisible
\~chinese
\~english
\~chinese
不写入缓存
\~english
Not written to cache
\~chinese
写入数值的同时写入缓存
\~english
Write the value into the cache when write it
\~chinese
仅将读取的数值写入缓存
\~english
Only the read values are written to the cache
\~chinese
缓存模式未定义
\~english
The cache mode is undefined
\~chinese
负载类型
\~english
paylaod type
\~chinese 相机图像模式 \~english Camera image mode
\~chinese U3V相机Chunk模式 \~english U3V camera chunk mode
\~chinese GV相机Chunk模式 \~english GV camera chunk mode
\~chinese 原始数据模式 \~english Raw data mode
\~chinese 文件数据模式 \~english File data mode
\~chinese 多part模式 \~english Multiple parts mode
\~chinese GENDC模式 \~english GENDC mode
\~chinese 设备特殊模式 \~english Device specific mode
\~chinese
\~english
\~chinese 未定义的录像格式，默认为AVI格式 \~english Undefined Recode Format Type，default: AVI Recode Format
\~chinese AVI录像格式 \~english AVI Recode Format Type
\~chinese MP4录像格式 \~english MP4 Recode Format Type
\~chinese
\~english
\~chinese
相机设备句柄
\~english
Camera device handle
\~chinese
采集卡设备句柄
\~english
Frame grabber device handle
\~chinese
相机特征句柄
\~english
Camera feature handle
\~chinese
事件信息句柄
\~english
Event information handle
\~chinese
数据流句柄
\~english
Data stream handle
\~chinese
缓冲区句柄
\~english
Buffer handle
\~chinese
视图句柄
\~english
View handle
\~chinese
文件句柄
\~english
File handle
\~chinese
目录句柄
\~english
Directory handle
\~chinese
相机设备基本信息结构体
\~english
Basic information structure of camera device
\~chinese 用于识别设备的唯一名称 \~english Unique name used to identify the device
\~chinese 用户界面显示的设备名称 \~english Device name displayed on user interface
\~chinese 设备生产厂商 \~english Device manufacturer
\~chinese 设备模型名称 \~english Device model name
\~chinese 设备序列号 \~english Device serial number
\~chinese 设备传输层类型 \~english Device transmission layer type
\~chinese 设备固件版本 \~english Device firmware version
\~chinese 用户自定义名称 \~english User defined name
\~chinese
千兆网相机设备专有信息结构体
\~english
Gigabit network camera device specific information structure
\~chinese 设备MAC地址 \~english Device MAC address
\~chinese 设备IP地址 \~english Device IP address
\~chinese 设备子网掩码 \~english Device subnet mask
\~chinese 设备默认网关 \~english Device default gateway
\~chinese 通讯主机MAC地址 \~english Communication host MAC address
\~chinese 通讯主机IP地址 \~english Communication host IP address
\~chinese 通讯主机子网掩码 \~english Communication host subnet mask
\~chinese 通讯主机默认网关 \~english Default gateway for communication host
\~chinese 通讯主机网卡名称 \~english Name of communication host network card
\~chinese 通讯主机网卡详细描述 \~english Detailed description of communication host network card
\~chinese 通讯主机网卡速度 \~english Communication host network card speed
\~chinese 预留字段 \~english Reserved field
\~chinese
Camera Link相机设备专有信息结构体
\~english
Camera Link camera device specific information structure
\~chinese 主接口类型 \~english Main interface type
\~chinese 板卡索引 \~english Board index
\~chinese CL设备串口号 \~english CL device serial port number
\~chinese 预留字段 \~english Reserved field
\~chinese
CoaXPress相机设备专有信息结构体
\~english
CoaXPress camera device specific information structure
\~chinese 板卡索引 \~english Board index
\~chinese 主端口号 \~english Main port
\~chinese 从端口数量 \~english Number of slave ports
\~chinese 从端口号 \~english Slave port index
\~chinese 相机ID \~english Camera ID
\~chinese 拓扑连接 \~english Topological connection
\~chinese 预留字段 \~english Reserved field
\~chinese
USB30相机设备专有信息结构体
\~english
USB30 camera device specific information structure
\~chinese 相机VID \~english Camera VID
\~chinese 相机PID \~english Camera PID
\~chinese USB连接版本 \~english USB connection version
\~chinese 预留字段 \~english Reserved field
\~chinese
GigEVision Board设备专有信息结构体
\~english
GigEVision Board device specific information structure
\~chinese 板卡索引 \~english Board index
\~chinese 主端口号 \~english Main port
\~chinese MAC地址 \~english MAC address
\~chinese IP地址 \~english IP address
\~chinese 子网掩码 \~english Subnet mask
\~chinese 默认网关 \~english Default gateway
\~chinese 从端口数量 \~english Number of slave ports
\~chinese 从端口号 \~english Slave port index
\~chinese 有效像素个数 \~english Effective number of pixels
\~chinese 预留字段 \~english Reserved field
\~chinese
采集卡设备专有信息结构体
\~english
Frame grabber Board device specific information structure
\~chinese 用于标识的设备名称 \~english Device name used for identification
\~chinese 预留字段 \~english Reserved field
\~chinese
文件专有信息结构体
\~english
File specific information structure
\~chinese 文件大小 \~english File size
\~chinese 文件属性 \~english File attribution
\~chinese 文件名称 \~english File name
\~chinese
批量缓冲区专有信息结构体
\~english
Batch buffer specific information structure
\~chinese 区块ID \~english Block ID
\~chinese 已完成行数 \~english Completed lines
\~chinese 重传包数 \~english Resend packet count
\~chinese 丢包数 \~english Lost packet count
\~chinese 预留字段 \~english Reserved field
\~chinese
特征基本信息结构体
\~english
Basic information structure of feature
\~chinese 是否可以被输出到文件 \~english Indicate whether it is streamable
\~chinese 是否被弃用 \~english Indicate whether it is deprecated
\~chinese 是否是选择器 \~english Indicate whether it is selector
\~chinese 命名空间 \~english Namespace \~
\~chinese 特征类型 \~english Feature type \~
\~chinese 可视级别 \~english Visibilty \~
\~chinese 表现方式 \~english Representation \~
\~chinese 缓存模式 \~english Cacheing mode \~
\~chinese 枚举特征的枚举个数 \~english Enum Count of enum feature.
\~chinese 预留 \~english Reserved
\~chinese 特征字节数 \~english Feature bytes
\~chinese 轮询时间 \~english Polling time suggested
\~chinese 单位 \~english Unit
\~chinese 事件ID \~english Event ID
\~chinese 名字 \~english Name
\~chinese 所属目录 \~english Category
\~chinese 显示名 \~english DisplayName
\~chinese 提示信息 \~english Tooltip
\~chinese 描述 \~english Description
\~chinese 预留 \~english Reserved
\~chinese
Int64特征信息结构体
\~english
Information structure of int64 feature
\~chinese 最小值 \~english Min
\~chinese 最大值 \~english Max
\~chinese 步距 \~english Inc
\~chinese
Double特征信息结构体
\~english
Information structure of double feature
\~chinese 最小值 \~english Min
\~chinese 最大值 \~english Max
\~chinese 步距 \~english Inc
\~chinese 精度 \~english Precision
\~chinese 显示方式 \~english DisplayNotation
\~chinese
Enum entry特征信息结构体
\~english
Information structure of enum entry feature
\~chinese 整数值 \~english Int value
\~chinese 访问权限 \~english Access mode
\~chinese 字符串值 \~english String value
\~chinese 显示名 \~english Display name
\~chinese 提示信息 \~english Tooltip
\~chinese 描述信息 \~english Description
\~chinese
缓冲区信息结构体
\~english
Information structure of buffer
\~chinese 缓冲区状态 \~english Buffer state
\~chinese 是否有chunkdata \~english Indicate whether buffer has chunk data
\~chinese 是否需要使用ItkBufferConvert自动转化 \~english Indicate whether buffer it need use ItkBufferConvert to auto convert.
\~chinese 缓冲区负载格式 \~english Buffer payload type
\~chinese 预留 \~english Reserved
\~chinese 缓冲区地址，仅在图像大小和缓冲区大小不一致时使用 \~english Buffer address, only used when image size and buffer size are not consistent
\~chinese 缓冲区图像地址 \~english Image address in buffer
\~chinese 缓冲区当前采集完成的图像行数 \~english The current number of lines grabbed in image.
\~chinese 缓冲区当前采集完成的图像大小 \~english The current valid image size grabbed in buffer.
\~chinese 缓冲区宽度 \~english Buffer width
\~chinese 缓冲区高度 \~english Buffer height
\~chinese 缓冲区数据格式 \~english Buffer data format
\~chinese 缓冲区像素总深度 \~english Buffer pixel total depth
\~chinese 缓冲区图像数据大小 \~english Buffer image size
\~chinese 缓冲区总大小，仅在图像大小和缓冲区大小不一致时使用 \~english Buffer total size, only used when image size and buffer size are not consistent
\~chinese 缓冲区ID \~english Block ID
\~chinese 缓冲区错误原因 \~english Reason for buffer error
\~chinese 缓冲区状态为满时的时间戳 \~english Timestamp when buffer status is full
\~chinese 当前帧图像重包数 \~english Number of image resend packet in the current frame
\~chinese 当前帧图像丢包数 \~english Current frame image packet loss count
\~chinese 帧开始的相机时间戳 \~english Camera's FrameStartTimestamp
\~chinese 缓冲区负载为MULTI_PART_PAYLOAD_TYPE的情况下的part数量 \~english Part number when PayloadType is MULTI_PART_PAYLOAD_TYPE
\~chinese 当前图像有效宽度 \~english Current frame valid width
\~chinese 预留 \~english Reserved
\~chinese
缓冲区part信息结构体
\~english
Information structure of buffer part
\~chinese 表示缓冲区part的句柄 \~english Handle of buffer part
\~chinese 标识符，用于对属于同一来源的数据部分进行分组 \~english Identifier allowing to group data parts belonging to the same source
\~chinese 标识符，用于对属于同一区域的数据部分进行分组 \~english Identifier allowing to group data parts belonging to the same region
\~chinese 标识符，用于对属于同一目的的数据部分进行分组 \~english Identifier allowing to group data parts belonging to the same purpose
\~chinese 预留 \~english Reserved
\~chinese 缓冲区名字 \~english Buffer name
\~chinese 缓冲区信息 \~english Buffer info
\~chinese
DevEvent info 结构体
\~english
Information structure of enum entry feature
\~chinese 事件名称 \~english Event name
\~chinese 事件触发源,"FeatureValueChanged/MessageChannel"事件下支持 \~english Event trigger source，supported in "FeatureValueChanged/MessageChannel" event
\~chinese 帧号 \~english Block ID
\~chinese Event号 \~english Event ID
\~chinese 事件时间戳 \~english The timestamp of the event
\~chinese Event数据(暂无相机支持) \~english Event data, not support
\~chinese Event数据长度 (暂无相机支持) \~english Event data len, not support
\~chinese 预留 \~english Reserved
\~chinese
录像信息结构体
\~english
Information structure of record
\~chinese 输入数据的像素格式 \~english Pixel Type
\~chinese 图像宽 \~english Width
\~chinese 图像高 \~english Height
\~chinese 帧率fps(大于1/16) \~english The Rate of Frame
\~chinese 录像格式 \~english Recode Format Type
\~chinese 录像文件存放路径 \~english File Path
\~chinese 预留 \~english Reserved