View source on GitHub

Labels the connected components in a batch of images.

A component is a set of pixels in a single input image, which are all adjacent and all have the same non-zero value. The components using a squared connectivity of one (all True entries are joined with their neighbors above, below, left, and right). Components across all images have consecutive ids 1 through n. Components are labeled according to the first pixel of the component appearing in row-major order (lexicographic order by image_index_in_batch, row, col). Zero entries all have an output id of 0.

This op is equivalent with scipy.ndimage.measurements.label on a 2D array with the default structuring element (which is the connectivity used here).

images A 2D (H, W) or 3D (N, H, W) Tensor of boolean image(s).

Components with the same shape as images. False entries in images have value 0, and all True entries map to a component id > 0.

TypeError if images is not 2D or 3D.