albumentations.augmentations.mixing.transforms


Transforms for mixing and overlaying images. This module provides transform classes for image mixing operations, including overlay elements like stickers, logos, or other images onto the input image.

Members

OverlayElementsclass

OverlayElements(
    metadata_key: str = overlay_metadata,
    p: float = 0.5
)

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.

Parameters

NameTypeDefaultDescription
metadata_keystroverlay_metadataAdditional target key for metadata. Default `overlay_metadata`.
pfloat0.5Probability of applying the transformation. Default: 0.5.