python

Python Examples – IDS peak Generic SDK

This directory contains Python example scripts demonstrating the use of the IDS peak generic SDK Python bindings.

Requirements

• An IDS peak Setup (Runtime Setup which provides the GenTL is enough)
• Python 3.10 or later

Setup

1. (Recommended) Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate      # Linux/macOS
.venv\Scripts\activate         # Windows (PowerShell)

2. Install Python packages from the provided requirements.txt:

pip install -r requirements.txt

Running Examples

python example_name.py

or on some linux distributions

python3 example_name.py

Packages (PyPI)

• https://pypi.org/project/ids-peak/
• https://pypi.org/project/ids-peak-ipl/
• https://pypi.org/project/ids-peak-afl/
• https://pypi.org/project/ids-peak-icv/
• https://pypi.org/project/ids-peak-common/

Included Examples

GUI examples

• Pipeline (Kivy) Shows how the image pipeline can be applied to process camera images. Pipeline settings can be saved and loaded, allowing, for example, easy transfer of settings to and from the IDS peak Cockpit.
• Simple Live (QtWidgets) This example shows how to use QtWidgets to display a live image.

CLI examples

• Calibration From File Shows how to perform a camera calibration.
• Firmware Update Shows how to programmatically update the firmware of a device.
• HDR Demonstrates how to acquire multiple images with different exposure times using an IDS camera and combine them into a single High Dynamic Range (HDR) image.
• HDR from file Shows how to create an HDR image and apply tone mapping for visual appearance using IDS peak ICV.
• Image Region From File Shows what image regions are and how to use them in IDS peak ICV.
• Morphology Shows how to use region morphology using IDS peak ICV.
• Nion Point Cloud Shows how to calculate the depth Map and point cloud using the IDS Nion camera and IDS peak ICV.
• Node Polling Shows how node polling is used to regularly invalidate GenICam nodes that implement the PollingTime feature, ensuring that cached values stay up to date.
• Open Camera Shows how to enumerate devices and access device information.
• Point Cloud From File Shows how to create a point cloud with mapped Mono data using IDS peak ICV.
• Reconnect Shows how to use the automatic device reconnect feature of the IDS peak API and how to react to connection state changes.
• Record Video Shows how to use the VideoWriter of the IDS peak IPL to create a video sequence.
• Software Trigger Shows how to use the software trigger to acquire images.
• System Timestamp Shows how to use the system timestamp feature in order to get a wall-clock time corresponding to a arbitrary device timestamp.
• Threshold From File Shows how to apply a threshold using IDS peak ICV.
• Undistortion From File Shows how to apply an undistortion using IDS peak ICV.
• Unicast This example demonstrates how to use the unicast discovery features of the transport layer (TL) to locate cameras that are not in the same subnet as the host system.
• Workspace Calibration From File Shows how to calibrate and apply a new workspace using IDS peak ICV.