You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,9 @@ Some build options are available:
50
50
51
51
## Usage
52
52
53
-
Two artifacts are made: `libpopsift` and, if enabled, the test application `popsift-demo`. Calling `popsift-demo` without parameters shows the options.
53
+
The main artifact created is `libpopsift`.
54
+
If enabled, the test applications `popsift-demo` and `popsift-match` are created as well.
55
+
Calling `popsift-demo` or `popsift-match` without parameters shows the options.
The caller must create a `popart::Config` struct (documented in `src/sift/sift_conf.h`) to control the behaviour of the PopSift, and instantiate an object of class `PopSift` (found in `src/sift/popsift.h`).
85
87
86
88
After this, images can be enqueued for SIFT extraction using (`enqueue()`).
87
-
The only valid input format is a single plane of grayscale unsigned characters.
89
+
A valid input is a single plane of grayscale values located in host memory.
90
+
They can passed as a pointer to unsigned char, with a value range from 0 to 255, or as a pointer to float, with a value range from 0.0f to 1.0f.
91
+
88
92
Only host memory limits the number of images that can be enqueued.
89
93
The `enqueue` function returns a pointer to a `SiftJob` immediately and performs the feature extraction asynchronously.
90
94
The memory of the image passed to enqueue remains the caller's responsibility. Calling `SiftJob::get` on the returned job blocks until features are extracted, and returns them.
@@ -134,4 +138,4 @@ PopSift was developed within the project [POPART](http://www.popartproject.eu),
134
138
135
139
___
136
140
137
-
[1]: Lowe, D. G. (2004). Distinctive Image Features from Scale-Invariant Keypoints. International Journal of Computer Vision, 60(2), 91–110. doi:10.1023/B:VISI.0000029664.99615.94
141
+
[1]: Lowe, D. G. (2004). Distinctive Image Features from Scale-Invariant Keypoints. International Journal of Computer Vision, 60(2), 91–110. doi:10.1023/B:VISI.0000029664.99615.94
0 commit comments