Skip to content

random_crop_from_borders

RandomCropFromBorders

Bases: MultiVariateAlbumentation

Crop a random part of the input from borders.

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[Iterable[str]]

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

 None
bbox_in Optional[str]

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

 None
keypoints_in Optional[str]

The key of keypoints 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[Iterable[str]]

The list of keys to write the modified masks (defaults to masks_in if None).

 None
bbox_out Optional[str]

The key to write the modified bounding box(es) (defaults to bbox_in if None).

 None
keypoints_out Optional[str]

The key to write the modified keypoints (defaults to keypoints_in if None).

 None
bbox_params Union[BboxParams, str, None]

Parameters defining the type of bounding box ('coco', 'pascal_voc', 'albumentations' or 'yolo').

 None
keypoint_params Union[KeypointParams, str, None]

Parameters defining the type of keypoints ('xy', 'yx', 'xya', 'xys', 'xyas', 'xysa').

 None
crop_left

Randomly crop left border of image.Float value in the range (0.0, 1.0).

 0.1
crop_right

Randomly crop right border of image.Float value in the range (0.0, 1.0).

 0.1
crop_top

Randomly crop top border of image.Float value in the range (0.0, 1.0).

 0.1
crop_bottom

Randomly crop bottom border of image.Float value in the range (0.0, 1.0).

 0.1
Image types

uint8, float32

Source code in fastestimator/fastestimator/op/numpyop/multivariate/random_crop_from_borders.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
89
90
91
92
@traceable()
class RandomCropFromBorders(MultiVariateAlbumentation):
    """Crop a random part of the input from borders.

    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 list of mask keys to be modified (with the same random factors as the image).
        bbox_in: The key of a bounding box(es) to be modified (with the same random factors as the image).
        keypoints_in: The key of keypoints 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 list of keys to write the modified masks (defaults to `masks_in` if None).
        bbox_out: The key to write the modified bounding box(es) (defaults to `bbox_in` if None).
        keypoints_out: The key to write the modified keypoints (defaults to `keypoints_in` if None).
        bbox_params: Parameters defining the type of bounding box ('coco', 'pascal_voc', 'albumentations' or 'yolo').
        keypoint_params: Parameters defining the type of keypoints ('xy', 'yx', 'xya', 'xys', 'xyas', 'xysa').
        crop_left: Randomly crop left border of image.Float value in the range (0.0, 1.0).
        crop_right: Randomly crop right border of image.Float value in the range (0.0, 1.0).
        crop_top: Randomly crop top border of image.Float value in the range (0.0, 1.0).
        crop_bottom: Randomly crop bottom border of image.Float value in the range (0.0, 1.0).

    Image types:
        uint8, float32
    """
    def __init__(self,
                 crop_left=0.1,
                 crop_right=0.1,
                 crop_top=0.1,
                 crop_bottom=0.1,
                 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[Iterable[str]] = None,
                 bbox_in: Optional[str] = None,
                 keypoints_in: Optional[str] = None,
                 image_out: Optional[str] = None,
                 mask_out: Optional[str] = None,
                 masks_out: Optional[Iterable[str]] = None,
                 bbox_out: Optional[str] = None,
                 keypoints_out: Optional[str] = None,
                 bbox_params: Union[BboxParams, str, None] = None,
                 keypoint_params: Union[KeypointParams, str, None] = None):
        super().__init__(
            RandomCropFromBordersAlb(crop_left=crop_left,
                                     crop_right=crop_right,
                                     crop_top=crop_top,
                                     crop_bottom=crop_bottom,
                                     always_apply=True),
            image_in=image_in,
            mask_in=mask_in,
            masks_in=masks_in,
            bbox_in=bbox_in,
            keypoints_in=keypoints_in,
            image_out=image_out,
            mask_out=mask_out,
            masks_out=masks_out,
            bbox_out=bbox_out,
            keypoints_out=keypoints_out,
            bbox_params=bbox_params,
            keypoint_params=keypoint_params,
            mode=mode,
            ds_id=ds_id)