Skip to content

Commit

Permalink
Fix documentation errors
Browse files Browse the repository at this point in the history
  • Loading branch information
aleju committed Sep 28, 2017
1 parent 544f469 commit 558fe4b
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions imgaug/imgaug.py
Original file line number Diff line number Diff line change
Expand Up @@ -559,15 +559,18 @@ def to_keypoint_image(self, size=1):
This function can be used as a helper when augmenting keypoints with
a method that only supports the augmentation of images.
Parameters
-------
size : int
Size of each (squared) point.
Returns
-------
image : (H,W,N) ndarray
Image in which the keypoints are marked. H is the height,
defined in KeypointsOnImage.shape[0] (analogous W). N is the
number of keypoints.
size : int
Size of each (squared) point.
"""
assert len(self.keypoints) > 0
Expand Down Expand Up @@ -601,7 +604,8 @@ def from_keypoint_image(image, if_not_found_coords={"x": -1, "y": -1}, threshold
Parameters
----------
image : (H,W,N) ndarray
The keypoints image. N is the number of keypoints.
The keypoints image. N is the number of
keypoints.
if_not_found_coords : tuple or list or dict or None
Coordinates to use for keypoints that cannot be found in `image`.
Expand All @@ -617,8 +621,8 @@ def from_keypoint_image(image, if_not_found_coords={"x": -1, "y": -1}, threshold
Returns
-------
out : KeypointsOnImage
The extracted keypoints.
out : KeypointsOnImage
The extracted keypoints.
"""
assert len(image.shape) == 3
Expand Down

0 comments on commit 558fe4b

Please sign in to comment.