mindspore.dataset.vision.AdjustSaturation

class mindspore.dataset.vision.AdjustSaturation(saturation_factor)[source]

Adjust the saturation of the input image.

Supports Ascend hardware acceleration and can be enabled through the .device("Ascend") method.

Parameters

saturation_factor (float) – How much to adjust the saturation, must be non negative. 0 gives a black image, 1 gives the original image while 2 increases the saturation by a factor of 2.

Raises

TypeError – If saturation_factor is not of type float.
ValueError – If saturation_factor is less than 0.
RuntimeError – If shape of the input image is not <H, W, C>.
RuntimeError – If channel of the input image is not 3.

Supported Platforms:: CPU Ascend

Examples

>>> import numpy as np
>>> import mindspore.dataset as ds
>>> import mindspore.dataset.vision as vision
>>>
>>> # Use the transform in dataset pipeline mode
>>> data = np.random.randint(0, 255, size=(1, 100, 100, 3)).astype(np.uint8)
>>> numpy_slices_dataset = ds.NumpySlicesDataset(data, ["image"])
>>> transforms_list = [vision.AdjustSaturation(saturation_factor=2.0)]
>>> numpy_slices_dataset = numpy_slices_dataset.map(operations=transforms_list, input_columns=["image"])
>>> for item in numpy_slices_dataset.create_dict_iterator(num_epochs=1, output_numpy=True):
...     print(item["image"].shape, item["image"].dtype)
...     break
(100, 100, 3) uint8
>>>
>>> # Use the transform in eager mode
>>> data = np.array([[0, 1, 2, 3, 4, 5], [0, 1, 2, 3, 4, 5]], dtype=np.uint8).reshape((2, 2, 3))
>>> output = vision.AdjustSaturation(saturation_factor=2.0)(data)
>>> print(output.shape, output.dtype)
(2, 2, 3) uint8

Tutorial Examples:

Illustration of vision transforms

device(device_target='CPU')[source]

Set the device for the current operator execution.

When the device is Ascend, input shape should be limited from [4, 6] to [8192, 4096].

Parameters

device_target (str, optional) – The operator will be executed on this device. Currently supports CPU and Ascend . Default: CPU .

Raises

TypeError – If device_target is not of type str.
ValueError – If device_target is not within the valid set of ['CPU', 'Ascend'].

Supported Platforms:: CPU Ascend

Examples

>>> import numpy as np
>>> import mindspore.dataset as ds
>>> import mindspore.dataset.vision as vision
>>>
>>> # Use the transform in dataset pipeline mode
>>> data = np.random.randint(0, 255, size=(1, 100, 100, 3)).astype(np.uint8)
>>> numpy_slices_dataset = ds.NumpySlicesDataset(data, ["image"])
>>> transforms_list = [vision.AdjustSaturation(2.0).device("Ascend")]
>>> numpy_slices_dataset = numpy_slices_dataset.map(operations=transforms_list, input_columns=["image"])
>>> for item in numpy_slices_dataset.create_dict_iterator(num_epochs=1, output_numpy=True):
...     print(item["image"].shape, item["image"].dtype)
...     break
(100, 100, 3) uint8
>>>
>>> # Use the transform in eager mode
>>> data = np.random.randint(0, 255, size=(100, 100, 3)).astype(np.uint8)
>>> output = vision.AdjustSaturation(saturation_factor=2.0).device("Ascend")(data)
>>> print(output.shape, output.dtype)
(100, 100, 3) uint8

Tutorial Examples:

Illustration of vision transforms