change doc for indices and remove the unnecessarily tolist() operation

This commit is contained in:
yangzetian
2013-04-02 12:35:11 +08:00
parent f77def35d8
commit afde2b8ab8
2 changed files with 5 additions and 4 deletions
+3 -3
View File
@@ -33,8 +33,8 @@ def peak_local_max(image, min_distance=10, threshold_abs=0, threshold_rel=0.1,
If True, `min_distance` excludes peaks from the border of the image as
well as from each other.
indices : bool
If True, the output will be a matrix representing peak coordinates.
If False, the output will be a boolean matrix shaped as `image.shape`
If True, the output will be an array representing peak coordinates.
If False, the output will be a boolean array shaped as `image.shape`
with peaks present at True elements.
num_peaks : int
Maximum number of peaks. When the number of peaks exceeds `num_peaks`,
@@ -150,6 +150,6 @@ def peak_local_max(image, min_distance=10, threshold_abs=0, threshold_rel=0.1,
if indices is True:
return coordinates
else:
nd_indices = tuple(coordinates.T.tolist())
nd_indices = tuple(coordinates.T)
out[nd_indices] = True
return out
+2 -1
View File
@@ -116,12 +116,13 @@ def test_indices_with_labels():
indices=True, exclude_border=False)
assert (result == np.transpose(expected.nonzero())).all()
def test_ndarray_indices_false():
nd_image = np.zeros((5,5,5))
nd_image[2,2,2] = 1
peaks = peak.peak_local_max(nd_image, min_distance=1, indices=False)
assert (peaks == nd_image.astype(np.bool)).all()
if __name__ == '__main__':
from numpy import testing