Toolbar

The toolbar is located at the top of Zivid Studio. It consists of drop-down menus to handle files, control the GUI, configure cameras and get information about the Zivid software.

File

Zivid Studio offers various saving options for point clouds, color images, and settings to disk.

Save/Export Point Cloud

To save the point cloud in file ZDF format:

Click on File → Save.
Navigate to the location where you want to save the point cloud.
Write down the file name.
Click Save.

Note

ZDF is the native Zivid file format that includes point cloud, color image, and depth image data, and is the preferred file format for the Zivid Customer Success Team.

To export to one of our supported point cloud formats, unordered or ordered Polygon (PLY), ASCII (XYZ), or Point Cloud Data (PCD) file format:

Click on File → Export.
Navigate to the location where you want to save the point cloud.
Write down the file name.
Select the file format type.
Click Save.
Choose Export options.
Click Export.

../../../_images/ply-export-options.png — Export options for PLY, PCD, and XYZ file formats.

../../../_images/pcd-export-options.png — Export options for PLY, PCD, and XYZ file formats.

Open Point Cloud / File Camera

Opening a point cloud in Zivid Studio is only supported for ZDF file format. A file camera can be opened in Zivid Studio in the ZFC file format.

Click on File → Open.
Navigate to the location of your ZDF / ZFC file.
Click Open.

You can also drag and drop a ZDF / ZFC file into Zivid Studio, or double-click it.

To open or create a file camera from the Cameras panel, click the ⋯ menu and select one of:

Open ZDF file as file camera - loads a ZDF file as a file camera.
Use captured frame as file camera - creates a file camera from the frame currently displayed in the viewer.

See File Camera for details.

Save Color Image / Depth Map / SNR Map / Normal Map

You can save the 2D color image in one of our supported image formats, PNG, BMP and JPG. For all formats, you can choose between sRGB and linear RGB color space. The Depth Map, SNR Map and Normal Map can only be saved in PNG format.

Click on File → Save Color Image / Save Depth Map / Save SNR Map / Save Normal Map.
Navigate to the location where you want to save the image.
Write down the file name.
Click Save.

Export Settings

It is possible to save all settings to disk.

Click on File → Export Capture Settings.
Navigate to the location where you want to save the settings.
Write down the file name.
Click Save.

Import Settings

To import the settings in Zivid Studio:

Click on File → Import Capture Settings.
Navigate to the location of your settings file.
Click Open.

You can also drag and drop a YML file into Zivid Studio to import the settings.

Preferences

To open and modify Zivid Studio preferences:

Click on File → Preferences.
Check the boxes to enable the desired preferences.

You can read more about Preferences in Configuration files.

View

2D Color Image Histogram

To show the 2D image histogram:

Click on View → 2D Color Image Histogram.
Swap between Linear and Logarithmic to change scales.

Information

To open the information panel:

Click View → Information or Information in the bottom right corner.

It is available only after you load a point cloud from a ZDF file or capture a point cloud or a color image.

The top part of the Information panel shows Acquisition Time, Capture Time, and Point Cloud / Color Image Size.

../../../_images/studio-dropdowns-and-information.png

The bottom part shows the settings that were used in the capture. It is possible to save these settings to a file or apply them for use in the next capture.

../../../_images/studio-information-panel-settings.png

3D Axis Indicator

A 3D axis indicator is displayed in the bottom left corner of the point cloud view. To disable/enable it, click on View → 3D Axis Indicator.

Show 4x4 Aruco Markers

To highlight any 4x4 Aruco markers in the point cloud, click on View → Show 4x4 Aruco Markers.

../../../_images/studio-aruco-marker.png

Show barcodes

To show barcodes detected in the 2D image, click on View → Show barcodes.

../../../_images/zivid-studio-detected-barcodes.png

Configure barcodes to detect

To configure which barcodes to detect in the 2D image, click on View → Configure barcodes to detect.

../../../_images/zivid-studio-configure-barcodes.png

Reset 3D View When Opening Files

To control whether the 3D view is reset to the default view each time you open a file, toggle View → Reset 3D View When Opening Files.

Reset View

To reset the point cloud, color image, and depth image view back to the default view, click View → Reset View, or press Backspace.

Reset UI Layout

To restore the Zivid Studio window to its default layout, click View → Reset UI Layout.

Full Screen Mode

To toggle between full screen and regular screen mode, click View → Enter Full Screen Mode / Exit Full Screen Mode, or press F11.

Cameras

All Cameras

To open the Cameras menu:

Click on Cameras → All Cameras.

This will list all discovered cameras and their serial numbers, models, IP addresses and statuses.

../../../_images/studio-cameras-menu-multiple.png

The status-field allows the following actions:

Connect to connect to the camera if it is available.
Disconnect to disconnect from the camera if it is connected.
Update to update the firmware of the camera if it is available but needs a firmware update.
Remove to remove the camera from the list if it is no longer found.

You can change the network configuration of any discovered camera by clicking Configure. This will open the camera network configuration.

../../../_images/studio-cameras-configure.png

Here you can set the camera to use DHCP or a specific static IP address, and apply the configuration to the camera by clicking Apply. The status of the camera may change after applying the network configuration.

Health Check

The Health Check reports the status of a connected camera, aggregating several individual checks (such as temperatures, fan, memory, and transfer speed) into an overall status. This gives a quick overview of whether the camera is operating within its specified range.

To run a health check, open the Cameras menu (Cameras → All Cameras) and click Check on the row of a connected camera. The Check button becomes active once the camera is connected.

To read the same health check status programmatically, see Camera Health Check.

Tools

Infield Correction

To open the Infield Correction tool:

Click on Tools → Infield Correction.

Infield Correction functionality overview

Last correction shows the last date and time an infield correction was written to the camera.

Capture & Measure captures to determine the local dimension trueness error of the point cloud where the Zivid calibration board is placed.

Current Camera Metrics shows the local dimension trueness error for the last capture taken with Capture & Measure, as well as the average and the maximum for all the captures.

Current trueness shows the local dimension trueness error for the last capture taken with Capture & Measure.

Average trueness shows the average of the local dimension trueness errors for all the captures taken with Capture & Measure so far.

Maximum trueness shows the maximum of the local dimension trueness errors for all the captures taken with Capture & Measure so far.

Expected Post-Correction Metrics shows the estimated post-correction error within 1σ statistical uncertainty over the working distances the images were captured at.

Save Correction to Camera writes to the camera the parameters for improving the accuracy of the point cloud determined from the captures of the Zivid calibration board taken with Capture & Measure.

Reset Camera Correction removes any infield correction that has been applied in previous correct instances. It is not required to do a reset before doing a new infield correction.

Learn more about Infield Correction.

Help

View Help Online

To open the Zivid Knowledge Base in your browser, click Help → View Help Online.

About Zivid Studio

To view detailed information about Zivid, third-party software licenses, and system info, click Help → About Zivid Studio.

Dropdown Menus

File Dropdown Options
File	Shortcut	Function
Open	`Ctrl`+`O`	Load a ZDF or ZFC file. ZDF is the native Zivid file format that includes point cloud, color image, and depth image data. ZFC is the native Zivid file format that contains a file camera.
Save	`Ctrl`+`S`	Save a point cloud, color image, and depth image data to a ZDF file, the native Zivid file format.
Export	`Ctrl`+`E`	Export a point cloud data to a file in unordered or ordered Polygon (PLY), ASCII (XYZ), or Point Cloud Data (PCD) file format.
Save Color Image	N/A	Save a color image to a file in PNG, BMG, or JPG file format.
Save Depth Map	N/A	Save a colored depth map to a file in PNG file format.
Save SNR Map	N/A	Save a colored SNR map to a file in PNG file format.
Save Normal Map	N/A	Save a colored normal map to a file in PNG file format.
Import Capture Settings	`Ctrl`+`Shift`+`I`	Load saved capture settings from a file in YML into Zivid Studio.
Export Capture Settings	`Ctrl`+`Shift`+`E`	Save current capture settings from Zivid Studio into a file in YML.
Preferences	N/A	Open the Preferences menu to configure Zivid Studio settings.
Exit	`Alt`+`F4`	Exit Zivid Studio.

View Dropdown Options
View	Shortcut	Function
2D Color Image Histogram	`H`	Open the Histogram, a tool for analyzing pixel intensity distribution on an image.
Information	`Shift`+`I`	Open the Information panel to display capture information such as camera model, acquisition time, capture time and settings used. Provides ability to apply or save settings from previous captured point cloud.
3D Axis Indicator	`Ctrl`+`Shift`+`A`	Show or hide the 3D axis indicator in the 3D view.
Show 4x4 Aruco Markers	`Ctrl`+`M`	Highlight 4x4 Aruco markers in the point cloud.
Show barcodes	N/A	Highlight barcodes detected in the 2D image.
Configure barcodes to detect	N/A	Select specific types of linear and matrix barcodes to detect.
Reset 3D view when opening files	N/A	Enable/disable 3D view reset when opening files.
Reset View	`Backspace`	Reset the point cloud, color image, and depth image view back to the default view.
Reset UI Layout	N/A	Reset the layout of the Zivid Studio window.
Enter/Exit Full Screen Mode	`F11`	Toggle between full and regular screen mode.

Cameras Dropdown Options
Cameras	Shortcut	Function
All Cameras	`Ctrl`+`Shift`+`C`	Open the Cameras menu to list and configure all discovered cameras. Each connected camera row has a Check button that runs a health check on that camera.

Tools Dropdown Options
Tools	Function
Infield Correction	Open Infield Correction, a maintenance tool designed to verify and correct the dimension trueness of Zivid cameras.

Help Dropdown Options
Help	Function
View Help Online	URL to the Zivid Knowledge Base.
About Zivid Studio	Detailed information about Zivid, third-party software licenses and system info.

Continue reading about Zivid Studio in Quick Reference Index.

Version History

SDK	Changes
2.18.0	Health Check is added to the Cameras menu, and Open ZDF file as file camera and Use captured frame as file camera actions are added to the Cameras panel in the File → Open section.
2.17.0	Show barcodes and Configure barcodes to detect are added to View.
2.15.0	Preferences is added to File, and export options are added to Export.
2.14.0	Save Normal Map and SNR Map is added to File, and 3D Axis Indicator and Aruco markers are added to View.
2.13.0	Cameras menu is added to the toolbar.
2.12.0	Save Depth Map is added and acquisition time is added to the information panel.