Skip to content

rgb_shift

RGBShift

Bases: ImageOnlyAlbumentation

Randomly shift the channel values for an input RGB image.

Parameters:

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

Key(s) of images to be normalized.

 required
outputs Union[str, Iterable[str]]

Key(s) into which to write the normalized 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
r_shift_limit Union[int, Tuple[int, int]]

range for changing values for the red channel. If r_shift_limit is a single int, the range will be (-r_shift_limit, r_shift_limit).

 20
g_shift_limit Union[int, Tuple[int, int]]

range for changing values for the green channel. If g_shift_limit is a single int, the range will be (-g_shift_limit, g_shift_limit).

 20
b_shift_limit Union[int, Tuple[int, int]]

range for changing values for the blue channel. If b_shift_limit is a single int, the range will be (-b_shift_limit, b_shift_limit).

 20
Image types

uint8, float32

Source code in fastestimator/fastestimator/op/numpyop/univariate/rgb_shift.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 RGBShift(ImageOnlyAlbumentation):
    """Randomly shift the channel values for an input RGB image.

    Args:
        inputs: Key(s) of images to be normalized.
        outputs: Key(s) into which to write the normalized 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".
        r_shift_limit: range for changing values for the red channel. If r_shift_limit is a single int, the range
            will be (-r_shift_limit, r_shift_limit).
        g_shift_limit: range for changing values for the green channel. If g_shift_limit is a single int, the range
            will be (-g_shift_limit, g_shift_limit).
        b_shift_limit: range for changing values for the blue channel. If b_shift_limit is a single int, the range
            will be (-b_shift_limit, b_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,
                 r_shift_limit: Union[int, Tuple[int, int]] = 20,
                 g_shift_limit: Union[int, Tuple[int, int]] = 20,
                 b_shift_limit: Union[int, Tuple[int, int]] = 20):
        super().__init__(
            RGBShiftAlb(r_shift_limit=r_shift_limit,
                        g_shift_limit=g_shift_limit,
                        b_shift_limit=b_shift_limit,
                        always_apply=True),
            inputs=inputs,
            outputs=outputs,
            mode=mode,
            ds_id=ds_id)