transform_pad: Pad the given image on all sides with the given "pad" value

View source: R/transforms-generics.R

transform_padR Documentation

Pad the given image on all sides with the given "pad" value

Description

The image can be a Magick Image or a torch Tensor, in which case it is expected to have ⁠[..., H, W]⁠ shape, where ... means an arbitrary number of leading dimensions.

Usage

transform_pad(img, padding, fill = 0, padding_mode = "constant")

Arguments

img

A magick-image, array or torch_tensor.

padding

(integer vector or integer): Padding on each border. If a single integer is provided, this value is used to pad all borders. If an integer vector of length 2 is provided, it gives the padding on left/right and top/bottom respectively. If an integer vector of length 4 is provided, it gives the padding for the left, right, top and bottom borders respectively.

fill

(numeric vector or numeric): Pixel fill value for constant fill. Default is 0. If a numeric vector of length 3, it is used to fill R, G, B channels respectively. This value is only used when the padding_mode is constant. Only integer values are supported for Tensors.

padding_mode

(character): Type of padding. Should be: constant, edge, reflect or symmetric. Default is constant. Mode symmetric is not yet supported for Tensor inputs.

  • constant: pads with a constant value, this value is specified with fill

  • edge: pads with the last value on the edge of the image

  • reflect: pads with reflection of image (without repeating the last value on the edge) padding ⁠[1, 2, 3, 4]⁠ with 2 elements on both sides in reflect mode will result in ⁠[3, 2, 1, 2, 3, 4, 3, 2]⁠

  • symmetric: pads with reflection of image (repeating the last value on the edge) padding ⁠[1, 2, 3, 4]⁠ with 2 elements on both sides in symmetric mode will result in ⁠[2, 1, 1, 2, 3, 4, 4, 3]⁠

See Also

Other unitary_transforms: transform_adjust_brightness(), transform_adjust_contrast(), transform_adjust_gamma(), transform_adjust_hue(), transform_adjust_saturation(), transform_affine(), transform_center_crop(), transform_convert_image_dtype(), transform_crop(), transform_grayscale(), transform_hflip(), transform_linear_transformation(), transform_normalize(), transform_perspective(), transform_resize(), transform_rgb_to_grayscale(), transform_rotate(), transform_to_tensor(), transform_vflip()


torchvision documentation built on Oct. 14, 2026, 1:09 a.m.