C++ Headers

This is an overview of how the C++ headers are organised in the installation directory for the Base module.

Below, <install-prefix> refers to the path where the SDK is installed. The default values depends on your operating system and installation:

Ubuntu: /usr when installing with the packages and /usr/local when building from source code with the deployment step
Windows: C:\Program Files\Prophesee

The headers of the SDK Base module are grouped semantically under high-level folders:

<install-prefix>/include/metavision/sdk
├── base
│   ├── events
│   └── utils
└── other modules...

In addition to the headers, each of the folders optionally has a detail folder. The detail folders contain the code that has been removed from the main headers in order to make them more readable. The detail folders include method implementations, helpers, macros, etc. which are not meant to be included directly in your application.

To include a header from the Base module in your code, just write the full path starting from the <install-prefix>/include/. For instance, to access the EventCD structure:

#include <metavision/sdk/base/events/event_cd.h>

Events

The events folder contains class definitions for common events that are not related to any particular device. The most important type of events is EventCD, which represents a Contrast Detection (CD) event.

Utils

The utils folder contains assorted utilities that are deemed generally useful, but don’t belong to any other category.