ids-peak-ipl 1.12.0.0

ids_peak_ipl - A library for image manipulation

ids_peak_ipl provides python bindings for the IDS peak IPL. It exposes all the functionality of the peak IPL.

Benefit from many Python advantages, for example the interactive programming of your IDS camera. Write and test small code snippets without the complex setup of a programming IDE including a toolchain. This package is ideal for prototyping IDS camera applications for all supported peak IPL platforms (Windows, Linux, Linux Embedded).

Installation

$ pip install ids_peak_ipl

Quickstart

Different ways to create peak IPL images:

from vapibinaryname import vapibinaryname
from ids_peak_ipl import ids_peak_ipl

import numpy as np

width = 1
height = 1
image_from_size = ids_peak_ipl.Image.CreateFromSize(
    ids_peak_ipl.PixelFormatName_Mono8, width, height)

# Buffer is an instance of IDS peak genericAPI API's class Buffer
image_from_size_and_buffer = ids_peak_ipl.Image.CreateFromSizeAndBuffer(
    buffer.PixelFormat(),
    buffer.BasePtr(),
    buffer.Size(),
    buffer.Width(),
    buffer.Height()
)

# From a numpy array
numpy_array = np.array([[10, 20, 30]], dtype=np.uint8)
image_from_size_and_python_buffer = ids_peak_ipl.Image.CreateFromSizeAndPythonBuffer(
    img.PixelFormatName_RGB8, numpy_array, width, height)

# From a bytearray
byte_array = bytearray([255, 10, 128])
image_from_size_and_python_buffer = ids_peak_ipl.Image.CreateFromSizeAndPythonBuffer(
    img.PixelFormatName_RGB8, byte_array, width, height)

Converting a camera image when used in combination with IDS peak genericAPI:

while m_running:
    try:
        # Get buffer from device's DataStream. Wait 5000 ms.
        # The buffer is automatically locked until it is queued again.
        buffer = m_data_stream.WaitForFinishedBuffer(5000)
 
        image = ids_peak_ipl.Image_CreateFromSizeAndBuffer(
           buffer.PixelFormat(),
           buffer.BasePtr(),
           buffer.Size(),
           buffer.Width(),
           buffer.Height()
        )
        image = image.ConvertTo(
            ids_peak_ipl.PixelFormatName_BGRa8,
            ids_peak_ipl.ConversionMode_Fast)
 
        # Queue buffer again
        m_data_stream.QueueBuffer(buffer)
    except Exception as e:
        # ...
        str_error = str(e)

Documentation

Documentation is available here