aidge-backend-opencv 0.9.0

Opencv implementations of the operators and tensor of aidge framework

Aidge backend OpenCV library

You can find in this folder the library that implements :

• Computer vision databases
• The OpenCV tensor, operators and stimulis

So far be sure to have the correct requirements to use this library

[TOC]

Quick Start

ℹ️ First, make sure to go through installation instructions required for every module.

Dependencies

Make sure to install the following tools:

• OpenCV

[!TIP] On Windows at least, make sure to add the following environment variables:

• OpenCV_DIR - It should be set to OpenCV build's folder, e.g. opencv-X.Y.Z\build
• OPENCV_DLL_DIR - It should be set to OpenCV dll's folder, e.g. opencv-X.Y.Z\build\x64\vc16\bin

Aidge dependencies

• aidge_core
• aidge_backend_cpu
  • Only needed for tests.

# On Windows, from aidge/
# ----------[ C++ development]----------
setup.ps1 -Modules core, backend_cpu -Clean -Tests

# ----------[ Python development]----------
setup.ps1 -Modules core, backend_cpu -Clean -Tests -Python

# On Unix, from aidge/
# ----------[ C++ development]----------
./setup.sh -m core -m backend_cpu --clean --tests

# ----------[ Python development]----------
./setup.sh -m core -m backend_cpu --clean --tests --python

Using setup.ps1

[!NOTE] Windows only* *Unless you installed powershell on your system

# ----------[ C++ development]----------
# From aidge/
setup.ps1 -Modules backend_opencv -Clean -Tests

# ----------[ Python development]----------
# From aidge/
setup.ps1 -Modules backend_opencv -Clean -Tests -Python

[!TIP] Run Get-Help setup.ps1 --Full to display documentation

Using setup.sh

[!NOTE] Unix only*

# ----------[ C++ development]----------
# From aidge/
./setup.sh -m backend_opencv --clean --tests

# ----------[ Python development]----------
# From aidge/
./setup.sh -m backend_opencv --clean --tests --python

[!TIP] Run setup.sh -h to display documentation

Using pip

[!NOTE] If using virtual environment, make sure to use the same for every installation !

# ----------[ Python development]----------
# only in aidge/aidge/aidge_backend_opencv/
pip install . -v

# If you want to install test, do this instead
pip install .[test] -v

# Launch tests using pytest
pytest

[!TIP] -v is to enable verbose mode !

Development mode install

[!WARNING] Experimental Untested & experimental feature, see https://scikit-build-core.readthedocs.io/en/latest/configuration/index.html#editable-installs.

pip install --no-build-isolation --config-settings=editable.rebuild=true -Cbuild-dir=build -ve.

Using CMake

[!NOTE] Only for C++ development Don't use this method, if you wish to create a pip package Use pip instead.

A CMakePreset.json is available.

# Configure
cmake --preset clang-debug
# Build
cmake --build --preset clang-debug
# Install
cmake --install
# Test
ctest --test-dir build/

Feel free to create your own presets in CMakeUsersPresets.json by inheriting the ones available in CMakePresets.json.

FAQ

For windows set this env variables: OPENCV_DLL_DIR so that python can load OpenCV DLL. (This is not needed for C++)