Skip to content

grid_distortion

GridDistortion

Bases: MultiVariateAlbumentation

Distort an image within a grid sub-division

Parameters:

Name Type Description Default
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_in Optional[str]

The key of an image to be modified.

 None
mask_in Optional[str]

The key of a mask to be modified (with the same random factors as the image).

 None
masks_in Optional[str]

The key of masks to be modified (with the same random factors as the image).

 None
image_out Optional[str]

The key to write the modified image (defaults to image_in if None).

 None
mask_out Optional[str]

The key to write the modified mask (defaults to mask_in if None).

 None
masks_out Optional[str]

The key to write the modified masks (defaults to masks_in if None).

 None
num_steps int

count of grid cells on each side.

 5
distort_limit Union[float, Tuple[float, float]]

If distort_limit is a single float, the range will be (-distort_limit, distort_limit).

 0.3
interpolation int

Flag that is used to specify the interpolation algorithm. Should be one of: cv2.INTER_NEAREST, cv2.INTER_LINEAR, cv2.INTER_CUBIC, cv2.INTER_AREA, cv2.INTER_LANCZOS4.

 INTER_LINEAR
border_mode int

Flag that is used to specify the pixel extrapolation method. Should be one of: cv2.BORDER_CONSTANT, cv2.BORDER_REPLICATE, cv2.BORDER_REFLECT, cv2.BORDER_WRAP, cv2.BORDER_REFLECT_101.

 BORDER_REFLECT_101
value Union[None, int, float, List[int], List[float]]

Padding value if border_mode is cv2.BORDER_CONSTANT.

 None
mask_value Union[None, int, float, List[int], List[float]]

Padding value if border_mode is cv2.BORDER_CONSTANT applied for masks.

 None
Image types

uint8, float32

Source code in fastestimator/fastestimator/op/numpyop/multivariate/grid_distortion.py 
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@traceable()
class GridDistortion(MultiVariateAlbumentation):
    """Distort an image within a grid sub-division

    Args:
        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_in: The key of an image to be modified.
        mask_in: The key of a mask to be modified (with the same random factors as the image).
        masks_in: The key of masks to be modified (with the same random factors as the image).
        image_out: The key to write the modified image (defaults to `image_in` if None).
        mask_out: The key to write the modified mask (defaults to `mask_in` if None).
        masks_out: The key to write the modified masks (defaults to `masks_in` if None).
        num_steps: count of grid cells on each side.
        distort_limit: If distort_limit is a single float, the range will be (-distort_limit, distort_limit).
        interpolation: Flag that is used to specify the interpolation algorithm. Should be one of:
            cv2.INTER_NEAREST, cv2.INTER_LINEAR, cv2.INTER_CUBIC, cv2.INTER_AREA, cv2.INTER_LANCZOS4.
        border_mode: Flag that is used to specify the pixel extrapolation method. Should be one of:
            cv2.BORDER_CONSTANT, cv2.BORDER_REPLICATE, cv2.BORDER_REFLECT, cv2.BORDER_WRAP, cv2.BORDER_REFLECT_101.
        value: Padding value if border_mode is cv2.BORDER_CONSTANT.
        mask_value: Padding value if border_mode is cv2.BORDER_CONSTANT applied for masks.

    Image types:
        uint8, float32
    """
    def __init__(self,
                 num_steps: int = 5,
                 distort_limit: Union[float, Tuple[float, float]] = 0.3,
                 interpolation: int = cv2.INTER_LINEAR,
                 border_mode: int = cv2.BORDER_REFLECT_101,
                 value: Union[None, int, float, List[int], List[float]] = None,
                 mask_value: Union[None, int, float, List[int], List[float]] = None,
                 mode: Union[None, str, Iterable[str]] = None,
                 ds_id: Union[None, str, Iterable[str]] = None,
                 image_in: Optional[str] = None,
                 mask_in: Optional[str] = None,
                 masks_in: Optional[str] = None,
                 image_out: Optional[str] = None,
                 mask_out: Optional[str] = None,
                 masks_out: Optional[str] = None):
        super().__init__(
            GridDistortionAlb(num_steps=num_steps,
                              distort_limit=distort_limit,
                              interpolation=interpolation,
                              border_mode=border_mode,
                              value=value,
                              mask_value=mask_value,
                              always_apply=True),
            image_in=image_in,
            mask_in=mask_in,
            masks_in=masks_in,
            bbox_in=None,
            keypoints_in=None,
            image_out=image_out,
            mask_out=mask_out,
            masks_out=masks_out,
            bbox_out=None,
            keypoints_out=None,
            bbox_params=None,
            keypoint_params=None,
            mode=mode,
            ds_id=ds_id)