Introduction

The IDS peak ICV library provides computer vision features mainly for images taken with IDS cameras.

The IDS peak common library is also part of this documentation as it serves as a common foundation within the IDS software ecosystem (including the IDS peak ICV library), offering essential building blocks that enable consistent API design and interoperability across higher-level libraries.

Reading the documentation

The documentation is organized in three main areas

• API Reference
  • C++
    • IDS peak ICV
    • IDS peak common
  • .NET
    • IDS peak ICV
    • IDS peak common
  • Python
    • IDS peak ICV
    • IDS peak common
• Guides (address a goal or problem)
• Concepts (get background and context information)

Preliminary functions

Next to its released functions the IDS peak ICV library contains preliminary functions that are being prepared by our software development team but are still in development. These preliminary functions are marked with a warning in the documentation. Preliminary functions are located within an experimental namespace (experimental::<subnamespace>::<function name>) or module in python (ids_peak_icv.experimental). While these function are functional and can be used for experimenting with new concepts and features, they should be avoided in production environments, as they might be subject to (breaking) changes.