{ } Raw JSON

bundles / skimage 0.26.1rc0.dev0+git20260530.b607368ff / skimage / filters / edges / sobel

function

skimage.filters.edges:sobel

source: /dev/scikit-image/src/skimage/filters/edges.py :199

Signature

def   sobel ( image mask = None * axis = None mode = reflect cval = 0.0 )

Summary

Find edges in an image using the Sobel filter.

Parameters

image : array

The input image.

mask : array of bool, optional

Clip the output image to this mask. (Values where mask=0 will be set to 0.)

axis : int or sequence of int, optional

Compute the edge filter along this axis. If not provided, the edge magnitude is computed. This is defined as

sobel_mag = np.sqrt(sum([sobel(image, axis=i)**2
                         for i in range(image.ndim)]) / image.ndim)

The magnitude is also computed if axis is a sequence.

mode : str or sequence of str, optional

The boundary mode for the convolution. See scipy.ndimage.convolve for a description of the modes. This can be either a single boundary mode or one boundary mode per axis.

cval : float, optional

When mode is 'constant', this is the constant used in values outside the boundary of the image data.

Returns

output : array of float

The Sobel edge map.

Examples

from skimage import data
from skimage import filters
camera = data.camera()
edges = filters.sobel(camera)

See also

farid
prewitt
scharr
skimage.feature.canny
sobel_h

horizontal and vertical edge detection.

sobel_v

horizontal and vertical edge detection.

Aliases

  • skimage.filters.sobel