Skip to content

random_brightness_contrast

RandomBrightnessContrast

Bases: ImageOnlyAlbumentation

Randomly change the brightness and contrast 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
brightness_limit Union[float, Tuple[float, float]]

Factor range for changing brightness. If limit is a single float, the range will be (-limit, limit).

 0.2
contrast_limit Union[float, Tuple[float, float]]

Factor range for changing contrast. If limit is a single float, the range will be (-limit, limit).

 0.2
brightness_by_max bool

If True adjust contrast by image dtype maximum, else adjust contrast by image mean.

 True
Image types

uint8, float32

Source code in fastestimator/fastestimator/op/numpyop/univariate/random_brightness_contrast.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
@traceable()
class RandomBrightnessContrast(ImageOnlyAlbumentation):
    """Randomly change the brightness and contrast 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".
        brightness_limit: Factor range for changing brightness.
            If limit is a single float, the range will be (-limit, limit).
        contrast_limit: Factor range for changing contrast.
            If limit is a single float, the range will be (-limit, limit).
        brightness_by_max: If True adjust contrast by image dtype maximum, else adjust contrast by image mean.

    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,
                 brightness_limit: Union[float, Tuple[float, float]] = 0.2,
                 contrast_limit: Union[float, Tuple[float, float]] = 0.2,
                 brightness_by_max: bool = True):
        super().__init__(
            RandomBrightnessContrastAlb(brightness_limit=brightness_limit,
                                        contrast_limit=contrast_limit,
                                        brightness_by_max=brightness_by_max,
                                        always_apply=True),
            inputs=inputs,
            outputs=outputs,
            mode=mode,
            ds_id=ds_id)