acldvppCrop

Applicability

Function Usage

Description: crops images.

Prototype

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

• First-phase API:

  1	acldvppStatus acldvppCropGetWorkspaceSize(const aclTensor *self, uint32_t top, uint32_t left, uint32_t height, uint32_t width, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)

• Second-phase API:

  1	acldvppStatus acldvppCrop(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

acldvppCropGetWorkspaceSize

• 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).
  • top: upper boundary for cropping.
  • left: left boundary for cropping.
  • height: height for cropping. The value range is [4, 32768].
  • width: width for cropping. The value range is [6, 32768].
  • 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 cropping 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.

acldvppCrop

• 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 acldvppCropGetWorkspaceSize.
  • executor: op executor, which contains the operator computation process and is the same as the executor of the acldvppCropGetWorkspaceSize API.
  • stream: stream for executing a task, which can be a created stream for saving resources or newly created by the aclrtCreateStream API call.
• Returns:

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

Constraints

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