acldvppCrop

Applicability

Product

Supported

Atlas 350 Accelerator Card

Atlas A3 training product/Atlas A3 inference product

Atlas A2 training product/Atlas A2 inference product

Atlas 200I/500 A2 inference product

Atlas inference product

Atlas training product

Description

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. Call aclCreateTensor to create data of the aclTensor type (stored on the device). The data type of the input tensor can be UINT8 or FLOAT, and the format can be NCHW or NHWC. Discontinuous tensors are not supported, in addition, N can be 1 or empty, and C can be 1 or 3 (1 indicates the input GRAY image, and 3 indicates the 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: operator output tensor. Call aclCreateTensor to create data of the aclTensor type (stored on the device). The data type of the output tensor can be UINT8 or FLOAT, and the format can be NCHW or NHWC. Discontinuous tensors are not supported, the value of N can only be 1, and the value of C can be 1 or 3 (1 indicates a GRAY image and 3 indicates an RGB image). The values of dataType and Format must be the same as those of self. The sizes of the N axis and C axis in Shape must be the same as those of self, the sizes of the W axis and H axis in the shape must be the same as the width and height of the cropped image.
    • workspaceSize: size of the workspace to be allocated on the device.
    • executor: operator executor, containing the operator computation process.
  • Returns:

    The status code acldvppStatus is returned. For details, see acldvpp Return Codes.

acldvppCrop

  • Parameters:
    • workspace: The aclrtMalloc API needs to be called to allocate the device memory. The memory size is workspaceSize. The memory address output by the aclrtMalloc API is passed here.
    • 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 the task. You can reuse the created stream to save resources or call aclrtCreateStream to create a stream, and then pass the stream as an input parameter.
  • Returns

    The status code acldvppStatus is returned. For details, see acldvpp Return Codes.

Constraints

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