batch_adjust_saturation#

torchaug.batch_transforms.functional.batch_adjust_saturation(imgs, saturation_factor, value_check=False)[source]#

Adjust color saturation of a batch of images.

Parameters:

  • imgs (Tensor) – Batch of images to be adjusted. It is expected to be in [B, …, 1 or 3, H, W] format, where … means it can have an arbitrary number of dimensions.

  • saturation_factor (float | Tensor) – How much to adjust the saturation. Can be 1 or B non-negative elements. 0 will give a black and white image, 1 will give the original image while 2 will enhance the saturation by a factor of 2.

  • value_check (bool, optional) – Bool to perform tensor value check. Might cause slow down on some devices because of synchronization or large batch size.

    Default: False

Return type:

Tensor

Returns:

Saturation adjusted batch of images.