vpc_filter2d

Applicability

Product	Supported (√/x)
Atlas A3 training products/Atlas A3 inference products	√
Atlas A2 training products/Atlas A2 inference products	√
Atlas training products	x
Atlas inference products	x
Atlas 200I/500 A2 inference products	√

Function Usage

Performs 2D convolutional filtering on the input image.

Prototype

C Prototype

hi_s32 hi_mpi_vpc_filter2d(hi_vpc_chn chn, const hi_filter_2d_param* filter_2d_param, hi_u32 *task_id, hi_s32 milli_sec)

Python Function

task_id, ret = acl.himpi.vpc_filter2d(chn, filter_2d_param, milli_sec)

Parameter Description

Parameter	Description
chn	Int, channel ID for image processing. Atlas A2 training products/Atlas A2 inference products: The value range of this parameter is [0, 256). The maximum number of channels is 256. Atlas 200I/500 A2 inference products: The value range of this parameter is [0, 128). The maximum number of channels is 128. Atlas A3 training products/Atlas A3 inference products: The value range of this parameter is [0, 256). The maximum number of channels is 256.
filter_2d_param	Dict, 2D convolutional filtering information dictionary. For details, see hi_filter_2d_param.
milli_sec	Int, timeout interval, in milliseconds. -1: blocking mode. 0: non-blocking mode. > 0: timeout interval (timeout mode). The timeout interval varies with the operating system. The deviation is generally within a time slice of an operating system. For example, if the time slice of an operating system is 4 ms and the value of milli_sec is set to 1, the actual timeout interval ranges from 1 ms to 5 ms. When the CPU load is high, the timeout interval may fluctuate.

Parameter

Description

chn

Int, channel ID for image processing.

Atlas A2 training products/Atlas A2 inference products: The value range of this parameter is [0, 256). The maximum number of channels is 256.
Atlas 200I/500 A2 inference products: The value range of this parameter is [0, 128). The maximum number of channels is 128.
Atlas A3 training products/Atlas A3 inference products: The value range of this parameter is [0, 256). The maximum number of channels is 256.

filter_2d_param

Dict, 2D convolutional filtering information dictionary. For details, see hi_filter_2d_param.

milli_sec

Int, timeout interval, in milliseconds.

-1: blocking mode.
0: non-blocking mode.
> 0: timeout interval (timeout mode). The timeout interval varies with the operating system. The deviation is generally within a time slice of an operating system. For example, if the time slice of an operating system is 4 ms and the value of milli_sec is set to 1, the actual timeout interval ranges from 1 ms to 5 ms. When the CPU load is high, the timeout interval may fluctuate.

Return Value Description

Return Value	Description
task_id	Int, task ID, used to identify a task.
ret	Int, error code. 0: success. Other values: failures. For details, see VPC Return Codes.

Restrictions

Version	Restriction
Atlas 200I/500 A2 inference products	The resolution of the input and output images ranges from 10 x 6 to 4096 x 8192. The resolution of the input image is the same as that of the output image. The following input image formats are supported (the output image format is the same as the input image format): HI_PIXEL_FORMAT_YUV_400 = 0, // YUV400 8bit HI_PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1, // YUV420SP NV12 8bit HI_PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2, // YUV420SP NV21 8bit HI_PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3, // YUV422SP 8bit HI_PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4, // YVU422SP 8bit HI_PIXEL_FORMAT_YUYV_PACKED_422 = 7, // YUV422Packed YUYV 8bit HI_PIXEL_FORMAT_YVYU_PACKED_422 = 9, // YUV422Packed YVYU 8bit HI_PIXEL_FORMAT_YUV_PACKED_444 = 11, // YUV444 Package 8bit HI_PIXEL_FORMAT_RGB_888 = 12, // RGB888 HI_PIXEL_FORMAT_BGR_888 = 13, // BGR888 HI_PIXEL_FORMAT_YVU_PACKED_444 = 58, // YVU444 Package 8bit HI_PIXEL_FORMAT_RGB_888_PLANAR = 69, // RGB888 Planar HI_PIXEL_FORMAT_BGR_888_PLANAR = 70, // BGR888 Planar The implementation principle is the same as that of OpenCV. The floating-to-fixed number conversion is different, and the accuracy cannot be exactly same. Due to restrictions on downsampling of YUV images, when the output image format is YUV420SP or YUV422SP, you are advised to set the border making type to border replication mode, to avoid abnormal data on the output image edge.
Atlas A2 training products/Atlas A2 inference products Atlas A3 training products/Atlas A3 inference products	The resolution of the input and output images ranges from 10 x 6 to 4096 x 8192. The resolution of the input image is the same as that of the output image. The following input image formats are supported (the output image format is the same as the input image format): HI_PIXEL_FORMAT_YUV_400 = 0, // YUV400 8bit HI_PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1, // YUV420SP NV12 8bit HI_PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2, // YUV420SP NV21 8bit HI_PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3, // YUV422SP 8bit HI_PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4, // YVU422SP 8bit HI_PIXEL_FORMAT_YUYV_PACKED_422 = 7, // YUV422Packed YUYV 8bit HI_PIXEL_FORMAT_YVYU_PACKED_422 = 9, // YUV422Packed YVYU 8bit HI_PIXEL_FORMAT_YUV_PACKED_444 = 11, // YUV444 Package 8bit HI_PIXEL_FORMAT_RGB_888 = 12, // RGB888 HI_PIXEL_FORMAT_BGR_888 = 13, // BGR888 HI_PIXEL_FORMAT_YVU_PACKED_444 = 58, // YVU444 Package 8bit HI_PIXEL_FORMAT_RGB_888_PLANAR = 69, // RGB888 Planar HI_PIXEL_FORMAT_BGR_888_PLANAR = 70, // BGR888 Planar HI_PIXEL_FORMAT_YUV400_FP32 = 138, // YUV400 Package. Each pixel is represented by a float32 number. HI_PIXEL_FORMAT_RGB_888_PLANAR_FP32 = 1006,// RGB888 Planar. Each pixel is represented by a float32 number. HI_PIXEL_FORMAT_BGR_888_PLANAR_FP32 = 1007,// BGR888 Planar. Each pixel is represented by a float32 number. HI_PIXEL_FORMAT_RGB_888_FP32 = 1012, // RGB888 Package. Each pixel is represented by a float32 number. HI_PIXEL_FORMAT_BGR_888_FP32 = 1013, // BGR888 Package. Each pixel is represented by a float32 number. Due to restrictions on downsampling of YUV images, when the output image format is YUV420SP or YUV422SP, you are advised to set the border making type to border replication mode, to avoid abnormal data on the output image edge.

Version

Restriction

Atlas 200I/500 A2 inference products

The resolution of the input and output images ranges from 10 x 6 to 4096 x 8192. The resolution of the input image is the same as that of the output image.

The following input image formats are supported (the output image format is the same as the input image format):

HI_PIXEL_FORMAT_YUV_400 = 0,               // YUV400 8bit
HI_PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1,    // YUV420SP NV12 8bit   
HI_PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2,    // YUV420SP NV21 8bit 
HI_PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3,    // YUV422SP 8bit
HI_PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4,    // YVU422SP 8bit
HI_PIXEL_FORMAT_YUYV_PACKED_422 = 7,       // YUV422Packed YUYV 8bit
HI_PIXEL_FORMAT_YVYU_PACKED_422 = 9,       // YUV422Packed YVYU 8bit
HI_PIXEL_FORMAT_YUV_PACKED_444 = 11,      // YUV444 Package  8bit
HI_PIXEL_FORMAT_RGB_888 = 12,             // RGB888
HI_PIXEL_FORMAT_BGR_888 = 13,             // BGR888
HI_PIXEL_FORMAT_YVU_PACKED_444 = 58,       // YVU444 Package 8bit
HI_PIXEL_FORMAT_RGB_888_PLANAR = 69,       // RGB888 Planar
HI_PIXEL_FORMAT_BGR_888_PLANAR = 70,       // BGR888 Planar

The implementation principle is the same as that of OpenCV. The floating-to-fixed number conversion is different, and the accuracy cannot be exactly same.
Due to restrictions on downsampling of YUV images, when the output image format is YUV420SP or YUV422SP, you are advised to set the border making type to border replication mode, to avoid abnormal data on the output image edge.

Atlas A2 training products/Atlas A2 inference products

Atlas A3 training products/Atlas A3 inference products

The resolution of the input and output images ranges from 10 x 6 to 4096 x 8192. The resolution of the input image is the same as that of the output image.

The following input image formats are supported (the output image format is the same as the input image format):

HI_PIXEL_FORMAT_YUV_400 = 0,               // YUV400 8bit
HI_PIXEL_FORMAT_YUV_SEMIPLANAR_420 = 1,    // YUV420SP NV12 8bit   
HI_PIXEL_FORMAT_YVU_SEMIPLANAR_420 = 2,    // YUV420SP NV21 8bit 
HI_PIXEL_FORMAT_YUV_SEMIPLANAR_422 = 3,    // YUV422SP 8bit
HI_PIXEL_FORMAT_YVU_SEMIPLANAR_422 = 4,    // YVU422SP 8bit
HI_PIXEL_FORMAT_YUYV_PACKED_422 = 7,       // YUV422Packed YUYV 8bit
HI_PIXEL_FORMAT_YVYU_PACKED_422 = 9,       // YUV422Packed YVYU 8bit
HI_PIXEL_FORMAT_YUV_PACKED_444 = 11,      // YUV444 Package  8bit
HI_PIXEL_FORMAT_RGB_888 = 12,             // RGB888
HI_PIXEL_FORMAT_BGR_888 = 13,             // BGR888
HI_PIXEL_FORMAT_YVU_PACKED_444 = 58,       // YVU444 Package 8bit
HI_PIXEL_FORMAT_RGB_888_PLANAR = 69,       // RGB888 Planar
HI_PIXEL_FORMAT_BGR_888_PLANAR = 70,       // BGR888 Planar
HI_PIXEL_FORMAT_YUV400_FP32 = 138,         // YUV400 Package. Each pixel is represented by a float32 number.
HI_PIXEL_FORMAT_RGB_888_PLANAR_FP32 = 1006,// RGB888 Planar. Each pixel is represented by a float32 number.
HI_PIXEL_FORMAT_BGR_888_PLANAR_FP32 = 1007,// BGR888 Planar. Each pixel is represented by a float32 number.
HI_PIXEL_FORMAT_RGB_888_FP32 = 1012,       // RGB888 Package. Each pixel is represented by a float32 number.
HI_PIXEL_FORMAT_BGR_888_FP32 = 1013,       // BGR888 Package. Each pixel is represented by a float32 number.

Due to restrictions on downsampling of YUV images, when the output image format is YUV420SP or YUV422SP, you are advised to set the border making type to border replication mode, to avoid abnormal data on the output image edge.

Parent topic: VPC APIs