Capture Tutorial

Introduction 

To capture a point cloud or 2D image with a Zivid camera: initialize the Zivid application, connect to the camera, configure capture settings, then capture and save the result.

For the corresponding API, see Camera Basic.

Prerequisites

Install Zivid Software.
For Python: install zivid-python

Initialize 

Calling any of the APIs in the Zivid SDK requires initializing the Zivid application and keeping it alive while the program runs.

Note

Application must be kept alive while operating the Zivid Camera. This is essentially the Zivid driver.

C++

Zivid::Application zivid;

C#

var zivid = new Zivid.NET.Application();

Python

app = zivid.Application()

File Camera 

With a file camera, you can experiment with the SDK without access to a physical camera. The file cameras can be found in Sample Data where there are multiple file cameras to choose from.

C++

const auto fileCamera =
    userInput ? fileCameraPath : std::string(ZIVID_SAMPLE_DATA_DIR) + "/FileCameraZivid2PlusMR60.zfc";

C#

fileCamera = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData) + "/Zivid/FileCameraZivid2PlusMR60.zfc";

Python

default=get_sample_data_path() / "FileCameraZivid2PlusMR60.zfc",

C++

std::cout << "Creating virtual camera using file: " << fileCamera << std::endl;
auto camera = zivid.createFileCamera(fileCamera);

C#

Console.WriteLine("Creating virtual camera using file: " + fileCamera);
var camera = zivid.CreateFileCamera(fileCamera);

Python

print(f"Creating virtual camera using file: {file_camera}")
camera = app.create_file_camera(file_camera)

The acquisition settings must be initialized as shown in the example that follows, but you are free to alter the processing settings.

C++

std::cout << "Configuring settings" << std::endl;
Zivid::Settings settings{
    Zivid::Settings::Acquisitions{ Zivid::Settings::Acquisition{} },
    Zivid::Settings::Processing::Filters::Smoothing::Gaussian::Enabled::yes,
    Zivid::Settings::Processing::Filters::Smoothing::Gaussian::Sigma{ 1.5 },
    Zivid::Settings::Processing::Filters::Reflection::Removal::Enabled::yes,
    Zivid::Settings::Processing::Filters::Reflection::Removal::Mode::global,
};
settings.set(
    Zivid::Settings::RegionOfInterest::Box{
        Zivid::Settings::RegionOfInterest::Box::Enabled::yes,
        Zivid::Settings::RegionOfInterest::Box::PointO{ { -266, 190, 771 } },
        Zivid::Settings::RegionOfInterest::Box::PointA{ { 203, 207, 771 } },
        Zivid::Settings::RegionOfInterest::Box::PointB{ { -255, -131, 771 } },
        Zivid::Settings::RegionOfInterest::Box::Extents{ 0, 298 } });

Zivid::Settings2D settings2D{ Zivid::Settings2D::Acquisitions{ Zivid::Settings2D::Acquisition{} } };
settings.color() = Zivid::Settings::Color{ settings2D };

C#

Console.WriteLine("Configuring settings");
var settings2D = new Zivid.NET.Settings2D
{
    Acquisitions = { new Zivid.NET.Settings2D.Acquisition { } }
};
var settings = new Zivid.NET.Settings
{
    Acquisitions = { new Zivid.NET.Settings.Acquisition { } },
    Processing =
    {
        Filters =
        {
            Smoothing =
            {
                Gaussian = { Enabled = true, Sigma = 1.5 }
            },
            Reflection =
            {
                Removal = { Enabled = true, Mode = ReflectionFilterModeOption.Global}
            }
        }
    }
};
var roiBox = new Zivid.NET.Settings.RegionOfInterestGroup.BoxGroup
{
    Enabled = true,
    PointO = new Zivid.NET.PointXYZ { x = -266, y = 190, z = 771 },
    PointA = new Zivid.NET.PointXYZ { x = 203, y = 207, z = 771 },
    PointB = new Zivid.NET.PointXYZ { x = -255, y = -131, z = 771 }
};
roiBox.Extents = new Zivid.NET.Range<double>(0, 298);
settings.RegionOfInterest.Box = roiBox;
settings.Color = settings2D;

Python

print("Configuring settings")
settings = zivid.Settings()
settings.acquisitions.append(zivid.Settings.Acquisition())
settings.processing.filters.smoothing.gaussian.enabled = True
settings.processing.filters.smoothing.gaussian.sigma = 1.5
settings.processing.filters.reflection.removal.enabled = True
settings.processing.filters.reflection.removal.mode = (
    zivid.Settings.Processing.Filters.Reflection.Removal.Mode.global_
)
settings.region_of_interest.box = zivid.Settings.RegionOfInterest.Box(
    enabled=True,
    point_o=(-266, 190, 771),
    point_a=(203, 207, 771),
    point_b=(-255, -131, 771),
    extents=(0, 298),
)
settings_2d = zivid.Settings2D()
settings_2d.acquisitions.append(zivid.Settings2D.Acquisition())
settings.color = settings_2d

You can read more about the file camera option in File Camera.

Multithreading 

Operations on camera objects are thread-safe, but other operations like listing cameras and connecting to cameras must be executed in sequence. Find out more in Multithreading.

Conclusion 

This tutorial shows how to use the Zivid SDK to connect to, configure, capture, and save from the Zivid camera.

Version History

SDK	Changes
2.18.0	Added connecting to a camera by IP address or hostname.

Capture Tutorial

Introduction 

Initialize 

Connect 

Specific Camera 

Configure 

Presets 

Load 

Save 

Manual configuration 

Single 2D and 3D Acquisition - Default settings

Multi Acquisition HDR

Fully Configured Settings

Capture 2D3D 

Capture 3D 

Capture 2D 

Save 

Export 

Load 

Save 2D 

Get image (Linear RGB)

Get image (sRGB)

Save image (Linear RGB)

Save image (sRGB)

File Camera 

Multithreading 

Conclusion 

Version History