Skip to content
Snippets Groups Projects
Commit 43b3161c authored by Nicolas Pope's avatar Nicolas Pope
Browse files

Update readme

parent ced6b0bd
No related branches found
No related tags found
1 merge request!5Refactor/components
Pipeline #10791 passed
......@@ -2,17 +2,32 @@
This monorepo contains all elements of the FTL software system.
* Components : Modular components compiled as static libs
* net : A p2p messaging library for C++ and JavaScript
* vision : Stereo vision node in p2p network
* reconstruct : Performs scene reconstruction from vision nodes
* renderer : Produce video or live feeds from scene representation
* rgbd-sources : Abstraction and implementations of different RGB-Depth data sources
* renderers : A collection of visualisation tools, including for RGB-D and point clouds
* scene-sources : Abstraction and implementations of 3D scene data sources
* common : Utility and configuration tools
* Applications : Executable apps for the different node machines
* vision : Stereo vision node in p2p network, generates an RGB-Depth net stream
* reconstruct : Performs scene reconstruction from synchronised RGB-Depth sources
* front-end : Client side FTL code, both web and native
* web-service : A web backend service provider acting as a form of proxy
* www : FTL Website
The architecture is a mix of C++ and NodeJS largely communicating over a p2p
The architecture is a mix of C++ and NodeJS largely communicating over a p2p RPC
network protocol.
Overall, initial vision machines capture video sources and generate colour and
depth images. These images are then streamed from all such sources to a single
machine to reconstruct the scene in 3D. The reconstructed scene is then further
compressed and streamed to other machines for additional analysis, processing or
visualisation.
The whole system is configured using JSON config files, examples of which can be
found in the `config` folder. The intention is that a web interface will
eventually enable this configuration to take place online.
## Build
Use the following commands in the root repository directory to build:
......@@ -29,5 +44,5 @@ to configure the project.
You will need to have OpenCV and glog installed. CUDA and LibSGM are optional
but recommended also. OpenCV should have cuda stereo modules compiled, along
with the viz module if local point cloud display is required. These are contrib
modules.
modules. PCL is also required to build the reconstruction components and app.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment