OpenARK Repository Structure

General

OpenARK is written primarily in C++. It uses CMake as its build system.

Compilation of OpenARK on Windows is done using Visual Studio 14 2015. Tests have been performed building with later release of Visual Studio, but currently there is no guarantee of successful building with any later version.

File Structure

1. config contains some important files for running OpenARK
   • brisk_vocab.bn: Bag of words vocabulary for BRISK features. Should be automatically downloaded by the CMakeLists.txt
   • orb_vocab.txt: Bag of words vocabulary for ORB features. Should be automatically downloaded by the CMakeLists.txt
   • d435i_intr.yaml: YAML configuration describing the camera parameters, and many other configuration settings for different parts of OpenARK. Generated by running d435i_intrinsics_writer.exe with a plugged-in RealSense D435i camera.
2. documentation contains helpful building documentation for OpenARK
   • Ubuntu-18-build-instructions.md: Build instructions for OpenARK on Ubuntu 18. Dependencies are built from source or installed via apt-get.
   • windows-build-inst.md: Build instructions for OpenARK on Windows 10. Dependencies are all built from source. Recommended build instructions for Windows if developing OpenARK.
   • Windows-build-instructions-quick.md: Build instructions for OpenARK on Windows 10 using dependencies installer. Dependencies are all pre-built binaries packaged into openark-deps-vc14-win64.exe. Works on most systems. Recommended build instructions for Windows if needing to run OpenARK quickly.
   • k4a_dependency.md: Instructions for installing k4a, the SDK for the Azure Kinect camera.
   • openark-deps-vc14-win64.exe: Dependency installer for OpenARK. Dependencies are pre-built using Visual Studio 14 2015 and packaged into this file. Follow Windows-build-instructions-quick.md instructions for use.
3. include contains header files for OpenARK's C++ code base.
4. samplecode contains examples of running different OpenARK functionalities such as hand tracking.
5. scripts contains scripts outside of OpenARK's C++ code base. It currently only contains a 3D reconstruction Python script.
6. src contains source files for OpenARK's C++ code base.
7. third_party contains eigen and glfw dependencies.
8. unity contains OpenARK's Unity Plugin.
9. CMakeLists.txt is the build instructions for OpenARK.