acldvppAdjustHue

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: adjusts the image hue.
Formula:
out = self + factor

Convert RGB images into Hue, Saturation, Value (HSV) images by adding factor to the H channel, and then convert the HSV images back to RGB images.

Prototype

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

First-phase API:

acldvppStatus acldvppAdjustHueGetWorkspaceSize(const aclTensor* self, float factor, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)

Second-phase API:

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

acldvppAdjustHueGetWorkspaceSize

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 that the input data is in GRAY format, and 3 indicates that the input data is in the sequence of R, G, and B.)
factor: hue adjustment coefficient. The value of dataType can be FLOAT. The value range of factor is [-0.5, 0.5].
out: output tensor of the operator. aclCreateTensor needs to be called to create data of the aclTensor type (stored on the device). The data type of the output tensor can be UINT8 or FLOAT, but cannot be non-contiguous tensors, the values of Format and Shape must be the same as those of self.
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.

acldvppAdjustHue

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 acldvppAdjustHueGetWorkspaceSize.
- executor: op executor, which contains the operator computation process and is the same as the executor of the acldvppAdjustHueGetWorkspaceSize 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 4096 x 8192.

Parent topic: Media Data Processing Operator APIs