`skimage.morphology.footprints:octahedron`

source: /dev/scikit-image/src/skimage/morphology/footprints.py :759

Signature

   def     octahedron (    radius    ,    dtype    =  <class 'numpy.uint8'>   ,  * ,     decomposition    =  None     )

Summary

Generates a octahedron-shaped footprint.

Extended Summary

This is the 3D equivalent of a diamond. A pixel is part of the neighborhood (i.e. labeled 1) if the city block/Manhattan distance between it and the center of the neighborhood is no greater than radius.

Parameters

radius : int: The radius of the octahedron-shaped footprint.

Returns

footprint : ndarray or tuple: The footprint where elements of the neighborhood are 1 and 0 otherwise. When decomposition is None, this is just a numpy.ndarray. Otherwise, this will be a tuple whose length is equal to the number of unique structuring elements to apply (see Notes for more detail)

Other Parameters

dtype : dtype-like, optional: The data type of the footprint.
decomposition : {None, 'sequence'}, optional: If None, a single array is returned. For 'sequence', a tuple of smaller footprints is returned. Applying this series of smaller footprints will given an identical result to a single, larger footprint, but with better computational performance. See Notes for more details.

Notes

When decomposition is not None, each element of the footprint tuple is a 2-tuple of the form (ndarray, num_iter) that specifies a footprint array and the number of iterations it is to be applied.

For either binary or grayscale morphology, using decomposition='sequence' was observed to have a performance benefit, with the magnitude of the benefit increasing with increasing footprint size.

Aliases

skimage.morphology.octahedron