Engee documentation

Padding arrays

Introduction

The padarray() function generates a padded image from an array img and a specification border of the boundary conditions and amount of padding to add.

padarray([T], img, border)

The function returns a new image that is an expansion of the input image, in which additional pixels are derived from the border of the input image using the extrapolation scheme specified by border.

The function supports one, two or multi-dimensional images. You can specify the element type T of the output image.

The Pad type

The type Pad designates the form of padding which should be used to extrapolate pixels beyond the boundary of an image. Instances must set style, a Symbol specifying the boundary conditions of the image.

The symbol must be one of:

  • :replicate (repeat edge values to infinity),

  • :circular (image edges "wrap around"),

  • :symmetric (the image reflects relative to a position between pixels),

  • :reflect (the image reflects relative to the edge itself).

Refer to the documentation of Pad for more details and examples for each option.

The Fill type

The type Fill designates a particular value which will be used to extrapolate pixels beyond the boundary of an image.

Refer to the documentation of Fill for more details and illustrations.

2D Examples

The following examples show the effects of modifying the input array:

Examples with Pad

The command padarray(A, Pad(:replicate, 4, 4)) yields

The command padarray(A, Pad(:circular,4,4)) yields

The command padarray(A, Pad(:symmetric,4,4)) yields

The command padarray(A, Pad(:reflect,4,4)) yields

Examples with Fill

The command padarray(A, Fill(0,(4,4),(4,4))) yields

3D Examples

Each example is based on a multi-dimensional array given by:

Note that each example will yield a new multi-dimensional array of type OffsetArray, where prepended dimensions may be negative or start from zero.

Examples with Pad

The command padarray(A, Pad(:replicate, 1, 1, 1)) gives:

The command padarray(A, Pad(:circular, 1, 1, 1)) gives:

The command padarray(A,Pad(:symmetric, 1, 1, 1)) gives:

The command padarray(A, Pad(:reflect, 1, 1, 1)) gives:

Examples with Fill

The command padarray(A, Fill(0, (1, 1, 1))) gives:

BorderArray

BorderArray(inner::AbstractArray, border::AbstractBorder) <: AbstractArray

Construct a thin wrapper around the array inner, with given border. No data is copied in the constructor. Instead, border values are computed on the fly in getindex calls.

Useful for stencil computations.