Skip to content

to_gray

ToGray

Bases: ImageOnlyAlbumentation

Convert an RGB image to grayscale. If the mean pixel value of the result is > 127, the image is inverted.

Parameters:

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

Key(s) of images to be converted to grayscale.

 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
Image types

uint8, float32

Source code in fastestimator/fastestimator/op/numpyop/univariate/to_gray.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@traceable()
class ToGray(ImageOnlyAlbumentation):
    """Convert an RGB image to grayscale. If the mean pixel value of the result is > 127, the image is inverted.

    Args:
        inputs: Key(s) of images to be converted to grayscale.
        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".

    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):
        super().__init__(ToGrayAlb(always_apply=True), inputs=inputs, outputs=outputs, mode=mode, ds_id=ds_id)