Zivid C++ API 2.11.1+de9b5dae-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings Class Reference

Settings used when capturing with a Zivid camera. More...

#include <Zivid/Settings.h>

Classes

class  Acquisition
 Settings for a single acquisition. More...
 
class  Acquisitions
 List of Acquisition objects. More...
 
class  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  Experimental
 Experimental features. These settings may be changed, renamed, moved or deleted in the future. More...
 
class  Processing
 Settings related to processing of a capture, including filters and color balance. More...
 
class  RegionOfInterest
 Removes points outside the region of interest. More...
 
class  Sampling
 Sampling group. More...
 

Public Types

using Descendants = std::tuple< Settings::Acquisitions, Settings::Diagnostics, Settings::Diagnostics::Enabled, Settings::Experimental, Settings::Experimental::Engine, Settings::Processing, Settings::Processing::Color, Settings::Processing::Color::Balance, Settings::Processing::Color::Balance::Blue, Settings::Processing::Color::Balance::Green, Settings::Processing::Color::Balance::Red, Settings::Processing::Color::Experimental, Settings::Processing::Color::Experimental::Mode, Settings::Processing::Color::Gamma, Settings::Processing::Filters, Settings::Processing::Filters::Cluster, Settings::Processing::Filters::Cluster::Removal, Settings::Processing::Filters::Cluster::Removal::Enabled, Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance, Settings::Processing::Filters::Cluster::Removal::MinArea, Settings::Processing::Filters::Experimental, Settings::Processing::Filters::Experimental::ContrastDistortion, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold, Settings::Processing::Filters::Experimental::HoleFilling, Settings::Processing::Filters::Experimental::HoleFilling::Enabled, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize, Settings::Processing::Filters::Experimental::HoleFilling::Strictness, Settings::Processing::Filters::Noise, Settings::Processing::Filters::Noise::Removal, Settings::Processing::Filters::Noise::Removal::Enabled, Settings::Processing::Filters::Noise::Removal::Threshold, Settings::Processing::Filters::Noise::Repair, Settings::Processing::Filters::Noise::Repair::Enabled, Settings::Processing::Filters::Noise::Suppression, Settings::Processing::Filters::Noise::Suppression::Enabled, Settings::Processing::Filters::Outlier, Settings::Processing::Filters::Outlier::Removal, Settings::Processing::Filters::Outlier::Removal::Enabled, Settings::Processing::Filters::Outlier::Removal::Threshold, Settings::Processing::Filters::Reflection, Settings::Processing::Filters::Reflection::Removal, Settings::Processing::Filters::Reflection::Removal::Enabled, Settings::Processing::Filters::Reflection::Removal::Experimental, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode, Settings::Processing::Filters::Smoothing, Settings::Processing::Filters::Smoothing::Gaussian, Settings::Processing::Filters::Smoothing::Gaussian::Enabled, Settings::Processing::Filters::Smoothing::Gaussian::Sigma, Settings::RegionOfInterest, Settings::RegionOfInterest::Box, Settings::RegionOfInterest::Box::Enabled, Settings::RegionOfInterest::Box::Extents, Settings::RegionOfInterest::Box::PointA, Settings::RegionOfInterest::Box::PointB, Settings::RegionOfInterest::Box::PointO, Settings::RegionOfInterest::Depth, Settings::RegionOfInterest::Depth::Enabled, Settings::RegionOfInterest::Depth::Range, Settings::Sampling, Settings::Sampling::Color, Settings::Sampling::Pixel >
 

Public Member Functions

 Settings ()
 Default constructor.
 
 Settings (const std::string &fileName)
 Construct Settings by loading from file.
 
template<typename... Args>
 Settings (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
Settings copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const Acquisitions & acquisitions () const
 Get Acquisitions.
 
Acquisitions & acquisitions ()
 Get Acquisitions.
 
Settings & set (const Acquisitions &value)
 Set Acquisitions.
 
const Diagnostics & diagnostics () const
 Get Diagnostics.
 
Diagnostics & diagnostics ()
 Get Diagnostics.
 
Settings & set (const Diagnostics &value)
 Set Diagnostics.
 
Settings & set (const Diagnostics::Enabled &value)
 Set Diagnostics::Enabled.
 
const Experimental & experimental () const
 Get Experimental.
 
Experimental & experimental ()
 Get Experimental.
 
Settings & set (const Experimental &value)
 Set Experimental.
 
Settings & set (const Experimental::Engine &value)
 Set Experimental::Engine.
 
const Processing & processing () const
 Get Processing.
 
Processing & processing ()
 Get Processing.
 
Settings & set (const Processing &value)
 Set Processing.
 
Settings & set (const Processing::Color &value)
 Set Processing::Color.
 
Settings & set (const Processing::Color::Balance &value)
 Set Processing::Color::Balance.
 
Settings & set (const Processing::Color::Balance::Blue &value)
 Set Processing::Color::Balance::Blue.
 
Settings & set (const Processing::Color::Balance::Green &value)
 Set Processing::Color::Balance::Green.
 
Settings & set (const Processing::Color::Balance::Red &value)
 Set Processing::Color::Balance::Red.
 
Settings & set (const Processing::Color::Experimental &value)
 Set Processing::Color::Experimental.
 
Settings & set (const Processing::Color::Experimental::Mode &value)
 Set Processing::Color::Experimental::Mode.
 
Settings & set (const Processing::Color::Gamma &value)
 Set Processing::Color::Gamma.
 
Settings & set (const Processing::Filters &value)
 Set Processing::Filters.
 
Settings & set (const Processing::Filters::Cluster &value)
 Set Processing::Filters::Cluster.
 
Settings & set (const Processing::Filters::Cluster::Removal &value)
 Set Processing::Filters::Cluster::Removal.
 
Settings & set (const Processing::Filters::Cluster::Removal::Enabled &value)
 Set Processing::Filters::Cluster::Removal::Enabled.
 
Settings & set (const Processing::Filters::Cluster::Removal::MaxNeighborDistance &value)
 Set Processing::Filters::Cluster::Removal::MaxNeighborDistance.
 
Settings & set (const Processing::Filters::Cluster::Removal::MinArea &value)
 Set Processing::Filters::Cluster::Removal::MinArea.
 
Settings & set (const Processing::Filters::Experimental &value)
 Set Processing::Filters::Experimental.
 
Settings & set (const Processing::Filters::Experimental::ContrastDistortion &value)
 Set Processing::Filters::Experimental::ContrastDistortion.
 
Settings & set (const Processing::Filters::Experimental::ContrastDistortion::Correction &value)
 Set Processing::Filters::Experimental::ContrastDistortion::Correction.
 
Settings & set (const Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled &value)
 Set Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled.
 
Settings & set (const Processing::Filters::Experimental::ContrastDistortion::Correction::Strength &value)
 Set Processing::Filters::Experimental::ContrastDistortion::Correction::Strength.
 
Settings & set (const Processing::Filters::Experimental::ContrastDistortion::Removal &value)
 Set Processing::Filters::Experimental::ContrastDistortion::Removal.
 
Settings & set (const Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled &value)
 Set Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled.
 
Settings & set (const Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold &value)
 Set Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold.
 
Settings & set (const Processing::Filters::Experimental::HoleFilling &value)
 Set Processing::Filters::Experimental::HoleFilling.
 
Settings & set (const Processing::Filters::Experimental::HoleFilling::Enabled &value)
 Set Processing::Filters::Experimental::HoleFilling::Enabled.
 
Settings & set (const Processing::Filters::Experimental::HoleFilling::HoleSize &value)
 Set Processing::Filters::Experimental::HoleFilling::HoleSize.
 
Settings & set (const Processing::Filters::Experimental::HoleFilling::Strictness &value)
 Set Processing::Filters::Experimental::HoleFilling::Strictness.
 
Settings & set (const Processing::Filters::Noise &value)
 Set Processing::Filters::Noise.
 
Settings & set (const Processing::Filters::Noise::Removal &value)
 Set Processing::Filters::Noise::Removal.
 
Settings & set (const Processing::Filters::Noise::Removal::Enabled &value)
 Set Processing::Filters::Noise::Removal::Enabled.
 
Settings & set (const Processing::Filters::Noise::Removal::Threshold &value)
 Set Processing::Filters::Noise::Removal::Threshold.
 
Settings & set (const Processing::Filters::Noise::Repair &value)
 Set Processing::Filters::Noise::Repair.
 
Settings & set (const Processing::Filters::Noise::Repair::Enabled &value)
 Set Processing::Filters::Noise::Repair::Enabled.
 
Settings & set (const Processing::Filters::Noise::Suppression &value)
 Set Processing::Filters::Noise::Suppression.
 
Settings & set (const Processing::Filters::Noise::Suppression::Enabled &value)
 Set Processing::Filters::Noise::Suppression::Enabled.
 
Settings & set (const Processing::Filters::Outlier &value)
 Set Processing::Filters::Outlier.
 
Settings & set (const Processing::Filters::Outlier::Removal &value)
 Set Processing::Filters::Outlier::Removal.
 
Settings & set (const Processing::Filters::Outlier::Removal::Enabled &value)
 Set Processing::Filters::Outlier::Removal::Enabled.
 
Settings & set (const Processing::Filters::Outlier::Removal::Threshold &value)
 Set Processing::Filters::Outlier::Removal::Threshold.
 
Settings & set (const Processing::Filters::Reflection &value)
 Set Processing::Filters::Reflection.
 
Settings & set (const Processing::Filters::Reflection::Removal &value)
 Set Processing::Filters::Reflection::Removal.
 
Settings & set (const Processing::Filters::Reflection::Removal::Enabled &value)
 Set Processing::Filters::Reflection::Removal::Enabled.
 
Settings & set (const Processing::Filters::Reflection::Removal::Experimental &value)
 Set Processing::Filters::Reflection::Removal::Experimental.
 
Settings & set (const Processing::Filters::Reflection::Removal::Experimental::Mode &value)
 Set Processing::Filters::Reflection::Removal::Experimental::Mode.
 
Settings & set (const Processing::Filters::Smoothing &value)
 Set Processing::Filters::Smoothing.
 
Settings & set (const Processing::Filters::Smoothing::Gaussian &value)
 Set Processing::Filters::Smoothing::Gaussian.
 
Settings & set (const Processing::Filters::Smoothing::Gaussian::Enabled &value)
 Set Processing::Filters::Smoothing::Gaussian::Enabled.
 
Settings & set (const Processing::Filters::Smoothing::Gaussian::Sigma &value)
 Set Processing::Filters::Smoothing::Gaussian::Sigma.
 
const RegionOfInterest & regionOfInterest () const
 Get RegionOfInterest.
 
RegionOfInterest & regionOfInterest ()
 Get RegionOfInterest.
 
Settings & set (const RegionOfInterest &value)
 Set RegionOfInterest.
 
Settings & set (const RegionOfInterest::Box &value)
 Set RegionOfInterest::Box.
 
Settings & set (const RegionOfInterest::Box::Enabled &value)
 Set RegionOfInterest::Box::Enabled.
 
Settings & set (const RegionOfInterest::Box::Extents &value)
 Set RegionOfInterest::Box::Extents.
 
Settings & set (const RegionOfInterest::Box::PointA &value)
 Set RegionOfInterest::Box::PointA.
 
Settings & set (const RegionOfInterest::Box::PointB &value)
 Set RegionOfInterest::Box::PointB.
 
Settings & set (const RegionOfInterest::Box::PointO &value)
 Set RegionOfInterest::Box::PointO.
 
Settings & set (const RegionOfInterest::Depth &value)
 Set RegionOfInterest::Depth.
 
Settings & set (const RegionOfInterest::Depth::Enabled &value)
 Set RegionOfInterest::Depth::Enabled.
 
Settings & set (const RegionOfInterest::Depth::Range &value)
 Set RegionOfInterest::Depth::Range.
 
const Sampling & sampling () const
 Get Sampling.
 
Sampling & sampling ()
 Get Sampling.
 
Settings & set (const Sampling &value)
 Set Sampling.
 
Settings & set (const Sampling::Color &value)
 Set Sampling::Color.
 
Settings & set (const Sampling::Pixel &value)
 Set Sampling::Pixel.
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisitions >::value, int >::type = 0>
const Settings::Acquisitions & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics >::value, int >::type = 0>
const Settings::Diagnostics & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics::Enabled >::value, int >::type = 0>
const Settings::Diagnostics::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental >::value, int >::type = 0>
const Settings::Experimental & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental::Engine >::value, int >::type = 0>
const Settings::Experimental::Engine & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing >::value, int >::type = 0>
const Settings::Processing & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color >::value, int >::type = 0>
const Settings::Processing::Color & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance >::value, int >::type = 0>
const Settings::Processing::Color::Balance & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Blue & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Green & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Red & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental >::value, int >::type = 0>
const Settings::Processing::Color::Experimental & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental::Mode >::value, int >::type = 0>
const Settings::Processing::Color::Experimental::Mode & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Gamma >::value, int >::type = 0>
const Settings::Processing::Color::Gamma & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters >::value, int >::type = 0>
const Settings::Processing::Filters & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::MinArea >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::MinArea & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::HoleSize & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::Strictness >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Strictness & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise >::value, int >::type = 0>
const Settings::Processing::Filters::Noise & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal::Threshold & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Repair >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Repair & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Repair::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Repair::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Suppression >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Suppression & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Suppression::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Suppression::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Threshold & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimental & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimental::Mode & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Sigma & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest >::value, int >::type = 0>
const Settings::RegionOfInterest & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box >::value, int >::type = 0>
const Settings::RegionOfInterest::Box & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::Enabled >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::Extents >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::Extents & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::PointA >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::PointA & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::PointB >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::PointB & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::PointO >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::PointO & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Enabled >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth::Enabled & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Range >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth::Range & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling >::value, int >::type = 0>
const Settings::Sampling & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling::Color >::value, int >::type = 0>
const Settings::Sampling::Color & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling::Pixel >::value, int >::type = 0>
const Settings::Sampling::Pixel & get () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Acquisitions & get () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Diagnostics & get () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Experimental & get () const
 
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::Processing & get () const
 
template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const Settings::RegionOfInterest & get () const
 
template<size_t i, typename std::enable_if< i==5, int >::type = 0>
const Settings::Sampling & get () const
 
template<typename F >
void forEach (const F &f) const
 Run the given function on each direct member with the value of the member as parameter.
 
template<typename F >
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter.
 
bool operator== (const Settings &other) const
 Equality operator.
 
bool operator!= (const Settings &other) const
 Inequality operator.
 
std::string toString () const
 Get the value as string.
 
void save (const std::string &fileName) const
 Save to the given file.
 
void load (const std::string &fileName)
 Load from the given file.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node.
 
static constexpr const char * path { "" }
 The full path for this value.
 
static constexpr const char * name { "Settings" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 
static constexpr size_t version { 22 }
 

Friends

struct DataModel::Detail::Befriend< Settings >
 
std::ostream & operator<< (std::ostream &stream, const Settings &value)
 Operator to send the value as string to a stream.
 

Detailed Description

Settings used when capturing with a Zivid camera.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings::Descendants = std::tuple< Settings::Acquisitions, Settings::Diagnostics, Settings::Diagnostics::Enabled, Settings::Experimental, Settings::Experimental::Engine, Settings::Processing, Settings::Processing::Color, Settings::Processing::Color::Balance, Settings::Processing::Color::Balance::Blue, Settings::Processing::Color::Balance::Green, Settings::Processing::Color::Balance::Red, Settings::Processing::Color::Experimental, Settings::Processing::Color::Experimental::Mode, Settings::Processing::Color::Gamma, Settings::Processing::Filters, Settings::Processing::Filters::Cluster, Settings::Processing::Filters::Cluster::Removal, Settings::Processing::Filters::Cluster::Removal::Enabled, Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance, Settings::Processing::Filters::Cluster::Removal::MinArea, Settings::Processing::Filters::Experimental, Settings::Processing::Filters::Experimental::ContrastDistortion, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold, Settings::Processing::Filters::Experimental::HoleFilling, Settings::Processing::Filters::Experimental::HoleFilling::Enabled, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize, Settings::Processing::Filters::Experimental::HoleFilling::Strictness, Settings::Processing::Filters::Noise, Settings::Processing::Filters::Noise::Removal, Settings::Processing::Filters::Noise::Removal::Enabled, Settings::Processing::Filters::Noise::Removal::Threshold, Settings::Processing::Filters::Noise::Repair, Settings::Processing::Filters::Noise::Repair::Enabled, Settings::Processing::Filters::Noise::Suppression, Settings::Processing::Filters::Noise::Suppression::Enabled, Settings::Processing::Filters::Outlier, Settings::Processing::Filters::Outlier::Removal, Settings::Processing::Filters::Outlier::Removal::Enabled, Settings::Processing::Filters::Outlier::Removal::Threshold, Settings::Processing::Filters::Reflection, Settings::Processing::Filters::Reflection::Removal, Settings::Processing::Filters::Reflection::Removal::Enabled, Settings::Processing::Filters::Reflection::Removal::Experimental, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode, Settings::Processing::Filters::Smoothing, Settings::Processing::Filters::Smoothing::Gaussian, Settings::Processing::Filters::Smoothing::Gaussian::Enabled, Settings::Processing::Filters::Smoothing::Gaussian::Sigma, Settings::RegionOfInterest, Settings::RegionOfInterest::Box, Settings::RegionOfInterest::Box::Enabled, Settings::RegionOfInterest::Box::Extents, Settings::RegionOfInterest::Box::PointA, Settings::RegionOfInterest::Box::PointB, Settings::RegionOfInterest::Box::PointO, Settings::RegionOfInterest::Depth, Settings::RegionOfInterest::Depth::Enabled, Settings::RegionOfInterest::Depth::Range, Settings::Sampling, Settings::Sampling::Color, Settings::Sampling::Pixel>

Constructor & Destructor Documentation

◆ Settings() [1/3]

Zivid::Settings::Settings ( )

Default constructor.

◆ Settings() [2/3]

Zivid::Settings::Settings ( const std::string &  fileName)
explicit

Construct Settings by loading from file.

◆ Settings() [3/3]

template<typename... Args>
Zivid::Settings::Settings ( Args &&...  args)
inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Settings then invoking set(args).

The provided arguments must be descendants of Settings. These types can be provided:

Member Function Documentation

◆ acquisitions() [1/2]

Acquisitions & Zivid::Settings::acquisitions ( )
inline

Get Acquisitions.

◆ acquisitions() [2/2]

const Acquisitions & Zivid::Settings::acquisitions ( ) const
inline

Get Acquisitions.

◆ copyWith()

template<typename... Args>
Settings Zivid::Settings::copyWith ( Args &&...  args) const
inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Settings object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Settings. These types can be provided:

◆ diagnostics() [1/2]

Diagnostics & Zivid::Settings::diagnostics ( )
inline

Get Diagnostics.

◆ diagnostics() [2/2]

const Diagnostics & Zivid::Settings::diagnostics ( ) const
inline

Get Diagnostics.

◆ experimental() [1/2]

Experimental & Zivid::Settings::experimental ( )
inline

Get Experimental.

◆ experimental() [2/2]

const Experimental & Zivid::Settings::experimental ( ) const
inline

Get Experimental.

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings::forEach ( const F &  f)
inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F >
void Zivid::Settings::forEach ( const F &  f) const
inline

Run the given function on each direct member with the value of the member as parameter.

◆ get() [1/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisitions >::value, int >::type = 0>
const Settings::Acquisitions & Zivid::Settings::get ( ) const
inline

◆ get() [2/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics >::value, int >::type = 0>
const Settings::Diagnostics & Zivid::Settings::get ( ) const
inline

◆ get() [3/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics::Enabled >::value, int >::type = 0>
const Settings::Diagnostics::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [4/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental >::value, int >::type = 0>
const Settings::Experimental & Zivid::Settings::get ( ) const
inline

◆ get() [5/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental::Engine >::value, int >::type = 0>
const Settings::Experimental::Engine & Zivid::Settings::get ( ) const
inline

◆ get() [6/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing >::value, int >::type = 0>
const Settings::Processing & Zivid::Settings::get ( ) const
inline

◆ get() [7/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color >::value, int >::type = 0>
const Settings::Processing::Color & Zivid::Settings::get ( ) const
inline

◆ get() [8/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance >::value, int >::type = 0>
const Settings::Processing::Color::Balance & Zivid::Settings::get ( ) const
inline

◆ get() [9/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Blue & Zivid::Settings::get ( ) const
inline

◆ get() [10/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Green & Zivid::Settings::get ( ) const
inline

◆ get() [11/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Red & Zivid::Settings::get ( ) const
inline

◆ get() [12/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental >::value, int >::type = 0>
const Settings::Processing::Color::Experimental & Zivid::Settings::get ( ) const
inline

◆ get() [13/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental::Mode >::value, int >::type = 0>
const Settings::Processing::Color::Experimental::Mode & Zivid::Settings::get ( ) const
inline

◆ get() [14/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Gamma >::value, int >::type = 0>
const Settings::Processing::Color::Gamma & Zivid::Settings::get ( ) const
inline

◆ get() [15/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters >::value, int >::type = 0>
const Settings::Processing::Filters & Zivid::Settings::get ( ) const
inline

◆ get() [16/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster & Zivid::Settings::get ( ) const
inline

◆ get() [17/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal & Zivid::Settings::get ( ) const
inline

◆ get() [18/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [19/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance & Zivid::Settings::get ( ) const
inline

◆ get() [20/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::MinArea >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::MinArea & Zivid::Settings::get ( ) const
inline

◆ get() [21/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental & Zivid::Settings::get ( ) const
inline

◆ get() [22/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion & Zivid::Settings::get ( ) const
inline

◆ get() [23/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction & Zivid::Settings::get ( ) const
inline

◆ get() [24/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [25/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & Zivid::Settings::get ( ) const
inline

◆ get() [26/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal & Zivid::Settings::get ( ) const
inline

◆ get() [27/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [28/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold & Zivid::Settings::get ( ) const
inline

◆ get() [29/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling & Zivid::Settings::get ( ) const
inline

◆ get() [30/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [31/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::HoleSize & Zivid::Settings::get ( ) const
inline

◆ get() [32/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::Strictness >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Strictness & Zivid::Settings::get ( ) const
inline

◆ get() [33/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise >::value, int >::type = 0>
const Settings::Processing::Filters::Noise & Zivid::Settings::get ( ) const
inline

◆ get() [34/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal & Zivid::Settings::get ( ) const
inline

◆ get() [35/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [36/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal::Threshold & Zivid::Settings::get ( ) const
inline

◆ get() [37/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Repair >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Repair & Zivid::Settings::get ( ) const
inline

◆ get() [38/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Repair::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Repair::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [39/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Suppression >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Suppression & Zivid::Settings::get ( ) const
inline

◆ get() [40/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Suppression::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Suppression::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [41/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier & Zivid::Settings::get ( ) const
inline

◆ get() [42/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal & Zivid::Settings::get ( ) const
inline

◆ get() [43/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [44/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Threshold & Zivid::Settings::get ( ) const
inline

◆ get() [45/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection & Zivid::Settings::get ( ) const
inline

◆ get() [46/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal & Zivid::Settings::get ( ) const
inline

◆ get() [47/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [48/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimental & Zivid::Settings::get ( ) const
inline

◆ get() [49/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimental::Mode & Zivid::Settings::get ( ) const
inline

◆ get() [50/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing & Zivid::Settings::get ( ) const
inline

◆ get() [51/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian & Zivid::Settings::get ( ) const
inline

◆ get() [52/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [53/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Sigma & Zivid::Settings::get ( ) const
inline

◆ get() [54/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest >::value, int >::type = 0>
const Settings::RegionOfInterest & Zivid::Settings::get ( ) const
inline

◆ get() [55/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box >::value, int >::type = 0>
const Settings::RegionOfInterest::Box & Zivid::Settings::get ( ) const
inline

◆ get() [56/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::Enabled >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [57/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::Extents >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::Extents & Zivid::Settings::get ( ) const
inline

◆ get() [58/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::PointA >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::PointA & Zivid::Settings::get ( ) const
inline

◆ get() [59/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::PointB >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::PointB & Zivid::Settings::get ( ) const
inline

◆ get() [60/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Box::PointO >::value, int >::type = 0>
const Settings::RegionOfInterest::Box::PointO & Zivid::Settings::get ( ) const
inline

◆ get() [61/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth & Zivid::Settings::get ( ) const
inline

◆ get() [62/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Enabled >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth::Enabled & Zivid::Settings::get ( ) const
inline

◆ get() [63/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Range >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth::Range & Zivid::Settings::get ( ) const
inline

◆ get() [64/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling >::value, int >::type = 0>
const Settings::Sampling & Zivid::Settings::get ( ) const
inline

◆ get() [65/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling::Color >::value, int >::type = 0>
const Settings::Sampling::Color & Zivid::Settings::get ( ) const
inline

◆ get() [66/72]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling::Pixel >::value, int >::type = 0>
const Settings::Sampling::Pixel & Zivid::Settings::get ( ) const
inline

◆ get() [67/72]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Acquisitions & Zivid::Settings::get ( ) const
inline

◆ get() [68/72]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Diagnostics & Zivid::Settings::get ( ) const
inline

◆ get() [69/72]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Experimental & Zivid::Settings::get ( ) const
inline

◆ get() [70/72]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::Processing & Zivid::Settings::get ( ) const
inline

◆ get() [71/72]

template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const Settings::RegionOfInterest & Zivid::Settings::get ( ) const
inline

◆ get() [72/72]

template<size_t i, typename std::enable_if< i==5, int >::type = 0>
const Settings::Sampling & Zivid::Settings::get ( ) const
inline

◆ load()

void Zivid::Settings::load ( const std::string &  fileName)

Load from the given file.

◆ operator!=()

bool Zivid::Settings::operator!= ( const Settings &  other) const

Inequality operator.

◆ operator==()

bool Zivid::Settings::operator== ( const Settings &  other) const

Equality operator.

◆ processing() [1/2]

Processing & Zivid::Settings::processing ( )
inline

Get Processing.

◆ processing() [2/2]

const Processing & Zivid::Settings::processing ( ) const
inline

Get Processing.

◆ regionOfInterest() [1/2]

RegionOfInterest & Zivid::Settings::regionOfInterest ( )
inline

Get RegionOfInterest.

◆ regionOfInterest() [2/2]

const RegionOfInterest & Zivid::Settings::regionOfInterest ( ) const
inline

Get RegionOfInterest.

◆ sampling() [1/2]

Sampling & Zivid::Settings::sampling ( )
inline

Get Sampling.

◆ sampling() [2/2]

const Sampling & Zivid::Settings::sampling ( ) const
inline

Get Sampling.

◆ save()

void Zivid::Settings::save ( const std::string &  fileName) const

Save to the given file.

◆ set() [1/67]

template<typename... Args>
void Zivid::Settings::set ( Args &&...  args)
inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Settings. These types can be provided:

◆ set() [2/67]

Settings & Zivid::Settings::set ( const Acquisitions &  value)
inline

Set Acquisitions.

◆ set() [3/67]

Settings & Zivid::Settings::set ( const Diagnostics &  value)
inline

Set Diagnostics.

◆ set() [4/67]

Settings & Zivid::Settings::set ( const Diagnostics::Enabled &  value)
inline

Set Diagnostics::Enabled.

◆ set() [5/67]

Settings & Zivid::Settings::set ( const Experimental &  value)
inline

Set Experimental.

◆ set() [6/67]

Settings & Zivid::Settings::set ( const Experimental::Engine &  value)
inline

Set Experimental::Engine.

◆ set() [7/67]

Settings & Zivid::Settings::set ( const Processing &  value)
inline

Set Processing.

◆ set() [8/67]

Settings & Zivid::Settings::set ( const Processing::Color &  value)
inline

Set Processing::Color.

◆ set() [9/67]

Settings & Zivid::Settings::set ( const Processing::Color::Balance &  value)
inline

Set Processing::Color::Balance.

◆ set() [10/67]

Settings & Zivid::Settings::set ( const Processing::Color::Balance::Blue &  value)
inline

Set Processing::Color::Balance::Blue.

◆ set() [11/67]

Settings & Zivid::Settings::set ( const Processing::Color::Balance::Green &  value)
inline

Set Processing::Color::Balance::Green.

◆ set() [12/67]

Settings & Zivid::Settings::set ( const Processing::Color::Balance::Red &  value)
inline

Set Processing::Color::Balance::Red.

◆ set() [13/67]

Settings & Zivid::Settings::set ( const Processing::Color::Experimental &  value)
inline

Set Processing::Color::Experimental.

◆ set() [14/67]

Settings & Zivid::Settings::set ( const Processing::Color::Experimental::Mode &  value)
inline

Set Processing::Color::Experimental::Mode.

◆ set() [15/67]

Settings & Zivid::Settings::set ( const Processing::Color::Gamma &  value)
inline

Set Processing::Color::Gamma.

◆ set() [16/67]

Settings & Zivid::Settings::set ( const Processing::Filters &  value)
inline

Set Processing::Filters.

◆ set() [17/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Cluster &  value)
inline

Set Processing::Filters::Cluster.

◆ set() [18/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Cluster::Removal &  value)
inline

Set Processing::Filters::Cluster::Removal.

◆ set() [19/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Cluster::Removal::Enabled &  value)
inline

Set Processing::Filters::Cluster::Removal::Enabled.

◆ set() [20/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Cluster::Removal::MaxNeighborDistance &  value)
inline

Set Processing::Filters::Cluster::Removal::MaxNeighborDistance.

◆ set() [21/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Cluster::Removal::MinArea &  value)
inline

Set Processing::Filters::Cluster::Removal::MinArea.

◆ set() [22/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental &  value)
inline

Set Processing::Filters::Experimental.

◆ set() [23/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion &  value)
inline

Set Processing::Filters::Experimental::ContrastDistortion.

◆ set() [24/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Correction &  value)
inline

Set Processing::Filters::Experimental::ContrastDistortion::Correction.

◆ set() [25/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled &  value)
inline

Set Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled.

◆ set() [26/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Correction::Strength &  value)
inline

Set Processing::Filters::Experimental::ContrastDistortion::Correction::Strength.

◆ set() [27/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Removal &  value)
inline

Set Processing::Filters::Experimental::ContrastDistortion::Removal.

◆ set() [28/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled &  value)
inline

Set Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled.

◆ set() [29/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold &  value)
inline

Set Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold.

◆ set() [30/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::HoleFilling &  value)
inline

Set Processing::Filters::Experimental::HoleFilling.

◆ set() [31/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::HoleFilling::Enabled &  value)
inline

Set Processing::Filters::Experimental::HoleFilling::Enabled.

◆ set() [32/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::HoleFilling::HoleSize &  value)
inline

Set Processing::Filters::Experimental::HoleFilling::HoleSize.

◆ set() [33/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::HoleFilling::Strictness &  value)
inline

Set Processing::Filters::Experimental::HoleFilling::Strictness.

◆ set() [34/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise &  value)
inline

Set Processing::Filters::Noise.

◆ set() [35/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Removal &  value)
inline

Set Processing::Filters::Noise::Removal.

◆ set() [36/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Removal::Enabled &  value)
inline

Set Processing::Filters::Noise::Removal::Enabled.

◆ set() [37/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Removal::Threshold &  value)
inline

Set Processing::Filters::Noise::Removal::Threshold.

◆ set() [38/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Repair &  value)
inline

Set Processing::Filters::Noise::Repair.

◆ set() [39/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Repair::Enabled &  value)
inline

Set Processing::Filters::Noise::Repair::Enabled.

◆ set() [40/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Suppression &  value)
inline

Set Processing::Filters::Noise::Suppression.

◆ set() [41/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Suppression::Enabled &  value)
inline

Set Processing::Filters::Noise::Suppression::Enabled.

◆ set() [42/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier &  value)
inline

Set Processing::Filters::Outlier.

◆ set() [43/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier::Removal &  value)
inline

Set Processing::Filters::Outlier::Removal.

◆ set() [44/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier::Removal::Enabled &  value)
inline

Set Processing::Filters::Outlier::Removal::Enabled.

◆ set() [45/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier::Removal::Threshold &  value)
inline

Set Processing::Filters::Outlier::Removal::Threshold.

◆ set() [46/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection &  value)
inline

Set Processing::Filters::Reflection.

◆ set() [47/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal &  value)
inline

Set Processing::Filters::Reflection::Removal.

◆ set() [48/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal::Enabled &  value)
inline

Set Processing::Filters::Reflection::Removal::Enabled.

◆ set() [49/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal::Experimental &  value)
inline

Set Processing::Filters::Reflection::Removal::Experimental.

◆ set() [50/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal::Experimental::Mode &  value)
inline

Set Processing::Filters::Reflection::Removal::Experimental::Mode.

◆ set() [51/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing &  value)
inline

Set Processing::Filters::Smoothing.

◆ set() [52/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing::Gaussian &  value)
inline

Set Processing::Filters::Smoothing::Gaussian.

◆ set() [53/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing::Gaussian::Enabled &  value)
inline

Set Processing::Filters::Smoothing::Gaussian::Enabled.

◆ set() [54/67]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing::Gaussian::Sigma &  value)
inline

Set Processing::Filters::Smoothing::Gaussian::Sigma.

◆ set() [55/67]

Settings & Zivid::Settings::set ( const RegionOfInterest &  value)
inline

Set RegionOfInterest.

◆ set() [56/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Box &  value)
inline

Set RegionOfInterest::Box.

◆ set() [57/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Box::Enabled &  value)
inline

Set RegionOfInterest::Box::Enabled.

◆ set() [58/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Box::Extents &  value)
inline

Set RegionOfInterest::Box::Extents.

◆ set() [59/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Box::PointA &  value)
inline

Set RegionOfInterest::Box::PointA.

◆ set() [60/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Box::PointB &  value)
inline

Set RegionOfInterest::Box::PointB.

◆ set() [61/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Box::PointO &  value)
inline

Set RegionOfInterest::Box::PointO.

◆ set() [62/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Depth &  value)
inline

Set RegionOfInterest::Depth.

◆ set() [63/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Depth::Enabled &  value)
inline

Set RegionOfInterest::Depth::Enabled.

◆ set() [64/67]

Settings & Zivid::Settings::set ( const RegionOfInterest::Depth::Range &  value)
inline

Set RegionOfInterest::Depth::Range.

◆ set() [65/67]

Settings & Zivid::Settings::set ( const Sampling &  value)
inline

Set Sampling.

◆ set() [66/67]

Settings & Zivid::Settings::set ( const Sampling::Color &  value)
inline

Set Sampling::Color.

◆ set() [67/67]

Settings & Zivid::Settings::set ( const Sampling::Pixel &  value)
inline

Set Sampling::Pixel.

◆ toString()

std::string Zivid::Settings::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Settings >

friend struct DataModel::Detail::Befriend< Settings >
friend

◆ operator<<

std::ostream & operator<< ( std::ostream &  stream,
const Settings &  value 
)
friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::description
staticconstexpr
Initial value:
{
R"description(Settings used when capturing with a Zivid camera)description"
}

The description for this value.

◆ name

constexpr const char* Zivid::Settings::name { "Settings" }
staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::Settings::path { "" }
staticconstexpr

The full path for this value.

◆ version

constexpr size_t Zivid::Settings::version { 22 }
staticconstexpr
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8