forked from AprilRobotics/apriltag
-
Notifications
You must be signed in to change notification settings - Fork 7
/
apriltag_py_type.docstring
80 lines (58 loc) · 2.66 KB
/
apriltag_py_type.docstring
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
AprilTag detector
SYNOPSIS
import cv2
import numpy as np
from apriltag import apriltag
imagepath = '/tmp/tst.jpg'
image = cv2.imread(imagepath, cv2.IMREAD_GRAYSCALE)
detector = apriltag("tag36h11")
detections = detector.detect(image)
print("Saw tags {} at\n{}". \
format([d['id'] for d in detections],
np.array([d['center'] for d in detections])))
----> Saw tags [3, 5, 7, 8, 10, 10, 14] at
[[582.42911184 172.90587335]
[703.32149701 271.50587376]
[288.1462089 227.01502779]
[463.63679264 227.91185418]
[ 93.88534443 241.61109765]
[121.94062798 237.97010936]
[356.46940849 260.20169159]]
DESCRIPTION
The AprilTags visual fiducial system project page is here:
https://april.eecs.umich.edu/software/apriltag
This is a Python class to provide AprilTags functionality in Python programs. To
run the detector you
1. Construct an object of type apriltag.apriltag()
2. Invoke the detect() method on this object
The constructor takes a number of arguments:
- family: a string for the tag type we're detecting. This argument is required.
If an invalid string is given, the known list of tag families will be
reported. At the time of this writing the known families are:
- "tag36h11"
- "tag25h9"
- "tag16h5"
- "tagCircle21h7"
- "tagCircle49h12"
- "tagStandard41h12"
- "tagStandard52h13"
- "tagCustom48h12"
All the other arguments are optional:
- Nthreads: how many threads the detector should use. Default is 1
- maxhamming: max number of corrected bits. Larger values guzzle RAM. Default is
1
- decimate: detection of quads can be done on a lower-resolution image,
improving speed at a cost of pose accuracy and a slight decrease in detection
rate. Decoding the binary payload is still done at full resolution. Default is 1.0
- blur: What Gaussian blur should be applied to the segmented image (used for
quad detection?) Parameter is the standard deviation in pixels. Very noisy
images benefit from non-zero values (e.g. 0.8). Default is 0.0
- refine_edges: When non-zero, the edges of the each quad are adjusted to "snap
to" strong gradients nearby. This is useful when decimation is employed, as it
can increase the quality of the initial quad estimate substantially. Generally
recommended to be on. Very computationally inexpensive. Option is ignored if
decimate == 1. Default is True
- debug: When non-zero, write a variety of debugging images to the current
working directory at various stages through the detection process. (Somewhat
slow). Default is False
The detect() method takes a single argument: an image array