Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Classes | Namespaces
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/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, extra diagnostic information is recorded during capture. This extra information is included when saving the frame to a .zdf file, and will help Zivid's support team to provide better assistance. More...
 
class  Zivid::Settings::Diagnostics::Enabled
 Enable diagnostics More...
 
class  Zivid::Settings::Experimental
 Experimental features. These settings may be changed, renamed, moved or deleted in the future. More...
 
class  Zivid::Settings::Experimental::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
 Filters More...
 
class  Zivid::Settings::Processing::Filters::Cluster
 Removes floating points and small isolated clusters from the point cloud. More...
 
class  Zivid::Settings::Processing::Filters::Cluster::Removal
 Removal More...
 
class  Zivid::Settings::Processing::Filters::Cluster::Removal::Enabled
 Enabled 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 (10.0) 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
 Correction More...
 
class  Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled
 Enabled More...
 
class  Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength
 Higher values gives more correction. More...
 
class  Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal
 Removal More...
 
class  Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled
 Enabled More...
 
class  Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold
 Higher values remove more points. More...
 
class  Zivid::Settings::Processing::Filters::Experimental::HoleFilling
 Fills missing points considering a circular neighborhood. More...
 
class  Zivid::Settings::Processing::Filters::Experimental::HoleFilling::Enabled
 Enabled More...
 
class  Zivid::Settings::Processing::Filters::Experimental::HoleFilling::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::Experimental::HoleFilling::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 a filter that removes points with low signal-to-noise ratio (SNR) 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::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::Experimental
 Experimental reflection filter related settings More...
 
class  Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::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 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::RegionOfInterest
 Removes points outside the region of interest. More...
 
class  Zivid::Settings::RegionOfInterest::Box
 Removes the points outside the box. More...
 
class  Zivid::Settings::RegionOfInterest::Box::Enabled
 Enabled 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
 Enabled More...
 
class  Zivid::Settings::RegionOfInterest::Depth::Range
 Specify the minimum and maximum Z value that will be included. More...
 

Namespaces

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