Skip to main content
`Ctrl`+`K`
scipy.ndimage.

# uniform_filter

scipy.ndimage.uniform_filter(input, size=3, output=None, mode='reflect', cval=0.0, origin=0, *, axes=None)

  Multidimensional uniform filter.

  Parameters:
    input array_like

      The input array.

    size int or sequence of ints, optional

      The sizes of the uniform filter are given for each axis as a sequence, or as a single number, in which case the size is equal for all axes.

    output array or dtype, optional

      The array in which to place the output, or the dtype of the returned array. By default an array of the same dtype as input will be created.

    mode str or sequence, optional

      The mode parameter determines how the input array is extended when the filter overlaps a border. By passing a sequence of modes with length equal to the number of dimensions of the input array, different modes can be specified along each axis. Default value is ‘reflect’. The valid values and their behavior is as follows:

      ‘reflect’ (d c b a | a b c d | d c b a)

        The input is extended by reflecting about the edge of the last pixel. This mode is also sometimes referred to as half-sample symmetric.

      ‘constant’ (k k k k | a b c d | k k k k)

        The input is extended by filling all values beyond the edge with the same constant value, defined by the cval parameter.

      ‘nearest’ (a a a a | a b c d | d d d d)

        The input is extended by replicating the last pixel.

      ‘mirror’ (d c b | a b c d | c b a)

        The input is extended by reflecting about the center of the last pixel. This mode is also sometimes referred to as whole-sample symmetric.

      ‘wrap’ (a b c d | a b c d | a b c d)

        The input is extended by wrapping around to the opposite edge.

      For consistency with the interpolation functions, the following mode names can also be used:

      ‘grid-constant’

        This is a synonym for ‘constant’.

      ‘grid-mirror’

        This is a synonym for ‘reflect’.

      ‘grid-wrap’

        This is a synonym for ‘wrap’.

    cval scalar, optional

      Value to fill past edges of input if mode is ‘constant’. Default is 0.0.

    origin int or sequence, optional

      Controls the placement of the filter on the input array’s pixels. A value of 0 (the default) centers the filter over the pixel, with positive values shifting the filter to the left, and negative ones to the right. By passing a sequence of origins with length equal to the number of dimensions of the input array, different shifts can be specified along each axis.

    axes tuple of int or None, optional

      If None, input is filtered along all axes. Otherwise, input is filtered along the specified axes. When axes is specified, any tuples used for size, origin, and/or mode must match the length of axes. The ith entry in any of these tuples corresponds to the ith entry in axes.

  Returns:
    uniform_filter ndarray

      Filtered array. Has the same shape as input.

  Notes

  The multidimensional filter is implemented as a sequence of 1-D uniform filters. The intermediate arrays are stored in the same data type as the output. Therefore, for output types with a limited precision, the results may be imprecise because intermediate results may be stored with insufficient precision.

  The behavior of this function with NaN elements is undefined. To control behavior in the presence of NaNs, consider using `vectorized_filter`.

  Examples

      >>> from scipy import ndimage, datasets
      >>> import matplotlib.pyplot as plt
      >>> fig = plt.figure()
      >>> plt.gray()  # show the filtered result in grayscale
      >>> ax1 = fig.add_subplot(121)  # left side
      >>> ax2 = fig.add_subplot(122)  # right side
      >>> ascent = datasets.ascent()
      >>> result = ndimage.uniform_filter(ascent, size=20)
      >>> ax1.imshow(ascent)
      >>> ax2.imshow(result)
      >>> plt.show()