Settings.h File Reference

#include <array>
#include <chrono>
#include <cmath>
#include <ctime>
#include <iomanip>
#include <memory>
#include <set>
#include <sstream>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
#include "Zivid/DataModel/Attributes.h"
#include "Zivid/DataModel/Detail/Detail.h"
#include "Zivid/DataModel/NodeType.h"
#include "Zivid/DataModel/Traits.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Detail/TypeTraits.h"
#include "Zivid/Point.h"
#include "Zivid/Range.h"

Go to the source code of this file.

Classes
class	Zivid::Settings
	Settings used when capturing with a Zivid camera. More...
class	Zivid::Settings::Acquisition
	Settings for a single acquisition. More...
class	Zivid::Settings::Acquisition::Aperture
	Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter). More...
class	Zivid::Settings::Acquisition::Brightness
	Brightness controls the light output from the projector. More...
class	Zivid::Settings::Acquisition::ExposureTime
	Exposure time for each single image in the measurement. Affects frame rate. More...
class	Zivid::Settings::Acquisition::Gain
	Analog gain in the camera. More...
class	Zivid::Settings::Acquisitions
	List of Acquisition objects. More...
class	Zivid::Settings::Diagnostics
	When Diagnostics is enabled, additional diagnostic data is recorded during capture and included when saving the frame to a .zdf file. This enables Zivid's Customer Success team to provide better assistance and more thorough troubleshooting. More...
class	Zivid::Settings::Diagnostics::Enabled
	Enable or disable diagnostics. More...
class	Zivid::Settings::Engine
	Set the Zivid Vision Engine to use. More...
class	Zivid::Settings::Processing
	Settings related to processing of a capture, including filters and color balance. More...
class	Zivid::Settings::Processing::Color
	Color settings. More...
class	Zivid::Settings::Processing::Color::Balance
	Color balance settings. More...
class	Zivid::Settings::Processing::Color::Balance::Blue
	Digital gain applied to blue channel. More...
class	Zivid::Settings::Processing::Color::Balance::Green
	Digital gain applied to green channel. More...
class	Zivid::Settings::Processing::Color::Balance::Red
	Digital gain applied to red channel. More...
class	Zivid::Settings::Processing::Color::Experimental
	Experimental color settings. These may be renamed, moved or deleted in the future. More...
class	Zivid::Settings::Processing::Color::Experimental::Mode
	This setting controls how the color image is computed. More...
class	Zivid::Settings::Processing::Color::Gamma
	Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker. More...
class	Zivid::Settings::Processing::Filters
	Filter settings. More...
class	Zivid::Settings::Processing::Filters::Cluster
	Removes floating points and isolated clusters from the point cloud. More...
class	Zivid::Settings::Processing::Filters::Cluster::Removal
	Cluster removal filter. More...
class	Zivid::Settings::Processing::Filters::Cluster::Removal::Enabled
	Enable or disable cluster removal. More...
class	Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance
	Maximum normalized distance between neighboring points that are still classified as belonging to the same cluster. The default value is optimal for most scenes. On messy scenes turning this setting down helps removing more bad points. More...
class	Zivid::Settings::Processing::Filters::Cluster::Removal::MinArea
	Clusters with area below this threshold are removed by the filter. The area is given in mm^2. More...
class	Zivid::Settings::Processing::Filters::Experimental
	Experimental filters. These may be renamed, moved or deleted in the future. More...
class	Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion
	Corrects artifacts that appear when imaging scenes with large texture gradients or high contrast. These artifacts are caused by blurring in the lens. The filter works best when aperture values are chosen such that the camera has quite good focus. The filter also supports removing the points that experience a large correction. More...
class	Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction
	Contrast distortion correction filter. More...
class	Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled
	Enable or disable contrast distortion correction. More...
class	Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength
	Strength of correction. Higher values give more correction. More...
class	Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal
	Contrast distortion removal filter. More...
class	Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled
	Enable or disable contrast distortion removal. More...
class	Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold
	Threshold for removal. Higher values remove more points. More...
class	Zivid::Settings::Processing::Filters::Hole
	Contains filters that can be used to deal with holes in the point cloud. More...
class	Zivid::Settings::Processing::Filters::Hole::Repair
	Fills in point cloud holes by interpolating remaining surrounding points. More...
class	Zivid::Settings::Processing::Filters::Hole::Repair::Enabled
	Enable or disable hole repair. More...
class	Zivid::Settings::Processing::Filters::Hole::Repair::HoleSize
	Relative diameter of holes to fill. Increasing this will fill more points, but require more computation time. The maximum allowed hole size scales with distance, so that we allow filling larger holes at greater distances, measured in mm. More...
class	Zivid::Settings::Processing::Filters::Hole::Repair::Strictness
	Level of strictness when considering if a point should be filled. A higher level of strictness requires a missing point to be surrounded by valid points on more sides in order to be filled. Increasing this will fill fewer points, but it will be less likely to fill gaps that are not circular, for example between two edges. More...
class	Zivid::Settings::Processing::Filters::Noise
	Contains filters that can be used to clean up a noisy point cloud. More...
class	Zivid::Settings::Processing::Filters::Noise::Removal
	Discard points with signal-to-noise ratio (SNR) values below a threshold. More...
class	Zivid::Settings::Processing::Filters::Noise::Removal::Enabled
	Enable or disable the SNR filter. More...
class	Zivid::Settings::Processing::Filters::Noise::Removal::Threshold
	Discard points with signal-to-noise ratio (SNR) below the given value. More...
class	Zivid::Settings::Processing::Filters::Noise::Repair
	Get better surface coverage by repairing regions of missing data due to noisy points. Consider disabling this filter if you require all points in your point cloud to be of high confidence. More...
class	Zivid::Settings::Processing::Filters::Noise::Repair::Enabled
	Enable or disable noise repair. More...
class	Zivid::Settings::Processing::Filters::Noise::Suppression
	Reduce noise and outliers in the point cloud. This filter can also be used to reduce ripple effects caused by interreflections. Consider disabling this filter if you need to distinguish very fine details and thus need to avoid any smoothing effects. More...
class	Zivid::Settings::Processing::Filters::Noise::Suppression::Enabled
	Enable or disable noise suppression. More...
class	Zivid::Settings::Processing::Filters::Outlier
	Contains a filter that removes points with large Euclidean distance to neighboring points. More...
class	Zivid::Settings::Processing::Filters::Outlier::Removal
	Discard point if Euclidean distance to neighboring points is above a threshold. More...
class	Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled
	Enable or disable the outlier filter. More...
class	Zivid::Settings::Processing::Filters::Outlier::Removal::Threshold
	Discard point if Euclidean distance to neighboring points is above the given value. More...
class	Zivid::Settings::Processing::Filters::Reflection
	Contains a filter that removes points likely introduced by reflections (useful for shiny materials). More...
class	Zivid::Settings::Processing::Filters::Reflection::Removal
	Discard points likely introduced by reflections (useful for shiny materials). More...
class	Zivid::Settings::Processing::Filters::Reflection::Removal::Enabled
	Enable or disable the reflection filter. Note that this filter is computationally intensive and may affect the frame rate. More...
class	Zivid::Settings::Processing::Filters::Reflection::Removal::Mode
	The reflection filter has two modes: Local and Global. Local mode preserves more 3D data on thinner objects, generally removes more reflection artifacts and processes faster than the Global filter. The Global filter is generally better at removing outlier points in the point cloud. It is advised to use the Outlier filter and Cluster filter together with the Local Reflection filter. More...
class	Zivid::Settings::Processing::Filters::Smoothing
	Smoothing filters. More...
class	Zivid::Settings::Processing::Filters::Smoothing::Gaussian
	Gaussian smoothing of the point cloud. More...
class	Zivid::Settings::Processing::Filters::Smoothing::Gaussian::Enabled
	Enable or disable the smoothing filter. More...
class	Zivid::Settings::Processing::Filters::Smoothing::Gaussian::Sigma
	Higher values result in smoother point clouds (Standard deviation of the filter coefficients). More...
class	Zivid::Settings::Processing::Resampling
	Settings for changing the output resolution of the point cloud. More...
class	Zivid::Settings::Processing::Resampling::Mode
	Setting for upsampling or downsampling the point cloud data by some factor. This operation is performed after all other processing has been completed. More...
class	Zivid::Settings::RegionOfInterest
	Removes points outside the region of interest. More...
class	Zivid::Settings::RegionOfInterest::Box
	Removes points outside the given three-dimensional box. More...
class	Zivid::Settings::RegionOfInterest::Box::Enabled
	Enable or disable box filter. More...
class	Zivid::Settings::RegionOfInterest::Box::Extents
	Two points on the normal describing the direction and distance from the plane from which the normal is derived. More...
class	Zivid::Settings::RegionOfInterest::Box::PointA
	A point such that the vector from PointO to PointA describes the first edge of the parallelogram. More...
class	Zivid::Settings::RegionOfInterest::Box::PointB
	A point such that the vector from PointO to PointB describes the second edge of the parallelogram. More...
class	Zivid::Settings::RegionOfInterest::Box::PointO
	The point at the intersection of two adjacent edges defining a parallelogram. More...
class	Zivid::Settings::RegionOfInterest::Depth
	Removes points that reside outside of a depth range, meaning that their Z coordinate falls above a given maximum or below a given minimum. More...
class	Zivid::Settings::RegionOfInterest::Depth::Enabled
	Enable or disable depth filter. More...
class	Zivid::Settings::RegionOfInterest::Depth::Range
	Specify the minimum and maximum Z value that will be included. More...
class	Zivid::Settings::Sampling
	Sampling settings. More...
class	Zivid::Settings::Sampling::Color
	Choose how to sample colors for the point cloud. The rgb option gives a 2D image with full colors. The grayscale option gives a grayscale (r=g=b) 2D image, which can be acquired faster than full colors. The disabled option gives no colors and can allow for even faster captures. More...
class	Zivid::Settings::Sampling::Pixel
	Set whether the full image sensor should be used with white projector light or only specific color channels with corresponding projector light. Using only a specific color channel will subsample pixels and give a smaller resolution. More...

Namespaces
namespace	Zivid
	The main Zivid namespace. All Zivid code is found here.