mmcv.image.adjust_hue

mmcv.image.adjust_hue(img: numpy.ndarray, hue_factor: float, backend: Optional[str] = None) → numpy.ndarray

Adjust hue of an image.

The image hue is adjusted by converting the image to HSV and cyclically shifting the intensities in the hue channel (H). The image is then converted back to original image mode.

hue_factor is the amount of shift in H channel and must be in the interval [-0.5, 0.5].

Modified from https://github.com/pytorch/vision/blob/main/torchvision/ transforms/functional.py

Parameters

• img (ndarray) – Image to be adjusted.

• hue_factor (float) – How much to shift the hue channel. Should be in [-0.5, 0.5]. 0.5 and -0.5 give complete reversal of hue channel in HSV space in positive and negative direction respectively. 0 means no shift. Therefore, both -0.5 and 0.5 will give an image with complementary colors while 0 gives the original image.

• backend (str | None) – The image processing backend type. Options are cv2, pillow, None. If backend is None, the global imread_backend specified by mmcv.use_backend() will be used. Defaults to None.

Returns

Hue adjusted image.

Return type

ndarray