Skip to content

Commit aacbd8b

Browse files
committed
Bump version to 1.1.0
1 parent 1d8941f commit aacbd8b

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This package is maintained by [Techainer](https://techainer.com)
99

1010
## Install
1111
To install this package, make sure you have the following dependencies installed:
12-
- NodeJS 14.x.x
12+
- NodeJS 12+
1313
- cmake 3.9+
1414
- OpenCV 3.x.x (Build from source recommened)
1515
- Eigen 3.x.x (`sudo apt-get install -y libeigen3-dev`)
@@ -19,6 +19,8 @@ Noted that we have provide a `Dockerfile` contain all 3rd dependencies. To use i
1919
docker build -t sort .
2020
./docker_run.sh
2121
```
22+
Or you can reference our github actions [CI](.github/workflows/ci.yml) flow to install dependencies for your own OS.
23+
2224
Then you can install the package from npm:
2325

2426
```bash
@@ -35,9 +37,16 @@ The `SortNode` object can be initialize with 2 arguments:
3537

3638
With each frame, you will need to call `update` method.
3739

38-
This method except a single arguments that had a the format `List[List[float]]`, which means a list of detected object in that frame. Each object will have the format: `[x_top, y_top, width, height, confidence]`.
40+
This method except a single arguments that had a the format `List[List[float]]`, which means a list of detected object in that frame. Each object will have the format: `[x_top, y_top, width, height, confidence]` or `[x_top, y_top, width, height, confidence, landmark_x1, landmark_y1, ...]` for addtional landmark associated with each bounding box
3941

40-
The `update` method will return a list of tracked object in the format `[List[List[int]]`, each object will have the format: `[x_top, y_top, width, height, track_id]`
42+
The `update` method will return a list of tracked object in the format `[List[Object]]`, each object will have the following structure:
43+
```js
44+
{
45+
bbox: List[(int) x_top, y_top, width, height],
46+
track_id: int,
47+
landmarks: List[(float) x1, y1, x2, y2, ..., x_n, y_n],
48+
}
49+
```
4150

4251
Please noted that the number of returned object might not be the same as the number of inputed object.
4352

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
},
1919
"name": "@techainer1t/sort-node",
2020
"description": "Node binding of SORT: Simple, online, and real-time tracking of multiple objects in a video sequence.",
21-
"version": "1.0.0",
21+
"version": "1.1.0",
2222
"directories": {
2323
"doc": "docs"
2424
},

0 commit comments

Comments
 (0)