RidgeRun Video Stabilization Library/API Reference: Difference between revisions
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
This section will cover the foundations and bases of the API. Here, you can find information regarding: | This section will cover the foundations and bases of the API. Here, you can find information regarding: | ||
* '''[[API Reference/Library Architecture|Library Architecture]]''': describing the general structure of our library, the interface-adapter design pattern, the interfaces and concrete algorithms it currently contains. | * '''[[RidgeRun Video Stabilization Library/API Reference/Library Architecture|Library Architecture]]''': describing the general structure of our library, the interface-adapter design pattern, the interfaces and concrete algorithms it currently contains. | ||
* '''Information about [[API Reference/Adding New Sensors|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 [[RidgeRun Video Stabilization Library/API Reference/Adding New Sensors|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 [[API Reference/Adding Algorithms|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 [[RidgeRun Video Stabilization Library/API Reference/Adding Algorithms|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 [[API Reference/Adding Stabilization Algorithms|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 [[RidgeRun Video Stabilization Library/API Reference/Adding Stabilization Algorithms|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 [[API Reference/Adding Backend|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. | * '''Information about [[RidgeRun Video Stabilization Library/API Reference/Adding Backend|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. | ||
* '''[http://ridgerun.pages.ridgerun.com/rnd/ridgerun-video-stabilizer/index.html API Documentation]''': with a link to the auto-generated API documentation. | * '''[http://ridgerun.pages.ridgerun.com/rnd/ridgerun-video-stabilizer/index.html API Documentation]''': with a link to the auto-generated API documentation. | ||
* '''[[API Reference/Examples Guidebook|Examples Guidebook]]''': describing the available examples and tests that illustrate how to interact with each library module. | * '''[[RidgeRun Video Stabilization Library/API Reference/Examples Guidebook|Examples Guidebook]]''': describing the available examples and tests that illustrate how to interact with each library module. | ||
<noinclude> | <noinclude> | ||
{{RidgeRun Video Stabilization Library/Foot|Getting Started/Building the Library|API Reference/Library Architecture}} | {{RidgeRun Video Stabilization Library/Foot|Getting Started/Building the Library|API Reference/Library Architecture}} | ||
</noinclude> | </noinclude> | ||
Revision as of 18:13, 3 July 2024
 | RidgeRun Video Stabilization Library RidgeRun documentation is currently under development. |
Table of Contents
[Sticky]
 |
|
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, 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.