`skimage.filters.rank.generic:_handle_input_3D`

source: /dev/scikit-image/src/skimage/filters/rank/generic.py :195

Signature

   def     _handle_input_3D (    image    ,    footprint    =  None   ,    out    =  None   ,    mask    =  None   ,    out_dtype    =  None   ,    pixel_size    =  1   ,    shift_x    =  None   ,    shift_y    =  None   ,    shift_z    =  None     )

Summary

Preprocess and verify input for filters.rank methods.

Parameters

image : 3-D array (integer or float): Input image.
footprint : 3-D array (integer or float), optional: The neighborhood expressed as a 3-D array of 1's and 0's.
out : 3-D array (integer or float), optional: If None, a new array is allocated.
mask : ndarray of dtype (int or float), optional: Mask array that defines (>0) area of the image included in the local neighborhood. If None, the complete image is used (default).
out_dtype : dtype-like, optional: Desired output data type. Default is None, which means we cast output in input dtype.
pixel_size : int, optional: Dimension of each pixel. Default value is 1.
shift_x, shift_y, shift_z : int, optional: Offset added to the footprint center point. Shift is bounded to the footprint size (center must be inside of the given footprint).

Returns

image : 3-D array (np.uint8 or np.uint16)
footprint : 3-D array (np.uint8): The neighborhood expressed as a binary 3-D array.
out : 3-D array (same dtype out_dtype or as input): Output array. The two first dimensions are the spatial ones, the third one is the pixel vector (length 1 by default).
mask : 3-D array (np.uint8): Mask array that defines (>0) area of the image included in the local neighborhood.
n_bins : int: Number of histogram bins.

Aliases

skimage.filters.rank.generic._handle_input_3D