Skip to content

Commit dfae8c9

Browse files
committed
Update README, add architecture diagram
1 parent 93e2e25 commit dfae8c9

File tree

2 files changed

+133
-43
lines changed

2 files changed

+133
-43
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,44 @@ Assuming the workspace compiles, following steps 1-3 of OFPS Suite section, run
8282
## Unit tests
8383

8484
Assuming the workspace compiles, run `cargo test`.
85+
86+
## Example configurations
87+
88+
Download core samples from [Google Drive](https://drive.google.com/drive/folders/1i4sPhfbvCzV6b0r5iiUEnGVXmX1XkwMq), and extract `samples.zip` (sha256 - c1a27a0716b5633792afca7c1a032dcc9c15c8f7153a03e8d5206e1d86379896) in the project root under `samples` directory. Raw detection sample was large, thus it has been separated into `cctv.h264` file (sha256 - 9fd17d015924538c140f9ee478bdbfc5233f6c948ff134d2f31415e795da9b66). Place it in `samples/detection` directory. Locations are important, because predefined configs reference paths relative to current working directory.
89+
90+
### Detection Configurations
91+
92+
Load predefined configuration files from the paths given (by clicking on the large detection title button).
93+
94+
- Scenario from Results - `samples/scenario_detect.json` (requires raw sample).
95+
96+
- Basic motion - `samples/basic_detect.json`.
97+
98+
- Live TCP stream (webcam) - `samples/tcp_detect.json`.
99+
100+
For V4L webcam through TCP, first run the following command in another terminal:
101+
102+
```
103+
ffmpeg -i /dev/video1 -c:v libx264 -r 30 -preset ultrafast -tune zerolatency -x264-params "" -f mpegts tcp://0.0.0.0:3333\?listen
104+
```
105+
106+
Adjust `/dev/video1` to correct V4L device. The command needs to be re-run after each connection instance.
107+
108+
### Tracking Configurations}
109+
110+
Load predefined configuration files from the paths given (by clicking on the large tracking title button).
111+
112+
- Synthetic videos, all estimators, ground truth comparisons - `samples/synthetic_all_gt.json`.
113+
114+
- Synthetic videos, single estimator, ground truth - `samples/synthetic_almeida_gt.json`.
115+
116+
- Real-world videos - `samples/real_world.json`.
117+
118+
- Real-world videos (cropped, slowmo) - `samples/real_world_crop.json`.
119+
120+
- Live TCP stream (webcam) - `samples/tcp_track.json`.
121+
122+
The preloaded samples can be replaced with different ones. See `samples/synthetic` and `samples/real_world` directories. Cropped config is needed to account for 1.2x sensor crop applied on slow motion video.
123+
124+
For TCP configuration, refer to the previous subsection for setup steps. In addition, camera's horizontal and vertical field of view must be set correctly for tracking to be accurate.
125+

0 commit comments

Comments
 (0)