Browse Source

Add section: Instantiation

customisations
alemart 10 months ago
parent
commit
0e357fb7c5
1 changed files with 19 additions and 1 deletions
  1. 19
    1
      docs/api/image-tracker.md

+ 19
- 1
docs/api/image-tracker.md View File

@@ -2,6 +2,24 @@
2 2
 
3 3
 A [tracker](tracker.md) that tracks images in a video. Images are tracked using templates known as [reference images](reference-image.md).
4 4
 
5
+## Instantiation
6
+
7
+### AR.Tracker.ImageTracker
8
+
9
+`AR.Tracker.ImageTracker(): ImageTracker`
10
+
11
+Instantiate an image tracker.
12
+
13
+**Returns**
14
+
15
+A new image tracker.
16
+
17
+**Example**
18
+
19
+```js
20
+const imageTracker = AR.Tracker.ImageTracker();
21
+```
22
+
5 23
 ## Properties
6 24
 
7 25
 ### state
@@ -20,7 +38,7 @@ A [database](reference-image-database.md) of [reference images](reference-image.
20 38
 
21 39
 `tracker.resolution: Resolution`
22 40
 
23
-The [resolution](resolution.md) adopted by the computer vision algorithms implemented in the tracker. Higher resolutions improve the tracking quality, but are computationally more expensive.
41
+The [resolution](resolution.md) adopted by the computer vision algorithms implemented in the tracker. Higher resolutions improve the tracking quality, but are computationally more expensive. Note that this resolution is different from, and should not be larger than, the [resolution of the camera](camera-source.md#resolution)!
24 42
 
25 43
 ## Events
26 44
 

Loading…
Cancel
Save