Settings Class

Constructor

Construct Settings by loading from file

Specify the settings used for the 2D color image when doing a 2D+3D capture. The value type of this node is a `Zivid::Settings2D` object. This setting was introduced in SDK 2.14, as the recommended way to define the acquisition and processing settings for the 2D color image when doing 2D+3D captures. When this setting is set, it controls how the 2D color image of the 2D+3D capture is acquired and processed. This setting can be used to specify custom acquisition and processing settings that apply only to the 2D color image. These provided settings does not affect the 3D acquisition or processing. When this setting is not set, then the 2D color image is acquired based on `Settings/Acquisitions` and `Settings/Sampling/Color`, and processed based on `Settings/Processing/Color`. If `Settings/Sampling/Color` is set to `disabled`, then no 2D color image is acquired. This behavior is to be consistent with SDK 2.13 and earlier. In the next SDK major version, SDK 3.0, only this `Color` setting will control the 2D color image settings. The `Settings/Sampling/Color` and `Settings/Processing/Color` settings are deprecated as of 2.14, and will be removed from the API in SDK 3.0. Zivid recommends all users to use `Settings/Color` to define the 2D color image settings. Tip: If you want to convert an existing settings.yml file to use `Settings/Color`, you can import the .yml file into Zivid Studio and then re-export it to .yml.

Set the Zivid Vision Engine to use. The Phase Engine is the fastest choice in terms of both acquisition time and total capture time, and is a good compromise between quality and speed. The Phase Engine is recommended for objects that are diffuse, opaque, and slightly specular, and is suitable for applications in logistics such as parcel induction. The Stripe Engine is built for exceptional point cloud quality in scenes with highly specular reflective objects. This makes the engine suitable for applications such as factory automation, manufacturing, and bin picking. Additional acquisition and processing time are required for the Stripe Engine. The Omni Engine is built for exceptional point cloud quality on all scenes, including scenes with extremely specular reflective objects, as well as transparent objects. This makes the Omni Engine suitable for applications such as piece picking. Same as for the Stripe Engine, it trades off speed for quality. The Omni Engine is only available for Zivid 2+. The Sage engine is built for use cases that require all points to be correct/accurate with particularly high confidence. This can be very suitable for eliminating problems such as reflection artifacts. This validation comes at the cost of speed, and sometimes reduced number of valid points due to the removal of low-confidence data. The Sage Engine is only available for Zivid 2+R. The Sage Engine is an experimental engine. This involves that it can be changed or removed in the future.

Create a clone (deep copy) of the current instance

Create a clone (deep copy) of the current instance and invoke delegate on the clone

Construct a new Settings instance from a previously serialized string

Load from the given file

Save to the given file

Serialize to a string

Get string representation of the object