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	Engine
	Set the Zivid Vision Engine to use. 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 settings. More...

Public Types
using	Descendants

Public Member Functions
	Settings ()
	Default constructor.

	Settings (const std::string &fileName)
	Construct Settings by loading from file.

std::string	serialize () const
	Serialize to a string.

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 Engine &	engine () const
	Get Engine.

Engine &	engine ()
	Get Engine.

Settings &	set (const Engine &value)
	Set 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::Hole &value)
	Set Processing::Filters::Hole.

Settings &	set (const Processing::Filters::Hole::Repair &value)
	Set Processing::Filters::Hole::Repair.

Settings &	set (const Processing::Filters::Hole::Repair::Enabled &value)
	Set Processing::Filters::Hole::Repair::Enabled.

Settings &	set (const Processing::Filters::Hole::Repair::HoleSize &value)
	Set Processing::Filters::Hole::Repair::HoleSize.

Settings &	set (const Processing::Filters::Hole::Repair::Strictness &value)
	Set Processing::Filters::Hole::Repair::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::Mode &value)
	Set Processing::Filters::Reflection::Removal::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.

Settings &	set (const Processing::Resampling &value)
	Set Processing::Resampling.

Settings &	set (const Processing::Resampling::Mode &value)
	Set Processing::Resampling::Mode.

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::Engine >::value, int >::type = 0>
const Settings::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::Hole >::value, int >::type = 0>
const Settings::Processing::Filters::Hole &	get () const

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

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

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

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Strictness >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::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::Mode >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::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::Processing::Resampling >::value, int >::type = 0>
const Settings::Processing::Resampling &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Resampling::Mode >::value, int >::type = 0>
const Settings::Processing::Resampling::Mode &	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::Engine &	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 Member Functions
static ZIVID_NODISCARD Settings	fromSerialized (const std::string &value)
	Construct a new Settings instance from a previously serialized string.

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 { 25 }

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

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.

◆ engine() [1/2]

Engine & Zivid::Settings::engine ( )

inline

Get Engine.

◆ engine() [2/2]

const Engine & Zivid::Settings::engine ( ) const

inline

Get Engine.

◆ 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.

◆ fromSerialized()

static ZIVID_NODISCARD Settings Zivid::Settings::fromSerialized ( const std::string & value )

static

Construct a new Settings instance from a previously serialized string.

◆ get() [1/73]

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/73]

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/73]

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/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Engine >::value, int >::type = 0>

const Settings::Engine & Zivid::Settings::get ( ) const

inline

◆ get() [5/73]

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() [6/73]

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() [7/73]

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() [8/73]

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() [9/73]

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() [10/73]

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() [11/73]

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() [12/73]

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() [13/73]

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() [14/73]

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() [15/73]

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() [16/73]

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() [17/73]

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() [18/73]

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() [19/73]

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() [20/73]

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() [21/73]

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() [22/73]

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() [23/73]

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() [24/73]

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() [25/73]

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() [26/73]

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() [27/73]

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() [28/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole >::value, int >::type = 0>

const Settings::Processing::Filters::Hole & Zivid::Settings::get ( ) const

inline

◆ get() [29/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair >::value, int >::type = 0>

const Settings::Processing::Filters::Hole::Repair & Zivid::Settings::get ( ) const

inline

◆ get() [30/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Hole::Repair::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [31/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::HoleSize >::value, int >::type = 0>

const Settings::Processing::Filters::Hole::Repair::HoleSize & Zivid::Settings::get ( ) const

inline

◆ get() [32/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Strictness >::value, int >::type = 0>

const Settings::Processing::Filters::Hole::Repair::Strictness & Zivid::Settings::get ( ) const

inline

◆ get() [33/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

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/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Mode >::value, int >::type = 0>

const Settings::Processing::Filters::Reflection::Removal::Mode & Zivid::Settings::get ( ) const

inline

◆ get() [49/73]

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() [50/73]

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() [51/73]

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() [52/73]

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() [53/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Resampling >::value, int >::type = 0>

const Settings::Processing::Resampling & Zivid::Settings::get ( ) const

inline

◆ get() [54/73]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Resampling::Mode >::value, int >::type = 0>

const Settings::Processing::Resampling::Mode & Zivid::Settings::get ( ) const

inline

◆ get() [55/73]

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() [56/73]

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() [57/73]

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() [58/73]

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() [59/73]

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() [60/73]

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() [61/73]

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() [62/73]

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() [63/73]

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() [64/73]

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() [65/73]

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() [66/73]

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() [67/73]

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() [68/73]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const Settings::Acquisitions & Zivid::Settings::get ( ) const

inline

◆ get() [69/73]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const Settings::Diagnostics & Zivid::Settings::get ( ) const

inline

◆ get() [70/73]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>

const Settings::Engine & Zivid::Settings::get ( ) const

inline

◆ get() [71/73]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>

const Settings::Processing & Zivid::Settings::get ( ) const

inline

◆ get() [72/73]

template<size_t i, typename std::enable_if< i==4, int >::type = 0>

const Settings::RegionOfInterest & Zivid::Settings::get ( ) const

inline

◆ get() [73/73]

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.

◆ serialize()

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

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

◆ set() [1/68]

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/68]

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

inline

Set Acquisitions.

◆ set() [3/68]

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

inline

Set Diagnostics.

◆ set() [4/68]

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

inline

Set Diagnostics::Enabled.

◆ set() [5/68]

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

inline

Set Engine.

◆ set() [6/68]

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

inline

Set Processing.

◆ set() [7/68]

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

inline

Set Processing::Color.

◆ set() [8/68]

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

inline

Set Processing::Color::Balance.

◆ set() [9/68]

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

inline

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

◆ set() [10/68]

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

inline

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

◆ set() [11/68]

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

inline

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

◆ set() [12/68]

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

inline

Set Processing::Color::Experimental.

◆ set() [13/68]

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

inline

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

◆ set() [14/68]

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

inline

Set Processing::Color::Gamma.

◆ set() [15/68]

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

inline

Set Processing::Filters.

◆ set() [16/68]

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

inline

Set Processing::Filters::Cluster.

◆ set() [17/68]

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

inline

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

◆ set() [18/68]

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

inline

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

◆ set() [19/68]

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

inline

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

◆ set() [20/68]

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

inline

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

◆ set() [21/68]

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

inline

Set Processing::Filters::Experimental.

◆ set() [22/68]

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

inline

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

◆ set() [23/68]

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

inline

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

◆ set() [24/68]

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

inline

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

◆ set() [25/68]

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

inline

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

◆ set() [26/68]

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

inline

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

◆ set() [27/68]

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

inline

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

◆ set() [28/68]

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

inline

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

◆ set() [29/68]

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

inline

Set Processing::Filters::Hole.

◆ set() [30/68]

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

inline

Set Processing::Filters::Hole::Repair.

◆ set() [31/68]

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

inline

Set Processing::Filters::Hole::Repair::Enabled.

◆ set() [32/68]

Settings & Zivid::Settings::set ( const Processing::Filters::Hole::Repair::HoleSize & value )

inline

Set Processing::Filters::Hole::Repair::HoleSize.

◆ set() [33/68]

Settings & Zivid::Settings::set ( const Processing::Filters::Hole::Repair::Strictness & value )

inline

Set Processing::Filters::Hole::Repair::Strictness.

◆ set() [34/68]

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

inline

Set Processing::Filters::Noise.

◆ set() [35/68]

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

inline

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

◆ set() [36/68]

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

inline

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

◆ set() [37/68]

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

inline

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

◆ set() [38/68]

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

inline

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

◆ set() [39/68]

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

inline

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

◆ set() [40/68]

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

inline

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

◆ set() [41/68]

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

inline

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

◆ set() [42/68]

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

inline

Set Processing::Filters::Outlier.

◆ set() [43/68]

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

inline

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

◆ set() [44/68]

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

inline

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

◆ set() [45/68]

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

inline

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

◆ set() [46/68]

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

inline

Set Processing::Filters::Reflection.

◆ set() [47/68]

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

inline

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

◆ set() [48/68]

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

inline

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

◆ set() [49/68]

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

inline

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

◆ set() [50/68]

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

inline

Set Processing::Filters::Smoothing.

◆ set() [51/68]

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

inline

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

◆ set() [52/68]

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

inline

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

◆ set() [53/68]

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

inline

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

◆ set() [54/68]

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

inline

Set Processing::Resampling.

◆ set() [55/68]

Settings & Zivid::Settings::set ( const Processing::Resampling::Mode & value )

inline

Set Processing::Resampling::Mode.

◆ set() [56/68]

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

inline

Set RegionOfInterest.

◆ set() [57/68]

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

inline

Set RegionOfInterest::Box.

◆ set() [58/68]

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

inline

Set RegionOfInterest::Box::Enabled.

◆ set() [59/68]

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

inline

Set RegionOfInterest::Box::Extents.

◆ set() [60/68]

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

inline

Set RegionOfInterest::Box::PointA.

◆ set() [61/68]

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

inline

Set RegionOfInterest::Box::PointB.

◆ set() [62/68]

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

inline

Set RegionOfInterest::Box::PointO.

◆ set() [63/68]

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

inline

Set RegionOfInterest::Depth.

◆ set() [64/68]

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

inline

Set RegionOfInterest::Depth::Enabled.

◆ set() [65/68]

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

inline

Set RegionOfInterest::Depth::Range.

◆ set() [66/68]

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

inline

Set Sampling.

◆ set() [67/68]

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

inline

Set Sampling::Color.

◆ set() [68/68]

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

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

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

staticconstexpr

The name of this value.

◆ nodeType

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

staticconstexpr

The type of this node.

◆ path

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

staticconstexpr

The full path for this value.

◆ version

size_t Zivid::Settings::version { 25 }

staticconstexpr

The documentation for this class was generated from the following file:

Zivid/Settings.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Settings() [1/3]

◆ Settings() [2/3]

◆ Settings() [3/3]

Member Function Documentation

◆ acquisitions() [1/2]

◆ acquisitions() [2/2]

◆ copyWith()

◆ diagnostics() [1/2]

◆ diagnostics() [2/2]

◆ engine() [1/2]

◆ engine() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ fromSerialized()

◆ get() [1/73]

◆ get() [2/73]

◆ get() [3/73]

◆ get() [4/73]

◆ get() [5/73]

◆ get() [6/73]

◆ get() [7/73]

◆ get() [8/73]

◆ get() [9/73]

◆ get() [10/73]

◆ get() [11/73]

◆ get() [12/73]

◆ get() [13/73]

◆ get() [14/73]

◆ get() [15/73]

◆ get() [16/73]

◆ get() [17/73]

◆ get() [18/73]

◆ get() [19/73]

◆ get() [20/73]

◆ get() [21/73]

◆ get() [22/73]

◆ get() [23/73]

◆ get() [24/73]

◆ get() [25/73]

◆ get() [26/73]

◆ get() [27/73]

◆ get() [28/73]

◆ get() [29/73]

◆ get() [30/73]

◆ get() [31/73]

◆ get() [32/73]

◆ get() [33/73]

◆ get() [34/73]

◆ get() [35/73]

◆ get() [36/73]

◆ get() [37/73]

◆ get() [38/73]

◆ get() [39/73]

◆ get() [40/73]

◆ get() [41/73]

◆ get() [42/73]

◆ get() [43/73]

◆ get() [44/73]

◆ get() [45/73]

◆ get() [46/73]

◆ get() [47/73]

◆ get() [48/73]

◆ get() [49/73]

◆ get() [50/73]

◆ get() [51/73]

◆ get() [52/73]

◆ get() [53/73]

◆ get() [54/73]

◆ get() [55/73]

◆ get() [56/73]