Making the docs more explicit

This commit is contained in:
Ankit Agrawal
2013-08-06 20:36:05 +05:30
parent 54247e3a26
commit 91bb4baaf8
2 changed files with 4 additions and 4 deletions
+3 -3
View File
@@ -16,7 +16,7 @@ def brief(image, keypoints, descriptor_size=256, mode='normal', patch_size=49,
image : 2D ndarray
Input image.
keypoints : (P, 2) ndarray
Array of keypoint locations.
Array of keypoint locations in the format (row, col).
descriptor_size : int
Size of BRIEF descriptor about each keypoint. Sizes 128, 256 and 512
preferred by the authors. Default is 256.
@@ -44,8 +44,8 @@ def brief(image, keypoints, descriptor_size=256, mode='normal', patch_size=49,
(i, j) either being True or False representing the outcome
of Intensity comparison about ith keypoint on jth decision pixel-pair.
keypoints : (Q, 2) ndarray
Keypoints after removing out those that are near border.
Returned only if return_keypoints is True.
Location i.e. (row, col) of keypoints after removing out those that
are near border.
References
----------
+1 -1
View File
@@ -160,7 +160,7 @@ def censure_keypoints(image, n_scales=7, mode='DoB', non_max_threshold=0.15,
Returns
-------
keypoints : (N, 2) array
Location of extracted keypoints.
Location of the extracted keypoints in the (row, col) format.
scale : (N, 1) array
The corresponding scale of the N extracted keypoints.