Skip to content

hue_saturation_value

HueSaturationValue

Bases: ImageOnlyAlbumentation

Randomly modify the hue, saturation, and value of an image.

Parameters:

Name Type Description Default
inputs Union[str, Iterable[str]]

Key(s) of images to be modified.

 required
outputs Union[str, Iterable[str]]

Key(s) into which to write the modified images.

 required
mode Union[None, str, Iterable[str]]

What mode(s) to execute this Op in. For example, "train", "eval", "test", or "infer". To execute regardless of mode, pass None. To execute in all modes except for a particular one, you can pass an argument like "!infer" or "!train".

 None
ds_id Union[None, str, Iterable[str]]

What dataset id(s) to execute this Op in. To execute regardless of ds_id, pass None. To execute in all ds_ids except for a particular one, you can pass an argument like "!ds1".

 None
hue_shift_limit Union[int, Tuple[int, int]]

Range for changing hue. If hue_shift_limit is a single int, the range will be (-hue_shift_limit, hue_shift_limit).

 20
sat_shift_limit Union[int, Tuple[int, int]]

Range for changing saturation. If sat_shift_limit is a single int, the range will be (-sat_shift_limit, sat_shift_limit).

 30
val_shift_limit Union[int, Tuple[int, int]]

range for changing value. If val_shift_limit is a single int, the range will be (-val_shift_limit, val_shift_limit).

 20
Image types

uint8, float32

Source code in fastestimator/fastestimator/op/numpyop/univariate/hue_saturation_value.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@traceable()
class HueSaturationValue(ImageOnlyAlbumentation):
    """Randomly modify the hue, saturation, and value of an image.

    Args:
        inputs: Key(s) of images to be modified.
        outputs: Key(s) into which to write the modified images.
        mode: What mode(s) to execute this Op in. For example, "train", "eval", "test", or "infer". To execute
            regardless of mode, pass None. To execute in all modes except for a particular one, you can pass an argument
            like "!infer" or "!train".
        ds_id: What dataset id(s) to execute this Op in. To execute regardless of ds_id, pass None. To execute in all
            ds_ids except for a particular one, you can pass an argument like "!ds1".
        hue_shift_limit: Range for changing hue. If hue_shift_limit is a single int, the range will be
            (-hue_shift_limit, hue_shift_limit).
        sat_shift_limit: Range for changing saturation. If sat_shift_limit is a single int, the range will be
            (-sat_shift_limit, sat_shift_limit).
        val_shift_limit: range for changing value. If val_shift_limit is a single int, the range will be
            (-val_shift_limit, val_shift_limit).

    Image types:
        uint8, float32
    """
    def __init__(self,
                 inputs: Union[str, Iterable[str]],
                 outputs: Union[str, Iterable[str]],
                 mode: Union[None, str, Iterable[str]] = None,
                 ds_id: Union[None, str, Iterable[str]] = None,
                 hue_shift_limit: Union[int, Tuple[int, int]] = 20,
                 sat_shift_limit: Union[int, Tuple[int, int]] = 30,
                 val_shift_limit: Union[int, Tuple[int, int]] = 20):
        super().__init__(
            HueSaturationValueAlb(hue_shift_limit=hue_shift_limit,
                                  sat_shift_limit=sat_shift_limit,
                                  val_shift_limit=val_shift_limit,
                                  always_apply=True),
            inputs=inputs,
            outputs=outputs,
            mode=mode,
            ds_id=ds_id)