rectangle_perimeter(start, end=None, extent=None, shape=None, clip=False)

Parameters

start : tuple

Origin point of the inner rectangle, e.g., (row, column) .

end : tuple

End point of the inner rectangle (row, column) . For a 2D matrix, the slice defined by inner the rectangle is [start:(end+1)] . Either end or :None:None:`extent` must be specified.

extent : tuple

The extent (size) of the inner rectangle. E.g., (num_rows, num_cols) . Either end or :None:None:`extent` must be specified. Negative extents are permitted. See rectangle to better understand how they behave.

shape : tuple, optional

Image shape used to determine the maximum bounds of the output coordinates. This is useful for clipping perimeters that exceed the image size. By default, no clipping is done. Must be at least length 2. Only the first two values are used to determine the extent of the input image.

clip : bool, optional

Whether to clip the perimeter to the provided shape. If this is set to True, the drawn figure will always be a closed polygon with all edges visible.

Returns

coords : array of int, shape (2, Npoints)

The coordinates of all pixels in the rectangle.

Generate coordinates of pixels that are exactly around a rectangle.

Examples

This example is valid syntax, but we were not able to check execution

>>> import numpy as np
... from skimage.draw import rectangle_perimeter
... img = np.zeros((5, 6), dtype=np.uint8)
... start = (2, 3)
... end = (3, 4)
... rr, cc = rectangle_perimeter(start, end=end, shape=img.shape)
... img[rr, cc] = 1
... img
array([[0, 0, 0, 0, 0, 0],
       [0, 0, 1, 1, 1, 1],
       [0, 0, 1, 0, 0, 1],
       [0, 0, 1, 0, 0, 1],
       [0, 0, 1, 1, 1, 1]], dtype=uint8)

This example is valid syntax, but we were not able to check execution

>>> img = np.zeros((5, 5), dtype=np.uint8)
... r, c = rectangle_perimeter(start, (10, 10), shape=img.shape, clip=True)
... img[r, c] = 1
... img
array([[0, 0, 0, 0, 0],
       [0, 0, 1, 1, 1],
       [0, 0, 1, 0, 1],
       [0, 0, 1, 0, 1],
       [0, 0, 1, 1, 1]], dtype=uint8)

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

skimage.draw.draw.rectangle_perimeter

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /skimage/draw/draw.py#851
type: <class 'function'>
Commit: