API Reference Section

From RidgeRun Developer Wiki

Follow Us in Twitter LinkedIn Email Share this page







This section will cover the foundations and bases of the API. Here, you can find information regarding:

  • Library Architecture: describing the general structure of our library, the interface-adapter design pattern, and the interfaces and concrete algorithms it currently contains.
  • Information about Adding New Sensors: describing how to add new support for new IMU sensors, particularly understanding the sensor interface and how to create a concrete implementation (or adapter) to the new sensor.
  • Information about Adding Algorithms: describing how to add new algorithms for integration and interpolation to the library. This explains the interfaces and how to implement new adapters for algorithm implementation.
  • Information about Adding Stabilization Algorithms: describing how to add new algorithms for stabilization to the library. This explains the interfaces and how to implement new adapters for algorithm implementation.
  • Information about Adding Backend: describing how to add new backends for hardware acceleration, explaining how to implement memory allocators, algorithms compatible with the memory allocators, and all the functionality for image correction.
  • API Documentation : with a link to the auto-generated API documentation.
  • Examples Guidebook: describing the available examples and tests that illustrate how to interact with each library module.