← Back to all transforms
OverlayElements
Description
Apply overlay elements such as images and masks onto an input image. This transformation can be used to add various objects (e.g., stickers, logos) to images with optional masks and bounding boxes for better placement control. Args: metadata_key (str): Additional target key for metadata. Default `overlay_metadata`. p (float): Probability of applying the transformation. Default: 0.5. Possible Metadata Fields: - image (np.ndarray): The overlay image to be applied. This is a required field. - bbox (list[int]): The bounding box specifying the region where the overlay should be applied. It should contain four floats: [y_min, x_min, y_max, x_max]. If `label_id` is provided, it should be appended as the fifth element in the bbox. BBox should be in Albumentations format, that is the same as normalized Pascal VOC format [x_min / width, y_min / height, x_max / width, y_max / height] - mask (np.ndarray): An optional mask that defines the non-rectangular region of the overlay image. If not provided, the entire overlay image is used. - mask_id (int): An optional identifier for the mask. If provided, the regions specified by the mask will be labeled with this identifier in the output mask. Targets: image, mask Image types: uint8, float32 Reference: https://github.com/danaaubakirova/doc-augmentation
Parameters
- metadata_key: str (default: 'overlay_metadata')
- p: float (default: 0.5)
Targets
- Image
- Mask
Try it out
ⓘ
Original Image:
Original Image: (733, 484, 3)
Reference Image:
Shape: (721, 480, 3)