README.md

HDevelop samples

This repository contains halcon code samples for Zivid SDK v2.13.1. For tested compatibility with earlier SDK versions, please check out accompanying releases.

---

Contents: Samples | Installation | Support | License

---

Samples list

There are two main categories of samples: Camera and Applications. The samples in the Camera category focus only on how to use the camera. The samples in the Applications category use the output generated by the camera, such as the 3D point cloud, a 2D image or other data from the camera. These samples shows how the data from the camera can be used.

• Camera
  • Basic
    • Capture - Capture a 3D color point cloud from the camera and use it to generate a HALCON ObjectModel3D which is then visualized.
    • CaptureHDR - Capture an HDR image from the camera and use it to generate a HALCON ObjectModel3D which is then visualized.
    • CaptureHDRCompleteSettings - Capture an HDR image from the Zivid camera with fully configured settings for each frame.
    • CaptureSavePLY - Capture a 3D color point cloud from the camera and save it to a PLY file format.
    • CaptureWithSettingsFromJSON - Capture a 3D color point cloud from the camera and use it to generate a HALCON ObjectModel3D which is then visualized.
    • ConnectToSerialNumberCamera - Connect to a specific Zivid 3D camera based on its serial number.
  • Advanced
    • CaptureHDRLoop - Capture HDR images from the camera in a loop (while actively changing some HDR settings).
  • InfoUtilOther
    • QuerySettingsAndParameters - Query information about the image acquisition interface and selected specific parameters of Zivid camera.
    • Warmup - A basic warm-up method for a Zivid camera with specified time and capture cycle.
• Applications
  • Basic
    • FileFormats
      • ReadPLY - Import and display a Zivid point cloud from a PLY file.
  • Advanced
    • ObjectMatching
      • SurfaceMatchingCreateModel - Create a model for HALCON surface-based 3D matching algorithm from a Zivid point cloud captured by a camera.
      • SurfaceMatchingCreateModelFromFile - Create a model for HALCON surface-based 3D matching algorithm from a Zivid point cloud loaded from a ZDF file.
      • SurfaceMatchingFindModel - Utilize surface-based 3D matching on data taken with a Zivid camera.
      • SurfaceMatchingFindModelFromFile - Utilize surface-based 3D matching on data taken with a Zivid camera.

Installation

If you want to use Zivid in HALCON, we provide a GenICam GenTL producer that comes with the Zivid Software.

Zivid and HALCON are compatible with Windows 10 and 11, and Ubuntu 20.04, 22.04, 24.04.

---

Note:

Support for Ubuntu 18.04 is removed since SDK 2.10.

---

To setup and use Zivid in one of these operating systems, please follow their respective instructions in the following pages:

• Install Zivid + HALCON for Windows
• Install Zivid + HALCON for LINUX
• Create a HALCON "Hello World" Program
• How to Run a HALCON Sample
• HALCON Sample Videos

The following HALCON versions have been tested and confirmed to work with Zivid cameras:

• 19.05 Progress, 20.05 Progress, 21.11 Progress

We recommend to use one of the HALCON versions we have tested.

Support

For more information about the Zivid cameras, please visit our Knowledge Base. If you run into any issues please check out Troubleshooting.

License

Zivid Samples are distributed under the BSD license.