Python bindings for SAMSON API#

The Python Scripting extension in SAMSON provides Python bindings for SAMSON API and an integrated Python console. It provides you with an access to most of the SAMSON SDK allowing you to access most of SAMSON’s functionality through Python scripting.

Python bindings for the SAMSON API are done in the same structure as the SAMSON SDK: classes have the same short names as in the SDK and functions are exposed with the same names and parameters except for some getter/setter functions that are exposed as class properties where possible. This makes it possible to easily trasnfer your code between Python and C++ with minor modifications.

This documentation has links to the SAMSON SDK which you can check out for comparison and some additional information.

The Python console in SAMSON comes with an integrated Jupyter Qt Console.


This version of Python bindings is for SAMSON SDK 2024 R1.

Python bindings are done thanks to pybind11 (pybind11 license).


The following guides demonstrate the usage of Python bindings for SAMSON API.

API documentation#

Below the Python Scripting API description is subdivided into groups that correspond to the SAMSON SDK Organization.