pad_by_shape

pad_by_shape#

stimupy.utils.pad_by_shape(img, padding, pad_value=0)#

Pad image by specified amount(s) of pixels

Can specify different amount (before, after) each axis.

Parameters:
  • img (numpy.ndarray) – image-array to be padded

  • padding (int, or Sequence[int, int], or Sequence[Sequence[int, int], ...]) – amount of padding, in pixels, in each direction: ((before_1, after_1), … (before_N, after_N)) unique pad widths for each axis (int,) or int is a shortcut for before = after = pad width for all axes.

  • pad_val (float, optional) – value to pad with, by default 0.0

Returns:

img padded by the specified amount(s)

Return type:

numpy.ndarray