Control Panel

The control panel is located on the right side of Zivid Studio. It contains three main sections:

  • Cameras

  • Capture

  • Settings and Filters

Cameras

This section is used to scan for, configure, connect to, and disconnect from available cameras.


Camera Dropdown Options

Cameras

Function

List all cameras

Open the Cameras menu and list all cameras.

Scan for connected cameras

Show all cameras plugged into the PC and list them by model and serial number.

Connect

Connect to the camera selected in the drop-down menu. Zivid Studio can connect to a single camera at a time.

Configure this camera

Open the Cameras menu and configure the IP, subnet mask and mode of the selected camera.

Disconnect from active camera

Disconnect from the active camera.

Note

If multiple cameras are physically connected, they will all appear in this section. However, Zivid Studio only supports establishing a connection with a single camera at a time. To capture with multiple cameras using Zivid Studio, start another instance of Zivid Studio.

Firmware Update

Each SDK version is matched with camera firmware, and the SDK will make sure that the camera runs compatible firmware. When Zivid Studio connects to a camera, it will check whether the camera has matching firmware. If the firmware does not match, you will get prompted to update the firmware on your camera. Read more about Firmware Update.

../../_images/studio-firmware-update.png

Capture

This section is used to capture 3D and 2D images. Here you can control and configure the camera settings. This section has two modes:

  • 3D capture

  • 2D capture

3D Capture

The 3D capture has two modes:

  • Assisted Mode

  • Manual Mode

Assisted Mode

The assisted modes are:

  • Presets

  • Auto (Scene analysis)

Presets

This mode is the easiest to use.

Part of the Zivid SDK is the presets, a set of pre-tuned settings. These presets are aimed to simplify tuning of the camera parameters and are an alternative to Capture Assistant. While Capture Assistant tries to optimize exposure settings for any scene depending on a time budget, presets are specifically tuned for the following categories:

  • Consumer Goods

  • Parcels

  • Manufacturing

  • Inspection

Within each category, you will find various presets. These are separated by scene complexity, working distance or by the typical type of material property of objects within that. Different cameras have different presets based on what they are commonly used for.

At the bottom of this page you will also find ambient light adapted presets and presets for Halcon.

../../_images/control_panel_presets.png

Once a preset is selected the ambient light adaptation can be chosen.

../../_images/control_panel_presets_ambient_light_frequency.png

Note

Ambient light adaptation can increase acquisition and capture time. Default presets do not adapt to any ambient light frequency.

Check Presets to learn more.

Auto (Scene analysis)

This mode also very easy to use.

  • Specify Max Capture Time

  • Click Analyze & Capture

../../_images/studio-assisted-capture-analysis.png

This triggers the camera to analyze the scene and output the camera settings required to cover as much of the dynamic range in the scene as possible. Immediately after this, the camera performs a second capture using these settings.

  • Capture performs a capture with the settings suggested by the assisted capture, without additional scene analysis.

  • Ambient Light Adaptation is used when ambient light (AC powered) is mixed with the camera’s projector. Select your power grid frequency from the drop-down menu:

    • 60 Hz is typically used in Japan, Americas, Taiwan, South Korea, and the Philippines.

    • 50 Hz is typically used elsewhere.

../../_images/studio-assisted-capture.png

Acquisition and filter settings appear at the bottom right corner of the “Capture” section after camera captures.

Manual Mode

In the manual mode, users must configure all settings and filters manually.

Capture and Live

  • The Capture button captures a single acquisition or a multi-acquisition HDR with the specified settings, which is then displayed.

  • The Live button triggers continuous captures, which enables you to view the scene in real-time.

../../_images/studio-capture-manual.png

For high dynamic range scenes, it is necessary to use multi-acquisition HDR. In this mode, the camera captures one image per acquisition. Each image captured uses the settings configured for the specific acquisition. These images are then automatically merged into a single, high-quality HDR frame.

../../_images/studio-capture-hdr.png

Once you select the manual mode, you can click the Add Acquisition button to add additional acquisitions. By default, each new acquisition added uses the settings of the previous acquisition. You can clone a specific acquisition by clicking on the three dots next to that acquisition and then on the Clone acquisition option. Use the same menu to reset acquisition settings or delete individual acquisitions. Disable or enable acquisitions with the checkbox.

Click the Capture button to capture an image with the acquisition settings specified; unchecked acquisitions are ignored by the capture.

You can also use the Assisted mode to get suggested settings, and then switch to the Manual mode to fine-tune these settings manually. For more information about the settings panel see Settings and Filters.

2D Capture

The 2D capture only has a manual mode, where the user configures 2D capture settings manually.

Capture and Live

  • The Capture button captures a single acquisition with the specified settings, which is then displayed.

  • The Live button triggers continuous captures, which enables you to view the scene in real-time.

Settings and Filters

All of the settings and filters listed here apply to 3D capture. Acquisition settings are also used in 2D capture. No filters are available for 2D capture. Some other settings are also available for 2D capture.

Engine (only 3D)

The Vision Engine is the backbone of the point cloud computation. It controls the pattern projecting, imaging, and processing of the images of the projected pattern to generate the final 3D point cloud.

Engine Options

Options

Function

Engine

Choose between different pattern projections.

Reset to default

Reset the Engine to the default value.
../../_images/control_panel_engine.png

Check Vision Engine to learn more.

Sampling

Sampling Options

Setting

Function

Color (only 3D)

Selectively include or exclude color information in the captured point cloud.

Pixel

Choose the light color of the projected patterns and sampled pixels; this affects the point cloud resolution.
../../_images/control-panel-sampling.png

Check Sampling to learn more.

Exposure Settings

Exposure Options

Setting

Function

Exposure Time

The duration a single camera image is exposed to light.

Aperture Step/F-number

The opening that controls the amount of light to the camera sensor through the lens.

Brightness

The output power (the amount of light) emitted by the LED projector.

Gain

The amplification of the signal from the camera sensor.
../../_images/control_panel_acquisition_settings.png

To learn how to tune settings check Capturing High Quality Point Clouds.

Region Of Interest (only 3D)

Region of Interest Options

Setting

Function

Box

Create and configure a box in 3D and remove the points outside the box.

Depth

Remove points outside a user-defined depth range.
../../_images/control_panel_roi.png

Check Region of Interest to learn more.

Filters (only 3D)

Filter Options

Setting

Function

Cluster Filter

Remove floating points and isolated clusters from the point cloud.

Hole Repair

Fill in removed points, by interpolation between the remaining points.

Noise Filter

Remove or correct points where the projected pattern signal-to-noise-ratio is low.

Outlier Filter

Remove points if the distance to their neighboring pixels within the small local region is larger than the threshold specified in mm.

Reflection Filter

Remove points impacted by reflections and thus erroneous.

Gaussian Smoothing

Perform Gaussian smoothing on the point cloud.

Contrast Distortion

Correct and/or remove points affected by blurring in the camera lens.
../../_images/control_panel_filters.png

To learn how to tune filters check Capturing High Quality Point Clouds.

Color

Color Options

Setting

Function

Balance

The color temperature of ambient light affects the appearance of the color image. Adjust blue, green, and red color balance to make color images look natural.

Gamma

The output color image can appear too dark. Adjust the brightness of the color image.

Color Mode (only 3D)

Control how the color image is computed. The options are Automatic, ToneMapping, or UseFirstAcquisition.
../../_images/control_panel_color.png

To learn how to tune color settings check Optimizing Color Image and Adjusting Color Balance.

Diagnostics (only 3D)

The diagnostics setting is used to collect extra diagnostic data from a capture. When this setting is enabled the additional data will be saved in the .zdf file. It is recommended to only enable it when reporting issues to Zivid’s support team.

../../_images/control_panel_diagnostics.png

Caution

Diagnostics increases the capture time, the RAM usage, and the size of the .zdf file.

Continue reading about Zivid Studio in Available Views.

Version History

SDK

Changes

2.12.0

Reorganized page to clarify that 2D settings are a subset of the 3D settings.