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

Merge pull request #1960 from sdsingh/profile_line

Browse Source 
Update docstring for profile_line
This commit is contained in:
Juan Nunez-Iglesias
2016-02-26 18:53:31 +11:00
parent 5457b94132 7a2c80e70f
commit 14852f4578
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/measure/profile.py
+9 -3
View File
@@ -15,7 +15,8 @@ def profile_line(img, src, dst, linewidth=1,
src : 2-tuple of numeric scalar (float or int) src : 2-tuple of numeric scalar (float or int)
The start point of the scan line. The start point of the scan line.
dst : 2-tuple of numeric scalar (float or int) dst : 2-tuple of numeric scalar (float or int)
The end point of the scan line. The end point of the scan line. The destination point is *included*
in the profile, in constrast to standard numpy indexing.
linewidth : int, optional linewidth : int, optional
Width of the scan, perpendicular to the line Width of the scan, perpendicular to the line
order : int in {0, 1, 2, 3, 4, 5}, optional order : int in {0, 1, 2, 3, 4, 5}, optional
@@ -44,11 +45,16 @@ def profile_line(img, src, dst, linewidth=1,
[0, 0, 0, 0, 0, 0]]) [0, 0, 0, 0, 0, 0]])
>>> profile_line(img, (2, 1), (2, 4)) >>> profile_line(img, (2, 1), (2, 4))
array([ 1., 1., 2., 2.]) 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 The destination point is included in the profile, in contrast to
standard numpy indexing. standard numpy indexing.
For example:
>>> profile_line(img, (1, 0), (1, 6)) # The final point is out of bounds
array([ 1., 1., 1., 2., 2., 2., 0.])
>>> profile_line(img, (1, 0), (1, 5)) # This accesses the full first row
array([ 1., 1., 1., 2., 2., 2.])
""" """
perp_lines = _line_profile_coordinates(src, dst, linewidth=linewidth) perp_lines = _line_profile_coordinates(src, dst, linewidth=linewidth)
if img.ndim == 3: if img.ndim == 3: