You are here: Start » PyAVL

PyAVL

Aurora Vision Library provides Python packages that expose the Aurora Vision Library and Deep Learning inference to Python 3.12 or later programs:

  • PyAVL —the core Aurora Vision Library wrapper. Gives access to the full image processing, geometry, and machine vision function set. Imported as import AVL. Available since Aurora Vision Library 5.7.
  • PyAVL-DL —the Deep Learning inference wrapper. Gives access to all DL Deploy filters (object detection, classification, anomaly detection, OCR, etc.). Imported as import AVLDL. Requires PyAVL. Available since Aurora Vision Library 5.7.

Both packages ship as pre-compiled native extension modules (.pyd on Windows, .so on Linux) placed in the installation folder during the standard Aurora Vision Library setup. No compilation is required.

Requirements

Python 3.12 or later (64-bit) is required. Both packages are built against the Python stable ABI (abi3) and work with any CPython 3.12+ release.

Aurora Vision Library has to be installed on the machine. PyAVL-DL additionally requires the Aurora Deep Learning add-on.

The supported operating systems are Windows 11 (64-bit) and a supported 64-bit Linux distribution.

In This Section

  1. Installation —the files of each package and the setup on Windows and Linux.
  2. First Steps —API conventions, basic examples, error handling and the functions that control the execution.
  3. Relation between PyAVL and AVL/C++ —how the functions, types, outputs and errors of AVL/C++ appear in Python.
  4. Python Examples —the ready-to-run example scripts of PyAVL and PyAVL-DL and how to run them on Windows and Linux.
  5. Deep Learning (PyAVL-DL) —the workflow of the inference functions and the list of functions available in PyAVL-DL.
  6. Operators on Geometry Types —arithmetic on locations, points and vectors, and translation of shapes with + and -.
  7. Working with Matrices —creating, reading, transposing and inverting matrices, and matrix arithmetic.
  8. Interoperability with Other Libraries —exchanging images, matrices and byte buffers with NumPy, Pillow and OpenCV.
  9. Image Acquisition —GigE Vision and GenICam cameras.
  10. Troubleshooting —solutions to common import and installation problems.

Examples

Ready-to-run examples are described in Python Examples. On Windows the installer copies them to C:\Users\Public\Documents\Aurora Vision Library 5.7\Examples\08 Python. On Linux the examples are located in the examples folder of the unpacked library archive. The installer does not copy them, and they need additional packages. The examples of PyAVL-DL are installed on Windows with a separate installer and are located in the examples folder of the Deep Learning archive on Linux.

See Also

Previous: Class Reference Next: Installation