Toolbar

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

Save and Open

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:

Note

.zdf is the native Zivid file format that includes point cloud, color image, and depth image data.

• 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 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) [1] file format:

• Click on File → Export

• Navigate to the location where you want to save the point cloud

• Write down the file name

• Click Save

[1] (1,2)

PCD is by default exported as unorganized points but can be configured to be exported as organized points. See Organized PCD format for tutorial on how to export PCD as organized points.

Open Point Cloud

Opening a point cloud in Zivid Studio is only supported for ZDF file format:

• Click on File → Open

• Navigate to the location of your ZDF file

• Click Open

Tip

Drag and drop a ZDF file to load the point cloud to Zivid Studio - added in Zivid SDK 2.5.

Save Color Image

You can also 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.

• Click on File → Save Color Image

• Navigate to the location where you want to save the color image

• Write down the file name

• Select image format type and color space

• Click Save

Save Depth Map

You can also save the colored depth map in PNG format.

• Click on File → Save Depth Map

• Navigate to the location where you want to save the depth map

• 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

Tip

Drag and drop a YML file to import the settings to Zivid Studio - added in Zivid SDK 2.5.

Settings can be loaded using the Zivid SDK as well.

C++

source

std::cout << "Loading settings from file" << std::endl;
const auto settingsFile =
    std::string(ZIVID_SAMPLE_DATA_DIR) + "/Settings/" + settingsFolder(camera) + "/Settings01.yml";
const auto settings = Zivid::Settings(settingsFile);

C#

source

Console.WriteLine("Loading settings from file");
var settingsFile = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData)
                   + "/Zivid/Settings/" + SettingsFolder(camera) + "/Settings01.yml";
var settings = new Zivid.NET.Settings(settingsFile);

Python

source

print("Loading settings from file")
settings_file = Path(user_options.settings_path)
settings = zivid.Settings.load(settings_file)

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.

Dropdown Menus

File Dropdown Options

File	Shortcut	Function
Open	Ctrl+O	Load a ZDF file. .zdf is the native Zivid file format that includes point cloud, color image, and depth image data.
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) [1] 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.
Import Capture Settings	Ctrl+Shift+I	Load saved capture settings from a file in YML into Zivid Studio
Export 2D Capture Settings	Ctrl+Alt+Shift+E	Save current 2D capture settings from Zivid Studio into a file in YML.
Export 3D Capture Settings	Ctrl+Shift+E	Save current 3D capture settings from Zivid Studio into a file in YML.
Exit	Alt+F4	Exit Zivid Studio.

View Dropdown Options

View	Shortcut	Function
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.
Reset View	Backspace	Reset the point cloud, color image, and depth image view back to the default view.
Reset 3D view when opening files	N/A	Enable/disable 3D view reset when opening files.
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.

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: Quick Reference Index

Version History

SDK	Changes
2.12.0	Save depth map is added.