wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-07-07 20:46:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docstring for profile_line

Browse Source
This commit is contained in:
Shaun Singh
2016-02-24 16:54:22 -08:00
parent 5457b94132
commit 7f5b9327fa
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/measure/profile.py
+9
View File
@@ -16,6 +16,8 @@ def profile_line(img, src, dst, linewidth=1,
The start point of the scan line.
dst : 2-tuple of numeric scalar (float or int)
The end point of the scan line.
Note: The final destination point is INCLUDED in the profile,
in constrast to standard numpy indexing.
linewidth : int, optional
Width of the scan, perpendicular to the line
order : int in {0, 1, 2, 3, 4, 5}, optional
@@ -44,11 +46,18 @@ def profile_line(img, src, dst, linewidth=1,
[0, 0, 0, 0, 0, 0]])
>>> profile_line(img, (2, 1), (2, 4))
array([ 1., 1., 2., 2.])
>>> profile_line(img, (1, 0), (1, 6), cval=4)
array([ 1., 1., 1., 2., 2., 2., 4.])
Notes
-----
The destination point is included in the profile, in contrast to
standard numpy indexing.
For example:
>>> img = np.array([1,1,2,2])
>>> profile_line(img, (0, 0), (0, 4)) # The final point is out of bounds
>>> profile_line(img, (0, 0), (0, 3)) # This accesses the full first row
"""
perp_lines = _line_profile_coordinates(src, dst, linewidth=linewidth)
if img.ndim == 3: