Debian Codegraph @

find_points.docstring

raw
1 Finds corner or blob features in an image
2
3 SYNOPSIS
4
5 corners = mrgingham.find_points(image)
6
7 [ corners is an array of shape (N,2), the unordered list of ]
8 [ detected feature coordinates in the image ]
9
10 This function runs just the initial stage of the mrgingham processing:
11
12 - pre-process image
13 - find chessboard corners (or blobs)
14
15 This function does NOT look for the grid in the feature set
16
17 No broadcasting is supported by this function
18
19 ARGUMENTS
20
21 - image: numpy array of shape (H,W) and dtype np.uint8. This is the image we're
22 processing. Must be densely-stored, grayscale image
23
24 - blobs: optional boolean, defaulting to False. If True, we look for
25 black-on-white blobs, instead of chessboard corners. If blobs: we MUST have
26 image_pyramid_level==0
27
28 - image_pyramid_level: optional integer defaulting to -1. This can be given to
29 operate on a downsampled version of the image. 0 means "original image", 1
30 means "downsample by a factor of 2 in each dimension", 2 means "downsample by
31 a factor of 4 in each dimension" and so on. image_pyramid_level < 0 (the
32 default) means "start with a downsampled image, and then refine the results by
33 repeatedly reducing the downsampling. If blobs: image_pyramid_level==0 is the
34 only allowed option
35
36 - debug: optional boolean, defaulting to False. If True, this will dump various
37 intermediate results into /tmp and it will report more stuff on standard out.
38 Most of the intermediate results are self-plotting data files. Run them. This
39 does the same thing as "mrgingham --debug"; the Python output is unaffected.
40
41 RETURNED VALUE
42
43 A numpy array of shape (N,2) containing unordered pixel coordinates of the
44 discovered features. If no features were found, and array of shape (0,2) is
45 returned.
46