Skip to content

Commit 1f218a9

Browse files
author
Carsten Griwodz
committed
[doc] describe float* input option to readme
1 parent 845cba4 commit 1f218a9

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@ Some build options are available:
5050

5151
## Usage
5252

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 application `popsift-demo` is created as well.
55+
Calling `popsift-demo` without parameters shows the options.
5456

5557
### Using PopSift as third party
5658

@@ -84,7 +86,9 @@ cmake .. -DPopSift_DIR=<prefix>/lib/cmake/PopSift/
8486
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`).
8587

8688
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+
8892
Only host memory limits the number of images that can be enqueued.
8993
The `enqueue` function returns a pointer to a `SiftJob` immediately and performs the feature extraction asynchronously.
9094
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),
134138

135139
___
136140

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

Comments
 (0)