Samples

Dive straight into programming the Zivid camera with your preferred programming language.

Note

Some Zivid Samples require Sample Data.

List of samples

Camera
- Basic
  - Capture - Capture point clouds, with color, from the Zivid camera.
  - Capture2D - Capture 2D images from the Zivid camera.
  - CaptureAssistant - Capture Assistant to capture point clouds, with color, from the Zivid camera.
  - CaptureFromFileCamera - Capture point clouds, with color, from the Zivid file camera. Currently supported by Zivid One.
  - CaptureHDR - Capture HDR point clouds, with color, from the Zivid camera.
  - CaptureHDRCompleteSettings - Capture point clouds, with color, from the Zivid camera with fully configured settings.
  - CaptureWithSettingsFromYML - Capture point clouds, with color, from the Zivid camera, with settings from YML file.
- Advanced
  - AllocateMemoryForPointCloudData - Two methods to copy point cloud data from GPU memory to CPU memory, to be consumed by OpenCV.
  - CaptureHDRLoop - Cover the same dynamic range in a scene with different acquisition settings to optimize for quality, speed, or to find a compromise.
  - CaptureHDRPrintNormals - Capture Zivid point clouds, compute normals and print a subset.
  - CaptureHalconViaGenICam - Capture and save a point cloud, with colors, using GenICam interface and Halcon C++ SDK.
  - CaptureHalconViaZivid - Capture a point cloud, with colors, using Zivid SDK, transform it to a Halcon point cloud and save it using Halcon C++ SDK.
  - MultiCameraCaptureInParallel - Capture point clouds with multiple cameras in parallel.
  - MultiCameraCaptureSequentially - Capture point clouds with multiple cameras sequentially.
- InfoUtilOther
  - CameraUserData - Store user data on the Zivid camera.
  - CaptureWithDiagnostics - Capture point clouds, with color, from the Zivid camera, with settings from YML file and diagnostics enabled.
  - FirmwareUpdater - Update firmware on the Zivid camera.
  - FrameInfo - Read frame info from the Zivid camera.
  - GetCameraIntrinsics - Read intrinsic parameters from the Zivid camera (OpenCV model).
  - PrintVersionInfo - List connected cameras and print version information.
  - SettingsInfo - Read settings info from the Zivid camera.
  - Warmup - Short example of a basic way to warm up the camera with specified time and capture cycle.
  - ZividBenchmark - Zividbenchmarks is a sample that will test the average speed of different operations on your computer. It will provide
- Maintenance
  - CorrectCameraInField - Correct the dimension trueness of a Zivid camera.
  - ResetCameraInField - Reset in-field correction on a camera.
  - VerifyCameraInField - Check the dimension trueness of a Zivid camera.
Applications
- Basic
  - Visualization
    - CaptureFromFileCameraVis3D - Capture point clouds, with color, from the virtual Zivid camera, and visualize it. Currently supported by Zivid One.
    - CaptureHDRVisNormals - Capture Zivid point clouds, with color and normals, and visualize it in 3D and as a normal map.
    - CaptureVis3D - Capture point clouds, with color, from the Zivid camera, and visualize it.
    - CaptureWritePCLVis3D - Capture point clouds, with color, from the Zivid camera, save it to PCD file format, and visualize it.
    - ReadPCLVis3D - Read point cloud from PCL file and visualize it.
  - FileFormats
    - ReadIterateZDF - Read point cloud data from a ZDF file, iterate through it, and extract individual points.
- Advanced
  - CaptureUndistortRGB - Use camera intrinsics to undistort an RGB image.
  - CreateDepthMap - Convert point cloud from a ZDF file to OpenCV format, extract depth map and visualize it.
  - Downsample - Downsample point cloud from a ZDF file.
  - HandEyeCalibration - Perform Hand-Eye calibration.
  - MaskPointCloud - Mask point cloud from a ZDF file and convert to PCL format, extract depth map and visualize it.
  - ROIBoxViaArucoMarker - Filter the point cloud based on a ROI box given relative to the ArUco marker.
  - TransformPointCloudFromMillimetersToMeters - Transform point cloud data from millimeters to meters.
  - TransformPointCloudViaArucoMarker - Transform a point cloud from camera to ArUco Marker coordinate frame by estimating the marker’s pose from the
  - HandEyeCalibration
    - PoseConversions - Convert to/from Transformation Matrix (Rotation Matrix + Translation Vector)
    - UtilizeHandEyeCalibration - Transform single data point or entire point cloud from camera frame to robot base frame using Hand-Eye calibration
  - MultiCamera
    - MultiCameraCalibration - Use captures of a calibration object to generate transformation matrices to a single coordinate frame, from connected cameras.
    - MultiCameraCalibrationFromZDF - Use captures of a calibration object to generate transformation matrices to a single coordinate frame, from a ZDF files.
    - StitchByTransformation - Use transformation matrices from Multi-Camera calibration to transform point clouds into single coordinate frame, from connected cameras.
    - StitchByTransformationFromZDF - Use transformation matrices from Multi-Camera calibration to transform point clouds into single coordinate frame, from a ZDF files.

Camera
- Basic
  - Capture - Capture point clouds, with color, from the Zivid camera.
  - Capture2D - Capture 2D images from the Zivid camera.
  - CaptureAssistant - Use Capture Assistant to capture point clouds, with color, from the Zivid camera.
  - CaptureFromFileCamera - Capture point clouds, with color, from the Zivid file camera.
  - CaptureHDR - Capture point clouds, with color, from the Zivid camera.
  - CaptureHDRCompleteSettings - Capture point clouds, with color, from the Zivid camera with fully configured settings.
  - CaptureWithSettingsFromYML - Capture point clouds, with color, from the Zivid camera, with settings from YML file.
- Advanced
  - CaptureHDRLoop - Cover the same dynamic range in a scene with different acquisition settings to optimize for quality, speed, or to find a compromise.
  - CaptureHDRPrintNormals - Capture Zivid point clouds, compute normals and print a subset.
  - CaptureHalconViaGenICam - Capture and save a point cloud, with colors, using GenICam interface and Halcon C++ SDK.
  - CaptureHalconViaZivid - Capture a point cloud, with colors, using Zivid SDK, transform it to a Halcon point cloud and save it using Halcon C++ SDK.
- InfoUtilOther
  - CameraUserData - Store user data on the Zivid camera.
  - CaptureWithDiagnostics - Capture point clouds, with color, from the Zivid camera, with settings from YML file and diagnostics enabled.
  - GetCameraIntrinsics - Read intrinsic parameters from the Zivid camera (OpenCV model).
  - PrintVersionInfo - List connected cameras and print version information.
  - Warmup - A basic warm-up method for a Zivid camera with specified time and capture cycle.
Applications
- Basic
  - Visualization
    - CaptureFromFileVis3D - Capture point clouds, with color, from the Zivid file camera, and visualize them.
    - CaptureVis3D - Capture point clouds, with color, from the Zivid camera, and visualize them.
  - FileFormats
    - ReadIterateZDF - Read point cloud data from a ZDF file, iterate through it, and extract individual points.
    - ZDF2PLY - Convert point cloud from a ZDF file to a PLY file.
- Advanced
  - Downsample - Downsample point cloud from a ZDF file.
  - HandEyeCalibration - Perform Hand-Eye calibration.
  - MultiCameraCalibration - Use captures of a calibration object to generate transformation matrices to a single coordinate frame.
  - TransformPointCloudFromMillimetersToMeters - Transform point cloud data from millimeters to meters.
  - HandEyeCalibration
    - UtilizeHandEyeCalibration - Transform single data point or entire point cloud from camera frame to robot base frame using Hand-Eye calibration

camera
- basic
  - capture - Capture point clouds, with color, from the Zivid camera.
  - capture_2d - Capture 2D images from the Zivid camera.
  - capture_assistant - Use Capture Assistant to capture point clouds, with color, from the Zivid camera.
  - capture_from_file_camera - Capture point clouds, with color, from the Zivid file camera.
  - capture_hdr - Capture point clouds, with color, from the Zivid camera.
  - capture_hdr_complete_settings - Capture point clouds, with color, from the Zivid camera with fully configured settings.
  - capture_with_settings_from_yml - Capture point clouds, with color, from the Zivid camera, with settings from YML file.
- advanced
  - capture_hdr_loop - Cover the same dynamic range in a scene with different acquisition settings to optimize for quality, speed, or to find a compromise.
  - capture_hdr_print_normals - Capture Zivid point clouds, compute normals and print a subset.
- info_util_other
  - capture_with_diagnostics - Capture point clouds, with color, from the Zivid camera, with settings from YML file and diagnostics enabled.
  - print_version_info - Print version information for Python, zivid-python and Zivid SDK, then list cameras and print camera info for each connected camera.
  - warmup - A basic warm-up method for a Zivid camera with specified time and capture cycle.
applications
- basic
  - visualization
    - capture_hdr_vis_normals - Capture Zivid point clouds, compute normals and convert to color map and display.
    - capture_vis_3d - Capture point clouds, with color, from the Zivid camera, and visualize it.
    - read_zdf_vis_3d - Read point cloud data from a ZDF file and visualize it.
  - file_formats
    - convert_zdf - Convert point cloud data from a ZDF file to your preferred format (.ply, .csv, .txt, .png, .jpg, .bmp, .tiff).
    - read_iterate_zdf - Read point cloud data from a ZDF file, iterate through it, and extract individual points.
- advanced
  - color_balance - Balance color of 2D image.
  - create_depth_map - Read point cloud data from a ZDF file, convert it to OpenCV format, then extract and visualize depth map.
  - downsample - Downsample point cloud from a ZDF file.
  - gamma_correction - Capture 2D image with gamma correction.
  - hand_eye_calibration - Perform Hand-Eye calibration.
  - mask_point_cloud - Read point cloud data from a ZDF file, apply a binary mask, and visualize it.
  - hand_eye_calibration
    - pose_conversions - Convert to/from Transformation Matrix (Rotation Matrix + Translation Vector).
    - utilize_hand_eye_calibration - Transform single data point or entire point cloud from camera frame to robot base frame using Hand-Eye calibration
    - ur_hand_eye_calibration
      - universal_robots_perform_hand_eye_calibration - Script to generate a dataset and perform hand-eye calibration using a Universal Robot UR5e robot.
sample_utils
- display - Display relevant data for Zivid Samples.
- paths - Get relevant paths for Zivid Samples.

Installation

Windows

Launch the Command Prompt by pressing Win + R keys on the keyboard, then type cmd and press Enter.

Navigate to a location where you want to clone the repository, then run to following command:

git clone https://github.com/zivid/zivid-cpp-samples

Configure the sample solution with CMake, open it in Visual Studio, build it, run it. For more information see Configure C++ Samples With CMake and Build Them in Visual Studio in Windows.

Ubuntu

Open the Terminal by pressing Ctrl + Alt + T keys on the keyboard.

Navigate to a location where you want to clone the repository, then run to following command:

git clone https://github.com/zivid/zivid-cpp-samples
cd zivid-cpp-samples

Build the project:

mkdir build
cd build
cmake <options, see below> ../source
make -j

Some of the samples depend on external libraries, in particular Eigen 3, OpenCV, PCL, or HALCON. If you don’t want to install those, you can disable the samples depending on them by passing the following options, respectively, to cmake: -DUSE_EIGEN3=OFF, -DUSE_OPENCV=OFF, -DUSE_PCL=OFF, -DUSE_HALCON=OFF.

If you do want to use them:

Eigen 3: Set -DEIGEN3_INCLUDE_DIR=<path> where <path> is the root directory of your Eigen3 installation (the folder containing Eigen/Core, Eigen/Dense etc.)
PCL and OpenCV: If a recent enough version is installed on your system, these should just work. If not, set -DPCL_DIR=<path> / -DOpenCV_DIR=<path> where <path> is the directory containing PCLConfig.cmake and OpenCVConfig.cmake, respectively.
HALCON: If a recent enough version is installed on your system, these should just work.

The samples can now be run from the build directory, for instance like this:

./CaptureFromFileCameraVis3D

For more information visit the GitHub zivid-cpp-samples repository.

Launch the Command Prompt by pressing Win + R keys on the keyboard, then type cmd and press Enter.

Navigate to a location where you want to clone the repository, then run to following command:

git clone https://github.com/zivid/zivid-csharp-samples

Open ZividNETSamples.sln in Visual Studio, build it and run it. If you are uncertain about doing this, check out Build C# Samples using Visual Studio.

Some of the samples depend on external libraries, in particular YamlDotNet and MathNet.Numerics. These libraries will be installed automatically through NuGet when building the sample.

For more information visit the GitHub zivid-csharp-samples repository.

Install Zivid Software
Install Zivid Python. Note: The recommended Python version for these samples is 3.8.
Download Zivid Sample Data
[Optional] Launch the Python IDE of your choice. Read our instructions on setting up Python.
Install the runtime requirements using IDE or command line:
```
pip install -r requirements.txt
```
Add the directory source to PYTHONPATH. Navigate to the root of the repository and run:

PowerShell: $env:PYTHONPATH=$env:PYTHONPATH + ";$PWD\source"

cmd: set PYTHONPATH="$PYTHONPATH;$PWD\source"

bash: export PYTHONPATH="$PYTHONPATH:$PWD/source"

Open and run one of the samples.

For more information visit the GitHub zivid-python-samples repository.