acldvppPad

Applicability

Product

Supported

Atlas A3 training products / Atlas A3 inference products

Atlas A2 training products / Atlas A2 inference products

Atlas 200I/500 A2 inference products

x

Atlas inference products

x

Atlas training products

x

Function Usage

Description: fills boundaries of images.

Prototype

Each operator has two-phase API calls. First, acldvppPadGetWorkspaceSize is called to calculate the required workspace size based on the computation process. Then, acldvppPad is called to perform computation. The two-phase APIs are as follows:

  • First-phase API:
    1
    acldvppStatus acldvppPadGetWorkspaceSize(const aclTensor *self, const aclIntArray* padding, uint32_t paddingMode, const aclFloatArray* fill, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
    
  • Second-phase API:
    1
    acldvppStatus acldvppPad(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
    

acldvppPadGetWorkspaceSize

  • Parameters:
    • self: input tensor of the operator, which is of the aclTensor type created by calling aclCreateTensor (the tensor data is stored on the device). The value of dataType of the input tensor can be UINT8 or FLOAT, the value of Format can be NCHW or NHWC, and non-contiguous tensors are not supported. The value of N can be 1 or left empty, and the value of C can be 1 or 3 (1: input GRAY image; 3: input RGB image).
    • padding: padding width of the borders. This parameter is of the aclIntArray type created by calling aclCreateIntArray, and has a length of 4, indicating the padding width in the left, top, right, and bottom directions. The width range is [0, 2048].
    • paddingMode: padding mode. The options are as follows:
      • 0: CONSTANT, indicating that a constant pad value will be used.
      • 1: EDGE, indicating repeating of the last element. For example, aaaaaa|a*****h|hhhhhhh, where * indicates any image element.
      • 2: REFLECT, indicating mirroring of boundary elements. The mirror does not include boundary elements themselves. For example, cb|abc****fgh|gf, where * indicates any image element.
      • 3: SYMMETRIC, indicating mirroring of boundary elements. The mirror includes boundary elements. For example, ba|abc****fgh|hg, where * indicates any image element.
    • fill: an array with the length of 3, used to set the value to be filled in each channel. This parameter is of the aclFloatArray type created by calling aclCreateFloatArray. This parameter is valid only when paddingMode is set to CONSTANT. If C is set to 1 (indicating a GRAY image), set fill[0]. If C is set to 3 (indicating an RGB image), set fill[0] for color red, fill[1] for color green, and fill[2] for color blue.
    • out: output tensor of the operator, which is of the aclTensor type created by calling aclCreateTensor (the tensor data is stored on the device). The value of dataType of the output tensor can be UINT8 or FLOAT, the value of Format can be NCHW or NHWC, and non-contiguous tensors are not supported. The value of N can only be 1, and the value of C can be 1 or 3 (1: GRAY image; 3: RGB image). The values of dataType and Format must be the same as those of self, the sizes of the C axis and N axis in Shape must be the same as those of self, and the sizes of the W axis and H axis in Shape must be the same as the image width and hight after padding respectively.
    • workspaceSize: size of the workspace to be allocated on the device.
    • executor: operator executor, containing the operator computation process.
  • Returns:

    acldvppStatus status code. For details, see acldvpp Return Codes.

acldvppPad

  • Parameters:
    • workspace: address of the device memory allocated by calling aclrtMalloc. The size of the device memory is specified by workspaceSize.
    • workspaceSize: The value must be the same as that obtained by calling acldvppPadGetWorkspaceSize.
    • executor: op executor, which contains the operator computation process and is the same as the executor of the acldvppPadGetWorkspaceSize API.
    • stream: stream for executing a task, which can be a created stream for saving resources or newly created by calling aclrtCreateStream.
  • Returns:

    acldvppStatus status code. For details, see acldvpp Return Codes.

Constraints

The supported image resolution ranges from 6 x 4 to 32768 x 32768.