`skimage.filters.rank._percentile:pop_percentile`

source: /dev/scikit-image/src/skimage/filters/rank/_percentile.py :345

Signature

   def     pop_percentile (    image    ,    footprint    ,    out    =  None   ,    mask    =  None   ,    shift_x    =  0   ,    shift_y    =  0   ,    p0    =  0   ,    p1    =  1     )

Summary

Return the local number (population) of pixels.

Extended Summary

The number of pixels is defined as the number of pixels which are included in the footprint and the mask.

Only grayvalues between percentiles [p0, p1] are considered in the filter.

Parameters

image : 2-D array (uint8, uint16): Input image.
footprint : ndarray of shape (m, n): The neighborhood expressed as a 2-D array of 1's and 0's.
out : 2-D array, same dtype as input `image`: If None, a new array is allocated.
mask : ndarray: Mask array that defines (>0) area of the image included in the local neighborhood. If None, the complete image is used (default).
shift_x, shift_y : int: Offset added to the footprint center point. Shift is bounded to the footprint sizes (center must be inside the given footprint).
p0, p1 : float, optional, in interval [0, 1]: Define the [p0, p1] percentile interval to be considered for computing the value.

Returns

out : 2-D array, same dtype as input `image`: Output image.

Aliases

skimage.filters.rank.pop_percentile